Add Stellar Data API remote spec and navigation #1396
+32
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Stellar Data API Overview | ||
| description: Learn about Alchemy's Stellar Data API. | ||
| subtitle: Query indexed Stellar data including transfer history, account balances, and NFT holdings. | ||
| slug: reference/stellar-data-api-overview | ||
| --- | ||
|
|
||
| # Intro | ||
|
|
||
| With the Stellar Data API, you can query indexed Stellar data across **native**, **classic**, and **Soroban** assets — including transfer history, account balances, and NFT holdings — without running your own indexer. | ||
|
|
||
| Alchemy currently supports the following Stellar Data API endpoints: | ||
|
|
||
| * [`getStellarTransfers`](/docs/data/stellar-data-api/stellar-data-api-endpoints/transfers/get-stellar-transfers): Returns transfers (native, classic, and/or Soroban) matching the given filters, ordered by ledger. | ||
| * [`getStellarBalances`](/docs/data/stellar-data-api/stellar-data-api-endpoints/balances/get-stellar-balances): Returns the unified balance set for an account — native XLM, classic trustline assets, and Soroban contract tokens. | ||
| * [`getStellarNfts`](/docs/data/stellar-data-api/stellar-data-api-endpoints/nfts/get-stellar-nfts): Returns NFTs held by an account, with filtering by contract or classic asset. | ||
|
|
||
| Looking for Stellar JSON-RPC methods instead? Check out the [Stellar API Overview](/docs/stellar/stellar-api-overview). | ||
|
|
||
| <Info> | ||
| All endpoints accept JSON request bodies, return results under a `data` envelope, and support pagination via opaque `pageKey` cursors. | ||
| </Info> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -844,6 +844,13 @@ navigation: | |
| - api: Transactions Receipts Endpoints | ||
| api-name: transactions-receipt | ||
| slug: utility-apis | ||
| - section: Stellar Data API | ||
| contents: | ||
| - page: Stellar Data API Overview | ||
| path: api-reference/data/stellar-data-api/stellar-data-api-overview.mdx | ||
| - api: Stellar Data API Endpoints | ||
| api-name: stellar-data-api | ||
| slug: stellar-data-api | ||
| - section: Subgraphs | ||
| contents: | ||
| - page: Alchemy Subgraphs Deprecation Notice | ||
|
|
@@ -2109,6 +2116,8 @@ navigation: | |
| path: api-reference/stellar/stellar-api-overview.mdx | ||
| - api: Stellar API Endpoints | ||
| api-name: stellar | ||
| - link: Stellar Data API | ||
| href: /docs/data/stellar-data-api | ||
|
Collaborator
There was a problem hiding this comment. Not a real link: goes to 404. I recommend generating an overview page and linking to that. Example here
Collaborator
There was a problem hiding this comment. Should be |
||
| slug: stellar | ||
|
|
||
| - section: Story | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would avoid explicitly listing methods here, since then you'd need to manually update this when methods list changes.