https://geomi.dev/_next/static/chunks/pages/docs/api-reference-4b1584269fadad95.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[7812],{28391:(i,s,e)=>{"use strict";e.r(s),e.d(s,{default:()=>p,useTOC:()=>c});var n=e(23798),t=e(60686),r=e(35999),a=e(4964),l=e(28541),h=e(90514),d=e(86534);function c(i){return[{value:"Overview",id:"overview",depth:2},{value:"Authentication",id:"authentication",depth:2},{value:"Rate Limits & Billing",id:"rate-limits--billing",depth:2},{value:"About Compute Units (CUs)",id:"about-compute-units-cus",depth:3},{value:"SDKs",id:"sdks",depth:2},{value:"Next Steps",id:"next-steps",depth:2}]}function o(i,s){throw Error("Expected "+(s?"component":"object")+" `"+i+"` to be defined: you likely forgot to import, pass, or provide it.")}let p=(0,t.e)(function(i){let{toc:s=c(i)}=i,e={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",span:"span",strong:"strong",ul:"ul",...(0,a.R)(),...i.components};return l.t||o("Tabs",!1),l.t.Tab||o("Tabs.Tab",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.h1,{children:"API Reference"}),"\n",(0,n.jsx)(e.p,{children:"This page provides a comprehensive reference for all Geomi APIs. Choose an API below to view endpoints, authentication, and examples."}),"\n",(0,n.jsx)(e.h2,{id:s[0].id,children:s[0].value}),"\n",(0,n.jsx)(e.p,{children:"Geomi provides access to multiple Aptos blockchain APIs:"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Node API"})," - Direct blockchain access (REST)"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Indexer API"})," - Advanced queries (GraphQL)"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Transaction Stream"})," - Real-time data (GRPC)"]}),"\n"]}),"\n",(0,n.jsx)(e.h2,{id:s[1].id,children:s[1].value}),"\n",(0,n.jsxs)(e.p,{children:["While anonymous API access is available with rate limits, we strongly recommend using a Geomi API key for significantly higher limits and usage tracking. ",(0,n.jsx)(e.a,{href:"/docs/api-keys",children:"Learn how to create one"})," or get started now by ",(0,n.jsx)(e.a,{href:"/manage/create-api-resource",children:"creating a new API key in Geomi"}),"."]}),"\n",(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"curl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "https://api.mainnet.aptoslabs.com/v1"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Authorization: Bearer YOUR_API_KEY_HERE"'})]})]})}),"\n",(0,n.jsx)(e.h2,{id:s[2].id,children:s[2].value}),"\n",(0,n.jsxs)(e.p,{children:["All APIs use a Compute Unit (CU) based billing system. For detailed pricing and limits, see the ",(0,n.jsx)(e.a,{href:"/docs/admin/billing",children:"Billing Documentation"}),"."]}),"\n",(0,n.jsx)(h.P,{type:"info",children:(0,n.jsx)(e.p,{children:"Anonymous requests are limited to 50,000 CUs per 5 minutes per IP. API key usage provides significantly higher limits."})}),"\n",(0,n.jsx)(e.h3,{id:s[3].id,children:s[3].value}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"CUs measure the relative infrastru

1cture cost of a request."}),"\n",(0,n.jsx)(e.li,{children:"More complex or longer‑running requests consume more CUs."}),"\n",(0,n.jsxs)(e.li,{children:["For current formulas, limits, and prices, see ",(0,n.jsx)(e.a,{href:"/docs/admin/billing",children:"Billing"}),"."]}),"\n"]}),"\n",(0,n.jsx)(e.hr,{}),"\n",(0,n.jsxs)(l.t,{items:["Node API","Indexer API","Transaction Stream"],children:[(0,n.jsxs)(l.t.Tab,{children:[(0,n.jsx)(e.h2,{children:"Node API (Fullnode REST API)"}),(0,n.jsx)(e.p,{children:"Direct access to the Aptos blockchain for reading state and submitting transactions."}),(0,n.jsx)(e.h3,{children:"Base URLs"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Mainnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.mainnet.aptoslabs.com/v1"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Testnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.testnet.aptoslabs.com/v1"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Devnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.devnet.aptoslabs.com/v1"})]}),"\n"]}),(0,n.jsx)(e.h3,{children:"Key Features"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"Read blockchain state"}),"\n",(0,n.jsx)(e.li,{children:"Submit transactions"}),"\n",(0,n.jsx)(e.li,{children:"Transaction simulation"}),"\n",(0,n.jsx)(e.li,{children:"Low latency access"}),"\n"]}),(0,n.jsx)(e.h3,{children:"Example: Get Account"}),(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"curl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "https://api.mainnet.aptoslabs.com/v1/accounts/0x1"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Authorization: Bearer YOUR_API_KEY"'})]})]})}),(0,n.jsx)(e.h3,{children:"Example: Get Account Resources"}),(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"curl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "https://api.mainnet.aptoslabs.com/v1/accounts/0x1/resources"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Authorization: Bearer YOUR_API_KEY"'})]})]})}),(0,n.jsx)(e.h3,{children:"Documentation"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"https://aptos.dev/build/apis/fullnode-rest-api",children:"Full API Reference"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"/docs/start",children:"Getting Started Guide"})}),"\n"]})]}),(0,n.jsxs)(l.t.Tab,{children:[(0,n.jsx)(e.h2,{children:"Indexer API (GraphQL)"}),(0,n.jsx)(e.p,{children:"High-level GraphQL interface for complex blockchain queries."}),(0,n.jsx)(e.h3,{children:"Base URLs"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Mainnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.mainnet.aptoslabs.com/v1/graphql"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Testnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.testnet.aptoslabs.com/v1/graphql"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Devnet:"})," ",(0,n.jsx)(e.code,{children:"https://api.devnet.aptoslabs.com/v1/graphql"})]}),"\n"]}),(0,n.jsx)(e.h3,{children:"Key Features"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"GraphQL queries with filtering"}),"\n",(0,n.jsx)(e.li,{children:"NFT and Aptos Objects support"}),"\n",(0,n.jsx)(e.li,{children:"Historical data access"}),"\n",(0,n.jsx)(e.li,{children:"Custom Move contract queries"}),"\n"]}),(0,n.jsx)(e.h3,{children:"Interactive Explorer"}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.a,{href:"https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql",children:"Open GraphiQL Interface"})}),(0,n.jsx)(e.h3,{children:"Example Query: Get Token Data"}),(0,n.jsx)(e.pre,{icon:d.hf,tabIndex:"0","data-language":"graphql","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"query"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" GetTokenData"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB

170"},children:"  current_token_datas_v2"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"("})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    where"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"collection_id"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"_eq"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"0x123..."'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}}"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    limit"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"10"})]}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  ) {"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    token_name"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    token_uri"})}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    collection_data"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      collection_name"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"    }"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  }"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"Execute with curl:"})}),(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"curl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "https://api.mainnet.aptoslabs.com/v1/graphql"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Authorization: Bearer YOUR_API_KEY"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Content-Type: application/json"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -d"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' \'{"query": "query GetTokenData { current_token_datas_v2(where: {collection_id: {_eq: \\"0x123...\\"}}, limit: 10) { token_name token_uri collection_data { collection_name } } }"}\''})]})]})}),(0,n.jsx)(e.h3,{children:"Example Query: Get Account Transactions"}),(0,n.jsx)(e.pre,{icon:d.hf,tabIndex:"0","data-language":"graphql","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"query"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" GetAccountTransactions"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"("}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB

170"},children:"$address"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"String"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"!"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:") {"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"  account_transactions"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"("})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    where"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"account_address"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"_eq"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"$address"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}}"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    limit"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"20"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    order_by"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"transaction_timestamp"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:":"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" desc"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})]}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  ) {"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    transaction_version"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    transaction_timestamp"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    transaction_type"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  }"})}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"Execute with curl:"})}),(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"curl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "https://api.mainnet.aptoslabs.com/v1/graphql"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Authorization: Bearer YOUR_API_KEY"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "Content-Type: application/json"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -d"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' \'{"query": "query GetAccountTransactions($address: String!) { account_transactions(where: {account_address: {_eq: $address}}, limit: 20, order_by: {transaction_timestamp: desc}) { transaction_version transaction_timestamp transaction_type } }", "variables": {"address": "0x1"}}\''})]})]})}),(0,n.jsx)(e.h3,{children:"Documentation"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"https://aptos.dev/build/indexer",children:"Full API Reference"})}),"\n"]})]}),(0,n.jsxs)(l.t.Tab,{children:[(0,n.jsx)(e.h2,{children:"Transaction Stream Service (GRPC)"}),(0,n.jsx)(e.p,{children:"Real-time transaction streaming for custom indexing."}),(0,n.jsx)(e.h3,{children:"Endpoints"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Mainnet:"})," ",(0,n.jsx)(e.code,{children:"grpc.mainnet.aptoslabs.com:443"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Testnet:"})," ",(0,n.jsx)(e.code,{children:"grpc.testnet.aptoslabs.com:443"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Devnet:"})," ",(0,n.jsx)(e.code,{children:"grpc.devnet.aptoslabs.com:443"})]}),"\n"]}),(0,n.jsx)(e.h3,{children:"Key Features"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"Historical and real-time transactions"}),"\n",(0,n.jsx)(e.li,{children:"Custom indexing processors"}),"\n",(0,n.jsx)(e.li,{children:"High throughput streaming"}),"\n",(0,n.jsx)(e.li,{children:"Event monitoring"}),"\n"]}),(0,n.jsx)(e.h3,{children:"Use Cases"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"Custom application indexers"}),"\n",(0,n.jsx)(e.li,{children:"Real-time data processing"}),"\n",(0,n.jsx)(e.li,{children:"Analytics pipelines"}),"\n",(0,n.jsx)(e.li,{children:"Event monitoring systems"}),"\n"]}),(0,n.jsx)(e.h3,{children:"Example: Stream Transactions with grpcurl"}),(0,n.jsx)(e.pre,{icon:d.k3,tabIndex:"0","data-language":"bash","data-word-wrap":"","data-copy":"",children:(0,n.jsxs)(e.code,{children:[(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"grpcurl"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" -d"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:" '{ \"starting_version\": 0 }'"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -max-msg-sz"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" 30000000"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"  -H"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:' "authorization: Bearer YOUR_API_KEY"'}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsxs)(e.span,{children:[(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"  grpc.mainnet.aptoslabs.com:443"}),(0,n.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\"})]}),"\n",(0,n.jsx)(e.span,{children:(0,n.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"  aptos.indexer.v1.RawData/GetTransactions"})})]})}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Note:"})," Requires ",(0,n.jsx)(e.a,{href:"https://github.com/fullstorydev/grpcurl",children:"grpcurl"})," to be installed."]}),(0,n.jsx)(e.h3,{children:"Documentation"}),(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"https://aptos.dev/build/indexer/txn-stream",children:"Transaction Stream Guide"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"https://aptos.dev/build/indexer/txn-stream#grpc-setup",children:"GRPC Setup Guide"})}),"\n"]})]})]}),"\n",(0,n.jsx)(e.hr,{}),"\n",(0,n.jsx)(e.h2,{id:s[4].id,children:s[4].value}),"\n",(0,n.jsxs)(e.p,{children:["Aptos provides official SDKs for multiple languages. For full documentation, installation guides, and examples, see the ",(0,n.jsx)(e.a,{href:"https://aptos.dev/build/sdks",children:"SDK documentation on aptos.dev"}),"."]}

1),"\n",(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"Quick Start:"})}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"TypeScript:"})," ",(0,n.jsx)(e.code,{children:"npm install @aptos-labs/ts-sdk"})," - ",(0,n.jsx)(e.a,{href:"https://aptos.dev/build/sdks/ts-sdk",children:"Docs"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Python:"})," ",(0,n.jsx)(e.code,{children:"pip install aptos-sdk"})," - ",(0,n.jsx)(e.a,{href:"https://aptos.dev/build/sdks/python-sdk",children:"Docs"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Rust:"})," ",(0,n.jsx)(e.a,{href:"https://aptos.dev/build/sdks/rust-sdk",children:"Installation Guide"})]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Go:"})," ",(0,n.jsx)(e.a,{href:"https://aptos.dev/build/sdks/go-sdk",children:"Installation Guide"})]}),"\n"]}),"\n",(0,n.jsx)(e.h2,{id:s[5].id,children:s[5].value}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"/docs/api-keys",children:"Create an API Key"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"/docs/admin/billing",children:"View Pricing & Limits"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.a,{href:"/docs/start",children:"Getting Started Guide"})}),"\n"]})]})},"/docs/api-reference",{filePath:"src/pages/docs/api-reference.mdx",pageMap:r.O,frontMatter:{title:"API Reference"},title:"API Reference"},"undefined"==typeof RemoteContent?c:RemoteContent.useTOC)},35471:(i,s,e)=>{(window.__NEXT_P=window.__NEXT_P||[]).push(["/docs/api-reference",function(){return e(28391)}])},35999:(i,s,e)=>{"use strict";e.d(s,{O:()=>n});let n=[{data:{docs:{type:"page",title:"Documentation"}}},{name:"docs",route:"/docs",children:[{data:{introduction:{title:"Introduction"},start:{title:"Getting Started"},"api-keys":{title:"API Keys"},"api-reference":{title:"API Reference"}

1,"no-code-indexing":{title:"No-Code Indexing"},"gas-stations":{title:"Gas Stations"},"aptos-mcp":{title:"Aptos MCP"},admin:{title:"Admin"},faq:{title:"FAQ"},identity:{title:"Identity",href:"https://aptos.dev/en/build/guides/aptos-keyless"}}},{name:"admin",route:"/docs/admin",children:[{data:{billing:{title:"Billing"},"resource-management":{title:"Resource Management"}}},{name:"billing",route:"/docs/admin/billing",frontMatter:{sidebarTitle:"Billing"}},{name:"resource-management",route:"/docs/admin/resource-management",frontMatter:{title:"Resource Management"}}]},{name:"api-keys",route:"/docs/api-keys",children:[{data:{"frontend-keys":{title:"Frontend Keys"}}},{name:"frontend-keys",route:"/docs/api-keys/frontend-keys",frontMatter:{sidebarTitle:"Frontend Keys"}}]},{name:"api-keys",route:"/docs/api-keys",frontMatter:{sidebarTitle:"API Keys"}},{name:"api-reference",route:"/docs/api-reference",frontMatter:{title:"API Reference"}},{name:"aptos-mcp",route:"/docs/aptos-mcp",frontMatter:{title:"Aptos MCP"}},{name:"faq",route:"/docs/faq",frontMatter:{sidebarTitle:"Faq"}},{name:"gas-stations",route:"/docs/gas-stations",children:[{data:{shelby:{title:"Shelby"}}},{name:"shelby",route:"/docs/gas-stations/shelby",frontMatter:{sidebarTitle:"Shelby"}}]},{name:"gas-stations",route:"/docs/gas-stations",frontMatter:{sidebarTitle:"Gas Stations"}},{name:"introduction",route:"/docs/introduction",frontMatter:{sidebarTitle:"Introduction"}},{name:"no-code-indexing",route:"/docs/no-code-indexing",frontMatter:{sidebarTitle:"No Code Indexing"}},{name:"start",route:"/docs/start",children:[{data:{}}]},{name:"start",route:"/docs/start",frontMatter:{sidebarTitle:"Start"}}]}]}},i=>{i.O(0,[3611,636,6593,8792],()=>i(i.s=35471)),_N_E=i.O()}]);