You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 30, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: apps/nextra/pages/en/build/cli/running-a-local-network.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,7 @@ To debug this, try the below fixes:
117
117
As you can see from the example output in step 4, once the local network is running, you have access to the following services:
118
118
119
119
- [Node API](../../network/nodes/aptos-api-spec.mdx): This is a REST API that runs directly on the node. It enables core write functionality such as transaction submission and a limited set of read functionality, such as reading account resources or Move module information.
120
-
- [Indexer API](../indexer/aptos-hosted.mdx): This is a [GraphQL](https://graphql.org/) API that provides rich read access to indexed blockchain data. If you click on the URL for the Indexer API above, by default [http://127.0.0.1:8090](http://127.0.0.1:8090/), it will open the Hasura Console, a web UI that will help you query the Indexer GraphQL API.
120
+
- [Indexer API](../indexer/indexer-api.mdx): This is a [GraphQL](https://graphql.org/) API that provides rich read access to indexed blockchain data. If you click on the URL for the Indexer API above, by default [http://127.0.0.1:8090](http://127.0.0.1:8090/), it will open the Hasura Console, a web UI that will help you query the Indexer GraphQL API.
121
121
- [Transaction Stream Service](../indexer/txn-stream.mdx): This is a gRPC stream of transactions used by the Indexer API and SDK. This is only relevant to you if you are developing a [Indexer SDK](../indexer/indexer-sdk.mdx) custom processor.
122
122
- [Postgres](https://www.postgresql.org/): This is the database that the Indexer processors write to. The Indexer API reads from this database.
123
123
- [Faucet](../apis/faucet-api.mdx): You can use this to fund accounts on your local network.
Here's an interactive example of our [Indexer](indexer.mdx) and how you can query for the Current Fungible Asset Balances of an account. More usage examples can be found in [example queries](indexer/fungible-asset-balances.mdx).
43
+
Here's an interactive example of our [Indexer](indexer.mdx) and how you can query for the Current Fungible Asset Balances of an account. More usage examples can be found in [example queries](indexer/indexer-api/fungible-asset-balances.mdx).
<Card.Description>Retrieve NFT collections owned by a specific account.</Card.Description>
95
95
</Card>
96
-
<Cardhref="indexer/get-nfts">
96
+
<Cardhref="indexer/indexer-api/get-nfts">
97
97
<Card.Title>Get NFTs</Card.Title>
98
98
<Card.Description>Retrieve individual NFTs owned by a specific account.</Card.Description>
99
99
</Card>
100
-
<Cardhref="indexer/token-metadata">
100
+
<Cardhref="indexer/indexer-api/token-metadata">
101
101
<Card.Title>Get Token Metadata</Card.Title>
102
102
<Card.Description>Get metadata information for a specific token.</Card.Description>
103
103
</Card>
104
-
<Cardhref="indexer/get-delegators">
104
+
<Cardhref="indexer/indexer-api/get-delegators">
105
105
<Card.Title>Count Delegators in Staking Pool</Card.Title>
106
106
<Card.Description>Retrieve the number of active delegators in a staking pool.</Card.Description>
107
107
</Card>
@@ -112,11 +112,11 @@ To help get you started, here are the most common queries the Indexer is used fo
112
112
If the hosted Indexer API is not enough or if you want to index your custom contract, you can create a processor with the [Indexer SDK](./indexer/indexer-sdk.mdx).
113
113
114
114
<Cards>
115
-
<Cardhref="indexer-sdk/quickstart">
115
+
<Cardhref="indexer/indexer-sdk/quickstart">
116
116
<Card.Title>Quickstart Guide</Card.Title>
117
117
<Card.Description>Get started with the Indexer SDK</Card.Description>
118
118
</Card>
119
-
<Cardhref="indexer-sdk/documentation">
119
+
<Cardhref="indexer/indexer-sdk/documentation">
120
120
<Card.Title>Documentation</Card.Title>
121
121
<Card.Description>Read documentation about the Indexer SDK</Card.Description>
Copy file name to clipboardExpand all lines: apps/nextra/pages/en/build/indexer/indexer-api.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Aptos Labs hosts a public version of the Indexer GraphQL API that anyone can use
13
13
14
14
You can explore it by hand by viewing the Hasura Explorer below for the network you are interested in.
15
15
16
-
You can also access the API via the GraphQL endpoints below. For more information on the format of data in each field / table, please see the [table reference page](indexer-reference.mdx).
16
+
You can also access the API via the GraphQL endpoints below. For more information on the format of data in each field / table, please see the [table reference page](./indexer-api/indexer-reference.mdx).
17
17
18
18
## SDK Access (Primary Method)
19
19
@@ -61,5 +61,5 @@ The following rate limit applies for the Aptos Labs hosted indexer API:
61
61
If you need a higher rate limit, consider the following solutions:
62
62
63
63
1. Get an API Key from [API Gateway](https://developers.aptoslabs.com/).
64
-
2. Run the Aptos Indexer API yourself. See the guide to self-hosting [here](self-hosted.mdx).
64
+
2. Run the Aptos Indexer API yourself. See the guide to self-hosting [here](./txn-stream/self-hosted.mdx).
Copy file name to clipboardExpand all lines: apps/nextra/pages/en/build/indexer/indexer-api/architecture.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,9 +29,9 @@ Here is how the Indexer creates that API at a high-level:
29
29
/>
30
30
</center>
31
31
32
-
The Indexer uses the [Transaction Stream Service](./txn-stream.mdx) and custom processors written with the [Indexer SDK](./indexer-sdk.mdx) to update a database with rich tables. Then it exposes an API for Aptos apps to access the consolidated data.
32
+
The Indexer uses the [Transaction Stream Service](../txn-stream.mdx) and custom processors written with the [Indexer SDK](../indexer-sdk.mdx) to update a database with rich tables. Then it exposes an API for Aptos apps to access the consolidated data.
33
33
34
-
For situations where you need to go beyond the Aptos hosted Indexer API data, you will want to create a custom processor with the Indexer SDK (./indexer-sdk.mdx).
34
+
For situations where you need to go beyond the Aptos hosted Indexer API data, you will want to create a custom processor with the [Indexer SDK](../indexer-sdk.mdx).
The Indexer API allows you to access rich data about tokens, accounts, transactions, and events on-chain using GraphQL queries. **You can access it [here](./aptos-hosted.mdx).**
11
+
The Indexer API allows you to access rich data about tokens, accounts, transactions, and events on-chain using GraphQL queries. **You can access it [here](../indexer-api.mdx).**
12
12
13
13
For common queries, check out the sidebar for examples to work from. When building your own, this reference guide should help you determine which tables are most relevant, and how to format your queries.
14
14
@@ -24,7 +24,7 @@ If you are looking up a table with the `_by_pk` suffix, search for the table nam
24
24
# Indexer Table Reference
25
25
26
26
<Callouttype="info">
27
-
Remember to use Ctrl + F to find the table you are interested in! When in doubt, you may also want to query the Hasura tables linked in the [Indexer API Access](./aptos-hosted.mdx) page to see examples of the data inside.
27
+
Remember to use Ctrl + F to find the table you are interested in! When in doubt, you may also want to query the Hasura tables linked in the [Indexer API Access](../indexer-api.mdx) page to see examples of the data inside.
28
28
</Callout>
29
29
30
30
## Raw Data
@@ -261,7 +261,7 @@ This tracks the activity of fungible assets. It includes v1 token data.
261
261
| metadata | Object || Use the [Hasura explorer](https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql) to see fields for `metadata` in this table. |
262
262
| owner_address | String || This is an Aptos account address that owns the asset. Addresses must be 66 characters long, and so may be 0 padded. Ex. "0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89" |
263
263
| storage_id | String || Identifier for the storage used in the transaction. IDs must be 66 characters long, and so may be 0 padded. Ex. "0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89" |
264
-
| storage_refund_amount | bigint || Amount refunded for storage after the transaction. This is always in APT [octas](../../network/glossary.mdx#Octa). Ex. 50 |
264
+
| storage_refund_amount | bigint || Amount refunded for storage after the transaction. This is always in APT [octas](../../../network/glossary.mdx#Octa). Ex. 50 |
265
265
| token_standard | String || Aptos standard that the collection adheres to. Ex. "v1" |
266
266
| transaction_timestamp | String || Timestamp when the transaction occurred. Ex. "2024-04-17T02:14:25.68771" |
267
267
| transaction_version | bigint || Blockchain version of the transaction. Ex. 2 |
Copy file name to clipboardExpand all lines: apps/nextra/pages/en/build/indexer/indexer-api/self-hosted.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,11 +60,11 @@ If you're running this from a Docker Desktop environment (which you likely are i
60
60
61
61
### `indexer_grpc_data_service_address`
62
62
63
-
This is the URL for the Transaction Stream Service. If you are using the Labs-Hosted instance you can find the URLs for each network at [this page](aptos-hosted.mdx). Make sure to select the correct URL for the network you want to index. If you are running this service locally the value should be `127.0.0.1:50051`.
63
+
This is the URL for the Transaction Stream Service. If you are using the Labs-Hosted instance you can find the URLs for each network at [this page](../indexer-api.mdx). Make sure to select the correct URL for the network you want to index. If you are running this service locally the value should be `127.0.0.1:50051`.
64
64
65
65
### `auth_token`
66
66
67
-
This is the auth token used to connect to the Transaction Stream Service. If you are using the Labs-Hosted instance you can use the API Gateway to get an API key. Learn more at [this page](aptos-hosted.mdx).
67
+
This is the auth token used to connect to the Transaction Stream Service. If you are using the Labs-Hosted instance you can use the API Gateway to get an API key. Learn more at [this page](../indexer-api.mdx).
Copy file name to clipboardExpand all lines: apps/nextra/pages/en/build/indexer/indexer-sdk/documentation.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Each `Step` has an input and output, and the output of each `Step` is connected
30
30
</center>
31
31
32
32
## When to use the Indexer SDK
33
-
The Indexer SDK is useful when you want to index a custom contract or you realize you need a new kind of data that isn't available in the [Indexer API](../aptos-hosted.mdx).
33
+
The Indexer SDK is useful when you want to index a custom contract or you realize you need a new kind of data that isn't available in the [Indexer API](../indexer-api.mdx).
34
34
35
35
The general flow to write a custom processor with the Indexer SDK is:
0 commit comments