Skip to content
This repository was archived by the owner on Jul 30, 2025. It is now read-only.

Commit 52f3815

Browse files
committed
reorganize indexer docs
1 parent 5f69515 commit 52f3815

22 files changed

+131
-110
lines changed

apps/nextra/pages/en/build/indexer.mdx

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ import { Tabs, Callout } from 'nextra/components'
77

88
# Indexer
99

10-
<IndexerBetaNotice />
10+
We have several offerings for getting indexed data from the Aptos blockchain.
11+
1. Query the [Indexer API](indexer/indexer-api.mdx) to get basic data about transactions, fungible assets, and tokens
12+
2. Index your custom contract with the [Indexer SDK](indexer/indexer-sdk.mdx)
13+
3. Stream raw transactions from [Transaction Stream Service](indexer/txn-stream.mdx) to your processor or service
14+
15+
## Indexer API
1116

1217
The Aptos Indexer is an API you can use to get:
1318

@@ -42,7 +47,7 @@ The Indexer tracks every transaction that happens on-chain, then exposes that da
4247

4348
## Using the Indexer API
4449

45-
Learn how to use the Indexer API, what each table represents, and how to add custom data to the Indexer.
50+
Learn how to use the Indexer API, what each table represents, and the architecture.
4651

4752
<Cards>
4853
<Card href="indexer/aptos-hosted">
@@ -57,6 +62,10 @@ Learn how to use the Indexer API, what each table represents, and how to add cus
5762
<Card.Title>Architecture</Card.Title>
5863
<Card.Description>Detailed layout of the Indexer's architecture.</Card.Description>
5964
</Card>
65+
<Card href="indexer/self-hosted">
66+
<Card.Title>Self-hosted Indexer API</Card.Title>
67+
<Card.Description>Host your own Indexer API</Card.Description>
68+
</Card>
6069
</Cards>
6170

6271
### Example Queries
@@ -98,26 +107,30 @@ To help get you started, here are the most common queries the Indexer is used fo
98107
</Card>
99108
</Cards>
100109

101-
## Customizing the Indexer (Advanced)
110+
## Indexer SDK
102111

103-
If the hosted Indexer API is not enough, you can customize and host your own versions of the Indexer.
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).
104113

105114
<Cards>
106-
<Card href="indexer/architecture">
107-
<Card.Title>Architecture</Card.Title>
108-
<Card.Description>Detailed layout of the Indexer's architecture.</Card.Description>
109-
</Card>
110-
<Card href="indexer/indexer-sdk">
111-
<Card.Title>Indexer SDK</Card.Title>
112-
<Card.Description>Create a custom processor with the Indexer SDK</Card.Description>
115+
<Card href="indexer-sdk/quickstart">
116+
<Card.Title>Quickstart Guide</Card.Title>
117+
<Card.Description>Get started with the Indexer SDK</Card.Description>
113118
</Card>
114-
<Card href="indexer/txn-stream">
115-
<Card.Title>Transaction Streaming Service</Card.Title>
116-
<Card.Description>GRPC transaction streaming service, consumed by the Indexer</Card.Description>
119+
<Card href="indexer-sdk/documentation">
120+
<Card.Title>Documentation</Card.Title>
121+
<Card.Description>Read documentation about the Indexer SDK</Card.Description>
117122
</Card>
118-
<Card href="indexer/self-hosted">
119-
<Card.Title>Self-hosted Indexer API</Card.Title>
120-
<Card.Description>Host your own Indexer API</Card.Description>
123+
</Cards>
124+
125+
## Transaction Stream Service
126+
127+
Transaction Stream Service is a GRPC service that streams raw transactions to your processor or service.
128+
If you're using the Indexer SDK, you'll need an authorization token to connect to Transaction Stream Service.
129+
130+
<Cards>
131+
<Card href="indexer/txn-stream/aptos-hosted-txn-stream">
132+
<Card.Title>Aptos-Hosted Transaction Stream Service</Card.Title>
133+
<Card.Description>Get access to the Aptos-hosted Transaction Stream Service</Card.Description>
121134
</Card>
122135
</Cards>
123136

apps/nextra/pages/en/build/indexer/_meta.tsx

Lines changed: 2 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,13 @@
11
export default {
2-
"---usage---": {
3-
type: "separator",
4-
title: "Usage",
5-
},
6-
"aptos-hosted": {
7-
title: "Indexer API Access",
8-
},
9-
"indexer-reference": {
10-
title: "Indexer API Table Reference",
11-
},
12-
architecture: {
13-
title: "Architecture",
14-
},
15-
"---indexer-customizations---": {
16-
type: "separator",
17-
title: "Indexer Customizations (Advanced)",
2+
"indexer-api": {
3+
title: "Indexer API",
184
},
195
"indexer-sdk": {
206
title: "Indexer SDK",
217
},
228
"txn-stream": {
239
title: "Transaction Stream Service",
2410
},
25-
"self-hosted": {
26-
title: "Self-Hosted Indexer API",
27-
},
28-
"---example-queries---": {
29-
type: "separator",
30-
title: "Example Queries",
31-
},
32-
"fungible-asset-balances": {
33-
title: "Get Fungible Asset Balances",
34-
theme: {
35-
toc: false,
36-
layout: "full",
37-
},
38-
},
39-
"account-transactions": {
40-
title: "Get Transactions Impacting an Account",
41-
theme: {
42-
toc: false,
43-
layout: "full",
44-
},
45-
},
46-
"ans-lookup": {
47-
title: "Get Aptos Name",
48-
theme: {
49-
toc: false,
50-
layout: "full",
51-
},
52-
},
53-
"fungible-asset-info": {
54-
title: "Get Fungible Asset Info",
55-
theme: {
56-
toc: false,
57-
layout: "full",
58-
},
59-
},
60-
"get-nft-collections": {
61-
title: "Get NFT Collections By Account",
62-
theme: {
63-
toc: false,
64-
layout: "full",
65-
},
66-
},
67-
"get-nfts": {
68-
title: "Get NFTs By Account",
69-
theme: {
70-
toc: false,
71-
layout: "full",
72-
},
73-
},
74-
"token-metadata": {
75-
title: "Get Token Metadata",
76-
theme: {
77-
toc: false,
78-
layout: "full",
79-
},
80-
},
81-
"get-delegators": {
82-
title: "Count Delegators in Staking Pool",
83-
theme: {
84-
toc: false,
85-
layout: "full",
86-
},
87-
},
88-
"---legacy---": {
89-
type: "separator",
90-
title: "Legacy",
91-
},
9211
legacy: {
9312
title: "Legacy Indexer",
9413
},
File renamed without changes.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
export default {
2+
"indexer-reference": {
3+
title: "Indexer API Table Reference",
4+
},
5+
architecture: {
6+
title: "Architecture",
7+
},
8+
"self-hosted": {
9+
title: "Self-Hosted Indexer API",
10+
},
11+
"---example-queries---": {
12+
type: "separator",
13+
title: "Example Queries",
14+
},
15+
"fungible-asset-balances": {
16+
title: "Get Fungible Asset Balances",
17+
theme: {
18+
toc: false,
19+
layout: "full",
20+
},
21+
},
22+
"account-transactions": {
23+
title: "Get Transactions Impacting an Account",
24+
theme: {
25+
toc: false,
26+
layout: "full",
27+
},
28+
},
29+
"ans-lookup": {
30+
title: "Get Aptos Name",
31+
theme: {
32+
toc: false,
33+
layout: "full",
34+
},
35+
},
36+
"fungible-asset-info": {
37+
title: "Get Fungible Asset Info",
38+
theme: {
39+
toc: false,
40+
layout: "full",
41+
},
42+
},
43+
"get-nft-collections": {
44+
title: "Get NFT Collections By Account",
45+
theme: {
46+
toc: false,
47+
layout: "full",
48+
},
49+
},
50+
"get-nfts": {
51+
title: "Get NFTs By Account",
52+
theme: {
53+
toc: false,
54+
layout: "full",
55+
},
56+
},
57+
"token-metadata": {
58+
title: "Get Token Metadata",
59+
theme: {
60+
toc: false,
61+
layout: "full",
62+
},
63+
},
64+
"get-delegators": {
65+
title: "Count Delegators in Staking Pool",
66+
theme: {
67+
toc: false,
68+
layout: "full",
69+
},
70+
},
71+
};

apps/nextra/pages/en/build/indexer/account-transactions.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/account-transactions.mdx

File renamed without changes.

apps/nextra/pages/en/build/indexer/ans-lookup.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/ans-lookup.mdx

File renamed without changes.

apps/nextra/pages/en/build/indexer/architecture.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/architecture.mdx

File renamed without changes.

apps/nextra/pages/en/build/indexer/fungible-asset-balances.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/fungible-asset-balances.mdx

File renamed without changes.

apps/nextra/pages/en/build/indexer/fungible-asset-info.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/fungible-asset-info.mdx

File renamed without changes.

apps/nextra/pages/en/build/indexer/get-delegators.mdx renamed to apps/nextra/pages/en/build/indexer/indexer-api/get-delegators.mdx

File renamed without changes.

0 commit comments

Comments
 (0)