diff --git a/content/docs/stacks/api/index.mdx b/content/docs/stacks/api/index.mdx index 1d3a4ffe..8dedf3e5 100644 --- a/content/docs/stacks/api/index.mdx +++ b/content/docs/stacks/api/index.mdx @@ -10,6 +10,10 @@ The Stacks Blockchain API expands the intentionally minimal RPC endpoints availa ## Popular endpoints + +Use our `/v2` route to access the Stacks API node endpoints. For more information, see the [Stacks Node RPC API](https://docs.stacks.co/reference/api#stacks-node-rpc-api-endpoints) documentation. + + -This uses the estimated future total supply for the year 2050. - +Retrieves the total and unlocked STX supply. ### Query Parameters - + Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the `block height` is referred to the stacks blockchain. -Example: `200` +Minimum: `0` | Status code | Description | -| :------ | :------ | -| `200` | Success | +| :----------- | :----------- | +| `200` | GET request that returns total and unlocked STX supply | - + @@ -61,7 +57,7 @@ Supply details are queried from specified block height. If the block height is n ```bash -curl -X GET "https://api.hiro.so/extended/v1/stx_supply?height=200" +curl -X GET "https://api.hiro.so/extended/v1/stx_supply" ``` @@ -69,7 +65,7 @@ curl -X GET "https://api.hiro.so/extended/v1/stx_supply?height=200" ```js -fetch("https://api.hiro.so/extended/v1/stx_supply?height=200", { +fetch("https://api.hiro.so/extended/v1/stx_supply", { method: "GET" }); ``` @@ -92,6 +88,7 @@ GET request that returns network target block times { "unlocked_percent": "string", "total_stx": "string", + "total_stx_year_2050": "string", "unlocked_stx": "string", "block_height": 0 } @@ -111,9 +108,13 @@ export interface GetStxSupplyResponse { */ unlocked_percent: string; /** - * String quoted decimal number of the total possible number of STX + * String quoted decimal number of the total circulating number of STX (at the input block height if provided, otherwise the current block height) */ total_stx: string; + /** + * String quoted decimal number of total circulating STX supply in year 2050. STX supply grows approx 0.3% annually thereafter in perpetuity. + */ + total_stx_year_2050: string; /** * String quoted decimal number of the STX that have been mined or unlocked */ diff --git a/content/docs/stacks/api/smart-contracts/interface.mdx b/content/docs/stacks/api/smart-contracts/interface.mdx index 25fe4db8..d1aea4b1 100644 --- a/content/docs/stacks/api/smart-contracts/interface.mdx +++ b/content/docs/stacks/api/smart-contracts/interface.mdx @@ -90,7 +90,9 @@ GET request to get contract interface ], "non_fungible_tokens": [ {} - ] + ], + "epoch": "string", + "clarity_version": "string" } ``` diff --git a/content/docs/stacks/api/stacking-pool/members.mdx b/content/docs/stacks/api/stacking-pool/members.mdx index 562d2643..059889ea 100644 --- a/content/docs/stacks/api/stacking-pool/members.mdx +++ b/content/docs/stacks/api/stacking-pool/members.mdx @@ -24,7 +24,7 @@ import { - + ## Stacking pool members @@ -80,7 +80,7 @@ number of items to skip | :------ | :------ | | `200` | Success | - + @@ -93,7 +93,7 @@ number of items to skip ```bash -curl -X GET "https://api.hiro.so/extended/v1/pox3/SP21YTSM60CAY6D011EZVEVNKXVW8FVZE198XEFFP/delegations?unanchored=false&limit=5" +curl -X GET "https://api.hiro.so/extended/v1/pox4/SP21YTSM60CAY6D011EZVEVNKXVW8FVZE198XEFFP/delegations?unanchored=false&limit=5" ``` @@ -101,7 +101,7 @@ curl -X GET "https://api.hiro.so/extended/v1/pox3/SP21YTSM60CAY6D011EZVEVNKXVW8F ```js -fetch("https://api.hiro.so/extended/v1/pox3/SP21YTSM60CAY6D011EZVEVNKXVW8FVZE198XEFFP/delegations?after_block=0&unanchored=true&limit=100&offset=300", { +fetch("https://api.hiro.so/extended/v1/pox4/SP21YTSM60CAY6D011EZVEVNKXVW8FVZE198XEFFP/delegations?after_block=0&unanchored=true&limit=100&offset=300", { method: "GET" }); ``` diff --git a/content/docs/stacks/api/transactions/get-transaction.mdx b/content/docs/stacks/api/transactions/get-transaction.mdx index 6b582aca..b3036981 100644 --- a/content/docs/stacks/api/transactions/get-transaction.mdx +++ b/content/docs/stacks/api/transactions/get-transaction.mdx @@ -60,7 +60,7 @@ Transaction ID ```bash -curl -X GET "https://api.hiro.so/extended/v1/tx/%7Btx_id%7D" +curl -X GET "https://api.hiro.so/extended/v1/tx/{tx_id}" ``` @@ -68,7 +68,7 @@ curl -X GET "https://api.hiro.so/extended/v1/tx/%7Btx_id%7D" ```js -fetch("https://api.hiro.so/extended/v1/tx/%7Btx_id%7D", { +fetch("https://api.hiro.so/extended/v1/tx/{tx_id}", { method: "GET" }); ``` @@ -81,7 +81,7 @@ fetch("https://api.hiro.so/extended/v1/tx/%7Btx_id%7D", { -Describes all transaction types on Stacks 2.0 blockchain +Fetches transaction details for a given transaction ID diff --git a/content/docs/stacks/api/usage.mdx b/content/docs/stacks/api/usage.mdx index 40363e12..f9410d50 100644 --- a/content/docs/stacks/api/usage.mdx +++ b/content/docs/stacks/api/usage.mdx @@ -16,7 +16,7 @@ https://api.mainnet.hiro.so To make a request to the Stacks API, you can paste the `curl` command below in your terminal. ```bash title="Terminal" -curl -L 'https://api.hiro.so/v2/info' \ +curl -L 'https://api.hiro.so/extended' \ -H 'Accept: application/json' ``` @@ -25,7 +25,7 @@ curl -L 'https://api.hiro.so/v2/info' \ If you are using an `api-key`, you will need to replace `$HIRO_API_KEY` with your secret API key. ```bash title="Terminal" -curl -L 'https://api.hiro.so/v2/info' \ +curl -L 'https://api.hiro.so/extended' \ -H 'Accept: application/json' \ -H 'X-API-Key: $HIRO_API_KEY' # [!code highlight] ```