From 44ed147fb221adbd5951af1de7e67f922eceab67 Mon Sep 17 00:00:00 2001 From: Rafa Cardenas <253999660+rafa-stacks@users.noreply.github.com> Date: Wed, 8 Jul 2026 13:06:41 -0600 Subject: [PATCH 1/2] update stacks api docs --- .../en/apis/stacks-blockchain-api/meta.json | 1 - .../apis/stacks-blockchain-api/pagination.mdx | 96 ++++++++++++------- .../reference/accounts/assets.mdx | 12 --- .../reference/accounts/balances.mdx | 12 --- .../accounts/inbound-stx-transfers.mdx | 12 --- .../reference/accounts/latest-nonce.mdx | 12 --- .../reference/accounts/meta.json | 13 +-- .../reference/accounts/stx-balances.mdx | 12 --- .../accounts/transaction-with-transfers.mdx | 12 --- .../accounts/transactions-with-transfers.mdx | 12 --- .../reference/accounts/transactions.mdx | 12 --- .../blocks/block-by-burn-block-hash.mdx | 12 --- .../blocks/block-by-burn-block-height.mdx | 12 --- .../reference/blocks/block-by-hash.mdx | 12 --- .../reference/blocks/block-by-height.mdx | 12 --- .../reference/blocks/meta.json | 8 +- .../reference/blocks/recent-blocks.mdx | 12 --- .../reference/faucets/meta.json | 7 +- .../reference/fees/fee-rate.mdx | 12 --- .../reference/fees/meta.json | 5 - .../circulating-stx-supply-in-plain-text.mdx | 12 --- .../legacy-total-and-unlocked-stx-supply.mdx | 12 --- .../reference/info/meta.json | 6 +- .../info/total-stx-supply-in-plain-text.mdx | 12 --- .../reference/mempool/meta.json | 5 +- .../non-fungible-tokens/holdings.mdx | 12 --- .../reference/non-fungible-tokens/meta.json | 4 +- .../reference/proof-of-transfer/meta.json | 4 +- .../reference/smart-contracts/events.mdx | 12 --- .../reference/smart-contracts/meta.json | 7 +- .../reference/stacking-pool/meta.json | 7 +- .../transactions/address-transactions.mdx | 12 --- .../events-for-an-address-transaction.mdx | 12 --- .../transactions/get-raw-transaction.mdx | 12 --- .../transactions/get-transaction.mdx | 6 +- .../transactions/mempool-transactions.mdx | 12 --- .../reference/transactions/meta.json | 20 ++-- .../transactions/recent-transactions.mdx | 12 --- .../transactions/transaction-events.mdx | 12 --- .../transactions/transactions-by-block.mdx | 12 --- .../transactions/transactions-for-address.mdx | 12 --- .../requesting-proofs.mdx | 12 --- .../es/apis/stacks-blockchain-api/meta.json | 1 - .../requesting-proofs.mdx | 11 --- scripts/fetch-openapi-specs.mts | 2 +- 45 files changed, 112 insertions(+), 427 deletions(-) delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/assets.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/balances.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/inbound-stx-transfers.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/latest-nonce.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/stx-balances.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/transaction-with-transfers.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions-with-transfers.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-hash.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-height.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-hash.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-height.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/recent-blocks.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/fees/fee-rate.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/fees/meta.json delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/info/circulating-stx-supply-in-plain-text.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/info/legacy-total-and-unlocked-stx-supply.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/info/total-stx-supply-in-plain-text.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/holdings.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/events.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/address-transactions.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/events-for-an-address-transaction.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-raw-transaction.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/mempool-transactions.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/recent-transactions.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/transaction-events.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-by-block.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-for-address.mdx delete mode 100644 content/docs/en/apis/stacks-blockchain-api/requesting-proofs.mdx delete mode 100644 content/docs/es/apis/stacks-blockchain-api/requesting-proofs.mdx diff --git a/content/docs/en/apis/stacks-blockchain-api/meta.json b/content/docs/en/apis/stacks-blockchain-api/meta.json index 9f957b868..643bedfbd 100644 --- a/content/docs/en/apis/stacks-blockchain-api/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/meta.json @@ -8,7 +8,6 @@ "architecture", "pagination", "none-handling", - "requesting-proofs", "---Reference---", "...reference" ] diff --git a/content/docs/en/apis/stacks-blockchain-api/pagination.mdx b/content/docs/en/apis/stacks-blockchain-api/pagination.mdx index da1f8b9bb..0f0dbccb8 100644 --- a/content/docs/en/apis/stacks-blockchain-api/pagination.mdx +++ b/content/docs/en/apis/stacks-blockchain-api/pagination.mdx @@ -1,54 +1,82 @@ --- title: Pagination -description: Learn how to paginate through lists. +description: Learn how to paginate through lists using cursors. --- -## Usage +## Overview -To make API responses more compact, lists returned by the API are paginated. For lists, the response body includes: +To keep responses compact, endpoints that return lists are paginated. Newer endpoints (all `/extended/v3` routes, plus some `/extended/v2` routes) use **cursor-based pagination**: instead of counting through a list with a numeric offset, each response hands you an opaque cursor that points at the next page. This keeps results stable even when new items are added to the front of the list while you're paging through it. -- `limit`: The number of list items return per response -- `offset`: The number of elements to skip (starting from 0) -- `total`: The number of all available list items -- `results`: The array of list items (length of array equals the set limit) +## Request parameters -Here is a sample response: +Cursor-paginated endpoints accept two query parameters: + +- `limit`: The number of items to return per page. Defaults to `20`, with a maximum of `50`. +- `cursor`: The cursor pointing at the page to fetch. Omit it on your first request to get the first page. + +Treat the cursor as an opaque token — copy the value from a response and pass it back unchanged. (Its internal format is endpoint-specific; for example, the transactions endpoint encodes `block_height:microblock_sequence:tx_index`.) + +## Response body + +Each response includes: + +- `limit`: The number of items returned per page. +- `total`: The number of items available. +- `results`: The array of items (length equals the set limit, or fewer on the last page). +- `cursor`: An object with the cursors for navigating from the current page: + - `next`: Cursor for the next page, or `null` if this is the last page. + - `previous`: Cursor for the previous page, or `null` if this is the first page. + - `current`: Cursor for the current page. + +Here is a sample response from `GET /extended/v3/transactions?limit=20`: ```json { - "limit": 10, - "offset": 0, + "limit": 20, "total": 101922, + "cursor": { + "next": "14461:2147483647:0", + "previous": null, + "current": "14805:0:3" + }, "results": [ { "tx_id": "0x924e0a688664851f5f96b437fabaec19b7542cfcaaf92a97eae43384cacd83d0", - "nonce": 308, - "fee_rate": "0", - "sender_address": "ST39F7SA0AKH7RB363W3NE2DTHD3P32ZHNX2KE7J9", - "sponsored": false, - "post_condition_mode": "deny", - "post_conditions": [], - "anchor_mode": "on_chain_only", - "block_hash": "0x17ceb3da5f36aab351d6b14f5aa77f85bb6b800b954b2f24c564579f80116d99", - "parent_block_hash": "0xe0d1e8d216a77526ae2ce40294fc77038798a179a6532bb8980d3c2183f58de6", - "block_height": 14461, - "burn_block_time": 1622875042, - "burn_block_time_iso": "2021-06-05T06:37:22.000Z", - "canonical": true, - "tx_index": 0, "tx_status": "success", - "tx_result": {}, - "microblock_hash": "", - "microblock_sequence": 2147483647, - "microblock_canonical": true, - "event_count": 0, - "events": [], "tx_type": "coinbase", - "coinbase_payload": {} - }, - {} + "block_height": 14461, + "burn_block_time_iso": "2021-06-05T06:37:22.000Z" + } ] } ``` -Using the `limit` and `offset` properties, you can paginate through the entire list by increasing the offset by the limit until you reach the total. +## Paginating through a list + +To walk the entire list, make an initial request without a `cursor`, then repeat the request with the `cursor.next` value from each response. Stop when `cursor.next` is `null`. + +```js +async function fetchAllTransactions() { + const base = "https://api.hiro.so/extended/v3/transactions"; + const results = []; + let cursor = null; + + do { + const url = new URL(base); + url.searchParams.set("limit", "50"); + if (cursor) url.searchParams.set("cursor", cursor); + + const page = await fetch(url).then((res) => res.json()); + results.push(...page.results); + cursor = page.cursor.next; + } while (cursor); + + return results; +} +``` + +To page backwards, use `cursor.previous` the same way — it is `null` once you reach the first page. + + + Older endpoints (most `/extended/v1` and `/extended/v2` routes) still use offset-based pagination with `limit` and `offset` parameters and return a `total`. For those, page through the list by increasing `offset` by `limit` until you reach `total`. Check the parameters listed for each endpoint in the [API reference](/en/apis/stacks-blockchain-api) to see which style it uses. + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/assets.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/assets.mdx deleted file mode 100644 index 4fa1710cd..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/assets.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account assets -sidebarTitle: Assets -description: Retrieves a list of all asset events associated with an account or a contract identifier. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/balances.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/balances.mdx deleted file mode 100644 index 372e4a9d0..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/balances.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account balances -sidebarTitle: Balances -description: Retrieves account balance information, including STX, fungible, and non-fungible tokens. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/inbound-stx-transfers.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/inbound-stx-transfers.mdx deleted file mode 100644 index 8e60215a1..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/inbound-stx-transfers.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get inbound STX transfers -sidebarTitle: Inbound STX transfers -description: Retrieves a list of STX transfers with memos to the given principal. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/latest-nonce.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/latest-nonce.mdx deleted file mode 100644 index b96bafc6c..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/latest-nonce.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get the latest nonce -sidebarTitle: Latest nonce -description: Retrieves the latest nonce values used by an account by inspecting the mempool and anchored transactions. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/meta.json index ba89d31c7..bf6cdd511 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/meta.json @@ -1,14 +1,11 @@ { "title": "Accounts", "pages": [ - "assets", - "balances", - "stx-balances", - "inbound-stx-transfers", - "transactions", - "transactions-with-transfers", - "transaction-with-transfers", - "latest-nonce" + "get-principal-balances-stx", + "get-principal-balances-ft", + "get-principal-balance-ft", + "get-principal-balances-nft", + "get-principal-nonces" ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/stx-balances.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/stx-balances.mdx deleted file mode 100644 index 1fb09b7eb..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/stx-balances.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account STX balance -sidebarTitle: STX balance -description: Retrieves the STX token balance for a specified address or contract identifier. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transaction-with-transfers.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transaction-with-transfers.mdx deleted file mode 100644 index 7e3186c67..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transaction-with-transfers.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account transaction details with transfers -sidebarTitle: Transaction details with transfers -description: Retrieves transaction details for a specific transaction including STX transfers for each transaction. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions-with-transfers.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions-with-transfers.mdx deleted file mode 100644 index 5873a647b..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions-with-transfers.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account transactions with transfers -sidebarTitle: Transactions with transfers -description: Retrieves transactions for a specific account including STX transfers for each transaction. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions.mdx deleted file mode 100644 index 5b1213b65..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/transactions.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get account transactions -sidebarTitle: Transactions -description: Retrieves transactions for a specific account. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-hash.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-hash.mdx deleted file mode 100644 index 6ec1105bf..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-hash.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get block by burnchain block hash -sidebarTitle: Block by burn block hash -description: Retrieves block details of a specific block for a given burnchain block hash. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-height.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-height.mdx deleted file mode 100644 index 9485c6cdd..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-burn-block-height.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get block by burnchain block height -sidebarTitle: Block by burn block height -description: Retrieves block details of a specific block for a given burnchain block height. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-hash.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-hash.mdx deleted file mode 100644 index 7183a33e3..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-hash.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get block by hash -sidebarTitle: Block by hash -description: Retrieves block details of a specific block for a given chain height. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-height.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-height.mdx deleted file mode 100644 index d21f4526c..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/block-by-height.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get block by height -sidebarTitle: Block by height -description: Retrieves block details of a specific block for a given chain height. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/meta.json index eb56eed30..46c759db2 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/meta.json @@ -5,11 +5,9 @@ "get-blocks", "get-blocks-by-burn-block", "average-times", - "recent-blocks", - "block-by-hash", - "block-by-height", - "block-by-burn-block-hash", - "block-by-burn-block-height" + "get-block-by-block-time", + "get-signer-signatures-for-block", + "get-tenure-blocks" ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/recent-blocks.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/recent-blocks.mdx deleted file mode 100644 index 67110d661..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/recent-blocks.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get recent blocks -sidebarTitle: Recent blocks -description: Retrieves a list of recently mined blocks. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/faucets/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/meta.json index eb48880f9..33b32ad18 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/faucets/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/meta.json @@ -1,5 +1,10 @@ { "title": "Faucets", - "pages": ["..."], + "pages": [ + "...", + "run-faucet-btc", + "get-btc-balance", + "run-faucet-sbtc" + ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/fees/fee-rate.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/fees/fee-rate.mdx deleted file mode 100644 index 82454cc32..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/fees/fee-rate.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get fee rate -sidebarTitle: Fee rate -description: Retrieves an estimated fee rate for transactions. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/fees/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/fees/meta.json deleted file mode 100644 index 4dae7e68c..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/fees/meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "title": "Fees", - "pages": ["fee-rate"], - "defaultOpen": false -} diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/info/circulating-stx-supply-in-plain-text.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/info/circulating-stx-supply-in-plain-text.mdx deleted file mode 100644 index ccde6ba9e..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/info/circulating-stx-supply-in-plain-text.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get circulating STX supply in plain text format -sidebarTitle: Circulating STX supply in plain text format -description: Retrieves the circulating STX supply as plain text. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/info/legacy-total-and-unlocked-stx-supply.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/info/legacy-total-and-unlocked-stx-supply.mdx deleted file mode 100644 index b23fcc5dc..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/info/legacy-total-and-unlocked-stx-supply.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get total and unlocked STX supply (legacy) -sidebarTitle: Total and unlocked STX supply (legacy) -description: Retrieves the total and unlocked STX supply in legacy format 1.0 API. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/info/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/info/meta.json index 00dc4199c..a010230ef 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/info/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/info/meta.json @@ -4,11 +4,7 @@ "status", "network-block-time", "network-given-block-time", - "total-and-unlocked-stx-supply", - "legacy-total-and-unlocked-stx-supply", - "total-stx-supply-in-plain-text", - "circulating-stx-supply-in-plain-text", - "pox-details" + "total-and-unlocked-stx-supply" ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/info/total-stx-supply-in-plain-text.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/info/total-stx-supply-in-plain-text.mdx deleted file mode 100644 index cbf3f999e..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/info/total-stx-supply-in-plain-text.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get total STX supply in plain text format -sidebarTitle: Total STX supply in plain text format -description: Retrieves the total STX supply as plain text. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/mempool/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/mempool/meta.json index 9bb39bde6..827133ea6 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/mempool/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/mempool/meta.json @@ -1,5 +1,8 @@ { "title": "Mempool", - "pages": ["..."], + "pages": [ + "...", + "get-mempool-transactions" + ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/holdings.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/holdings.mdx deleted file mode 100644 index 8267e2523..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/holdings.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get non-fungible token holdings -sidebarTitle: Non-fungible token holdings -description: Retrieves a list of non-fungible tokens owned by the given principal (STX address or smart contract ID). -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/meta.json index 4fc658c57..34ed16d93 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/non-fungible-tokens/meta.json @@ -1,5 +1,7 @@ { "title": "Non-fungible tokens", - "pages": ["..."], + "pages": [ + "..." + ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/meta.json index f62e46c27..322642dcc 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/meta.json @@ -5,7 +5,9 @@ "cycle", "signers-in-cycle", "signer-in-cycle", - "stackers-for-signer-in-cycle" + "stackers-for-signer-in-cycle", + "get-burn-block-pox-transactions", + "get-burnchain-address-pox-transactions" ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/events.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/events.mdx deleted file mode 100644 index 3874abdf5..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/events.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get contract events -sidebarTitle: Contract events -description: Retrieves a list of events that have been triggered by a given smart contract. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/meta.json index 72880557e..a28fe9fe2 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/meta.json @@ -1,5 +1,10 @@ { "title": "Smart Contracts", - "pages": ["status", "info", "by-trait", "events"], + "pages": [ + "status", + "info", + "by-trait", + "get-smart-contract-logs" + ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/meta.json index a25793e9e..a9822727c 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/meta.json @@ -1,5 +1,10 @@ { "title": "Stacking Pool", - "pages": ["..."], + "pages": [ + "...", + "get-latest-pox-events", + "get-pox-events-for-a-transaction", + "get-events-for-a-stacking-address" + ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/address-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/address-transactions.mdx deleted file mode 100644 index c4be01ead..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/address-transactions.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get address transactions -sidebarTitle: Address transactions -description: Retrieves transactions sent or received by a STX address or smart contract ID. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/events-for-an-address-transaction.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/events-for-an-address-transaction.mdx deleted file mode 100644 index 2eb4c25f7..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/events-for-an-address-transaction.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get events for an address transaction -sidebarTitle: Events for an address transaction -description: Retrieves events for a specific transaction. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-raw-transaction.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-raw-transaction.mdx deleted file mode 100644 index df6b0485c..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-raw-transaction.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get raw transaction -sidebarTitle: Raw transaction -description: Retrieves a hex encoded serialized transaction for a given ID. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction.mdx index a5da962f9..b9c5d933a 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction.mdx +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction.mdx @@ -1,12 +1,12 @@ --- title: Get transaction sidebarTitle: Transaction -description: Retrieves details for a specific transaction. +description: Retrieves details for a given transaction, including both mined and mempool transactions full: true --- \ No newline at end of file +/> diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/mempool-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/mempool-transactions.mdx deleted file mode 100644 index b1380d739..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/mempool-transactions.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get mempool transactions -sidebarTitle: Mempool transactions -description: Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/meta.json index 59f10ae9b..088e26214 100644 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/meta.json +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/meta.json @@ -1,18 +1,16 @@ { "title": "Transactions", "pages": [ - "recent-transactions", - "get-transaction", - "get-raw-transaction", - "address-transactions", - "transactions-by-block", - "events-for-an-address-transaction", - "transaction-events", - "transaction-fee-priorities", - "mempool-transactions", - "dropped-mempool-transactions", "statistics-for-mempool-transactions", - "details-for-transactions" + "details-for-transactions", + "get-block-transactions", + "get-principal-transactions", + "get-principal-transaction-balance-changes", + "get-principal-balance-changes", + "get-principal-mempool-transactions", + "get-transactions", + "get-transaction", + "get-transaction-events" ], "defaultOpen": false } diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/recent-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/recent-transactions.mdx deleted file mode 100644 index da5c4c922..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/recent-transactions.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get recent transactions -sidebarTitle: Recent transactions -description: Retrieves all recently mined transactions. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transaction-events.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transaction-events.mdx deleted file mode 100644 index a6690ff7a..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transaction-events.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get transaction events -sidebarTitle: Transaction events -description: Retrieves events for a specific transaction. -full: true ---- - - diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-by-block.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-by-block.mdx deleted file mode 100644 index 84ca486c2..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-by-block.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get transactions by block -sidebarTitle: Transactions by block -description: Retrieves transactions confirmed in a single block. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-for-address.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-for-address.mdx deleted file mode 100644 index 78120cda6..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/transactions-for-address.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get transactions for address -sidebarTitle: Transactions for address -description: Retrieves transactions for a specific address. -full: true ---- - - \ No newline at end of file diff --git a/content/docs/en/apis/stacks-blockchain-api/requesting-proofs.mdx b/content/docs/en/apis/stacks-blockchain-api/requesting-proofs.mdx deleted file mode 100644 index 595065714..000000000 --- a/content/docs/en/apis/stacks-blockchain-api/requesting-proofs.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Requesting proofs -description: Understand proof requests from API endpoints. ---- - -## Overview - -Several endpoints will request the [MARF Merkel Proof](https://github.com/stacksgov/sips/blob/main/sips/sip-004/sip-004-materialized-view.md#marf-merkle-proofs) by default. - -Provided with the proof, a client can verify the value, cumulative energy spent, and the number of confirmation for the response value provided by the API. - -Requesting the proof requires more resources (computation time, response time, and response body size). To avoid the additional resources, in case verification is not required, API endpoints allow setting the request parameter: `proof=0`. The returned response object will not have any proof fields. diff --git a/content/docs/es/apis/stacks-blockchain-api/meta.json b/content/docs/es/apis/stacks-blockchain-api/meta.json index 9f957b868..643bedfbd 100644 --- a/content/docs/es/apis/stacks-blockchain-api/meta.json +++ b/content/docs/es/apis/stacks-blockchain-api/meta.json @@ -8,7 +8,6 @@ "architecture", "pagination", "none-handling", - "requesting-proofs", "---Reference---", "...reference" ] diff --git a/content/docs/es/apis/stacks-blockchain-api/requesting-proofs.mdx b/content/docs/es/apis/stacks-blockchain-api/requesting-proofs.mdx deleted file mode 100644 index 3af495251..000000000 --- a/content/docs/es/apis/stacks-blockchain-api/requesting-proofs.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Solicitando pruebas -description: Comprender las solicitudes de prueba de los puntos finales de la API. ---- -## Visión general - -Varios endpoints solicitarán el [Prueba de Merkel MARF](https://github.com/stacksgov/sips/blob/main/sips/sip-004/sip-004-materialized-view.md#marf-merkle-proofs) por defecto. - -Provisto con la prueba, un cliente puede verificar el valor, la energía acumulada gastada y el número de confirmaciones para el valor de respuesta proporcionado por la API. - -Solicitar la prueba requiere más recursos (tiempo de cómputo, tiempo de respuesta y tamaño del cuerpo de la respuesta). Para evitar los recursos adicionales, en caso de que no se requiera verificación, los puntos finales de la API permiten establecer el parámetro de solicitud: `proof=0`. El objeto de respuesta devuelto no tendrá ningún campo de prueba. diff --git a/scripts/fetch-openapi-specs.mts b/scripts/fetch-openapi-specs.mts index 77819827c..14c7224c0 100644 --- a/scripts/fetch-openapi-specs.mts +++ b/scripts/fetch-openapi-specs.mts @@ -40,7 +40,7 @@ const GITHUB_API_SPECS: GitHubApiSpec[] = [ { name: 'stacks-blockchain', type: 'github', - repo: 'hirosystems/stacks-blockchain-api', + repo: 'stx-labs/stacks-blockchain-api', branch: 'master', filePath: 'openapi.yaml', }, From a2719928376eb9a905abc9627c1e22e948460d2f Mon Sep 17 00:00:00 2001 From: Rafa Cardenas <253999660+rafa-stacks@users.noreply.github.com> Date: Wed, 8 Jul 2026 13:11:12 -0600 Subject: [PATCH 2/2] docs: scaffold new Stacks Blockchain API v3 endpoint reference pages Add reference pages for the 42 endpoints introduced in the updated OpenAPI spec, including the new Staking and Microblocks groups plus new v3 routes across Accounts, Transactions, Blocks, Faucets, Proof of Transfer, Names, Mempool, Smart Contracts, and Stacking. Each page is an stub wired into its group's meta.json nav. Co-Authored-By: Claude Opus 4.8 --- .../accounts/get-principal-balance-ft.mdx | 12 ++++++++++++ .../accounts/get-principal-balances-ft.mdx | 12 ++++++++++++ .../accounts/get-principal-balances-nft.mdx | 12 ++++++++++++ .../accounts/get-principal-balances-stx.mdx | 12 ++++++++++++ .../reference/accounts/get-principal-nonces.mdx | 12 ++++++++++++ .../blocks/get-block-by-block-time.mdx | 12 ++++++++++++ .../blocks/get-signer-signatures-for-block.mdx | 12 ++++++++++++ .../reference/blocks/get-tenure-blocks.mdx | 12 ++++++++++++ .../reference/faucets/get-btc-balance.mdx | 12 ++++++++++++ .../reference/faucets/run-faucet-btc.mdx | 12 ++++++++++++ .../reference/faucets/run-faucet-sbtc.mdx | 12 ++++++++++++ .../mempool/get-mempool-transactions.mdx | 12 ++++++++++++ .../microblocks/get-microblock-by-hash.mdx | 12 ++++++++++++ .../microblocks/get-microblock-list.mdx | 12 ++++++++++++ .../microblocks/get-unanchored-txs.mdx | 12 ++++++++++++ .../reference/microblocks/meta.json | 9 +++++++++ .../reference/names/name-price.mdx | 12 ++++++++++++ .../reference/names/namespace-price.mdx | 12 ++++++++++++ .../get-burn-block-pox-transactions.mdx | 12 ++++++++++++ .../get-burnchain-address-pox-transactions.mdx | 12 ++++++++++++ .../smart-contracts/get-smart-contract-logs.mdx | 12 ++++++++++++ .../get-events-for-a-stacking-address.mdx | 12 ++++++++++++ .../stacking-pool/get-latest-pox-events.mdx | 12 ++++++++++++ .../get-pox-events-for-a-transaction.mdx | 12 ++++++++++++ .../staking/get-bond-allowlist-entries.mdx | 12 ++++++++++++ .../staking/get-bond-allowlist-entry.mdx | 12 ++++++++++++ .../reference/staking/get-bond-registration.mdx | 12 ++++++++++++ .../staking/get-bond-registrations.mdx | 12 ++++++++++++ .../reference/staking/get-bond.mdx | 12 ++++++++++++ .../reference/staking/get-bonds.mdx | 12 ++++++++++++ .../staking/get-principal-bond-positions.mdx | 12 ++++++++++++ .../staking/get-principal-staking-summary.mdx | 12 ++++++++++++ .../staking/get-staking-signer-stakers.mdx | 12 ++++++++++++ .../reference/staking/get-staking-signer.mdx | 12 ++++++++++++ .../reference/staking/get-staking-signers.mdx | 12 ++++++++++++ .../reference/staking/meta.json | 17 +++++++++++++++++ .../transactions/get-block-transactions.mdx | 12 ++++++++++++ .../get-principal-balance-changes.mdx | 12 ++++++++++++ .../get-principal-mempool-transactions.mdx | 12 ++++++++++++ ...et-principal-transaction-balance-changes.mdx | 12 ++++++++++++ .../transactions/get-principal-transactions.mdx | 12 ++++++++++++ .../transactions/get-transaction-events.mdx | 12 ++++++++++++ .../reference/transactions/get-transactions.mdx | 12 ++++++++++++ 43 files changed, 518 insertions(+) create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balance-ft.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-ft.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-nft.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-stx.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-nonces.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-block-by-block-time.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-signer-signatures-for-block.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-tenure-blocks.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/faucets/get-btc-balance.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-btc.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-sbtc.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/mempool/get-mempool-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-by-hash.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-list.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-unanchored-txs.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/microblocks/meta.json create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/names/name-price.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/names/namespace-price.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burn-block-pox-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burnchain-address-pox-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/get-smart-contract-logs.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-events-for-a-stacking-address.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-latest-pox-events.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-pox-events-for-a-transaction.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entries.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entry.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registration.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registrations.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bonds.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-bond-positions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-staking-summary.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer-stakers.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signers.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/staking/meta.json create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-block-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-balance-changes.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-mempool-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transaction-balance-changes.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transactions.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction-events.mdx create mode 100644 content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transactions.mdx diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balance-ft.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balance-ft.mdx new file mode 100644 index 000000000..af0df2ac1 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balance-ft.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal FT balance +sidebarTitle: Principal FT balance +description: Get a principal's balance of a single fungible token. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-ft.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-ft.mdx new file mode 100644 index 000000000..23610f453 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-ft.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal FT balances +sidebarTitle: Principal FT balances +description: Get a principal's fungible-token balances, sorted by balance descending. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-nft.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-nft.mdx new file mode 100644 index 000000000..8c76e38ca --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-nft.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal NFT balances +sidebarTitle: Principal NFT balances +description: Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-stx.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-stx.mdx new file mode 100644 index 000000000..abfcb0d19 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-balances-stx.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal STX balance +sidebarTitle: Principal STX balance +description: "Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions." +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-nonces.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-nonces.mdx new file mode 100644 index 000000000..9e3defa75 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/accounts/get-principal-nonces.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal nonces +sidebarTitle: Principal nonces +description: "Get a Stacks account's latest nonce state by inspecting its confirmed (anchored + microblock) transactions and the mempool, including the nonce to use for its next transaction." +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-block-by-block-time.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-block-by-block-time.mdx new file mode 100644 index 000000000..930f80d86 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-block-by-block-time.mdx @@ -0,0 +1,12 @@ +--- +title: Get block by block time +sidebarTitle: Block by block time +description: Retrieves the most recent block mined at or before a given Unix timestamp (in seconds) +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-signer-signatures-for-block.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-signer-signatures-for-block.mdx new file mode 100644 index 000000000..99ae02dcd --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-signer-signatures-for-block.mdx @@ -0,0 +1,12 @@ +--- +title: Get signer signatures for block +sidebarTitle: Signer signatures for block +description: Retrieves the signer signatures (an array of signature byte strings) in a single block +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-tenure-blocks.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-tenure-blocks.mdx new file mode 100644 index 000000000..79580d9f7 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/blocks/get-tenure-blocks.mdx @@ -0,0 +1,12 @@ +--- +title: Get blocks by tenure +sidebarTitle: Blocks by tenure +description: Retrieves blocks confirmed in a block tenure +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/faucets/get-btc-balance.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/get-btc-balance.mdx new file mode 100644 index 000000000..203104401 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/get-btc-balance.mdx @@ -0,0 +1,12 @@ +--- +title: Get BTC balance for address +sidebarTitle: BTC balance for address +description: Get BTC balance for address. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-btc.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-btc.mdx new file mode 100644 index 000000000..1b8a6a327 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-btc.mdx @@ -0,0 +1,12 @@ +--- +title: Add regtest BTC tokens to address +sidebarTitle: Regtest BTC tokens to address +description: Add 0.01 BTC token to the specified regtest BTC address. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-sbtc.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-sbtc.mdx new file mode 100644 index 000000000..48d315000 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/faucets/run-faucet-sbtc.mdx @@ -0,0 +1,12 @@ +--- +title: Get sBTC testnet tokens +sidebarTitle: SBTC testnet tokens +description: Add sBTC tokens to the specified testnet address. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/mempool/get-mempool-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/mempool/get-mempool-transactions.mdx new file mode 100644 index 000000000..098ab09e5 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/mempool/get-mempool-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get mempool transactions +sidebarTitle: Mempool transactions +description: Retrieves a list of recently broadcasted transactions +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-by-hash.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-by-hash.mdx new file mode 100644 index 000000000..d097346fd --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-by-hash.mdx @@ -0,0 +1,12 @@ +--- +title: Get microblock +sidebarTitle: Microblock +description: Retrieves a specific microblock by hash +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-list.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-list.mdx new file mode 100644 index 000000000..31a24c642 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-microblock-list.mdx @@ -0,0 +1,12 @@ +--- +title: Get recent microblocks +sidebarTitle: Recent microblocks +description: Retrieves a list of microblocks. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-unanchored-txs.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-unanchored-txs.mdx new file mode 100644 index 000000000..9487c9ee6 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/get-unanchored-txs.mdx @@ -0,0 +1,12 @@ +--- +title: Get the list of current transactions that belong to unanchored microblocks +sidebarTitle: The list of current transactions that belong to unanchored microblocks +description: Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/meta.json new file mode 100644 index 000000000..48edc9d4d --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/microblocks/meta.json @@ -0,0 +1,9 @@ +{ + "title": "Microblocks", + "pages": [ + "get-microblock-list", + "get-microblock-by-hash", + "get-unanchored-txs" + ], + "defaultOpen": false +} diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/names/name-price.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/names/name-price.mdx new file mode 100644 index 000000000..b9361e5bf --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/names/name-price.mdx @@ -0,0 +1,12 @@ +--- +title: Get Name Price +sidebarTitle: Name Price +description: Retrieves the price of a name. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/names/namespace-price.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/names/namespace-price.mdx new file mode 100644 index 000000000..3bdf08129 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/names/namespace-price.mdx @@ -0,0 +1,12 @@ +--- +title: Get Namespace Price +sidebarTitle: Namespace Price +description: Retrieves the price of a namespace. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burn-block-pox-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burn-block-pox-transactions.mdx new file mode 100644 index 000000000..335b7c726 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burn-block-pox-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get PoX transactions by burn block +sidebarTitle: PoX transactions by burn block +description: Retrieves a list of PoX transactions confirmed by a specific burn block +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burnchain-address-pox-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burnchain-address-pox-transactions.mdx new file mode 100644 index 000000000..50e54dc05 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/proof-of-transfer/get-burnchain-address-pox-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get PoX transactions for a burnchain address +sidebarTitle: PoX transactions for a burnchain address +description: Retrieves a list of PoX transactions +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/get-smart-contract-logs.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/get-smart-contract-logs.mdx new file mode 100644 index 000000000..85dc6cc0c --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/smart-contracts/get-smart-contract-logs.mdx @@ -0,0 +1,12 @@ +--- +title: Get smart contract logs +sidebarTitle: Smart contract logs +description: Retrieves contract log events for a given smart contract. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-events-for-a-stacking-address.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-events-for-a-stacking-address.mdx new file mode 100644 index 000000000..5c22909ce --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-events-for-a-stacking-address.mdx @@ -0,0 +1,12 @@ +--- +title: Get events for a stacking address +sidebarTitle: Events for a stacking address +description: Get events for a stacking address. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-latest-pox-events.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-latest-pox-events.mdx new file mode 100644 index 000000000..e071a1e17 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-latest-pox-events.mdx @@ -0,0 +1,12 @@ +--- +title: Get latest PoX events +sidebarTitle: Latest PoX events +description: Get latest PoX events. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-pox-events-for-a-transaction.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-pox-events-for-a-transaction.mdx new file mode 100644 index 000000000..b5e4ef42d --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/stacking-pool/get-pox-events-for-a-transaction.mdx @@ -0,0 +1,12 @@ +--- +title: Get PoX events for a transaction +sidebarTitle: PoX events for a transaction +description: Get PoX events for a transaction. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entries.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entries.mdx new file mode 100644 index 000000000..5f035540f --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entries.mdx @@ -0,0 +1,12 @@ +--- +title: Get bond allowlist entries +sidebarTitle: Bond allowlist entries +description: Get bond allowlist entries +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entry.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entry.mdx new file mode 100644 index 000000000..625d643de --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-allowlist-entry.mdx @@ -0,0 +1,12 @@ +--- +title: Get bond allowlist entry +sidebarTitle: Bond allowlist entry +description: Get bond allowlist entry +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registration.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registration.mdx new file mode 100644 index 000000000..a3a3b29e2 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registration.mdx @@ -0,0 +1,12 @@ +--- +title: Get bond registration +sidebarTitle: Bond registration +description: Get bond registration +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registrations.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registrations.mdx new file mode 100644 index 000000000..76f17a0ed --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond-registrations.mdx @@ -0,0 +1,12 @@ +--- +title: Get bond registrations +sidebarTitle: Bond registrations +description: Get bond registrations +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond.mdx new file mode 100644 index 000000000..087a3cee5 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bond.mdx @@ -0,0 +1,12 @@ +--- +title: Get bond +sidebarTitle: Bond +description: Get bond +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bonds.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bonds.mdx new file mode 100644 index 000000000..0b2139dfb --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-bonds.mdx @@ -0,0 +1,12 @@ +--- +title: Get bonds +sidebarTitle: Bonds +description: Get bonds +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-bond-positions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-bond-positions.mdx new file mode 100644 index 000000000..528c44b13 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-bond-positions.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal bond positions +sidebarTitle: Principal bond positions +description: "Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in." +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-staking-summary.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-staking-summary.mdx new file mode 100644 index 000000000..11a3f2a54 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-principal-staking-summary.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal staking summary +sidebarTitle: Principal staking summary +description: "A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions." +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer-stakers.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer-stakers.mdx new file mode 100644 index 000000000..5f9058698 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer-stakers.mdx @@ -0,0 +1,12 @@ +--- +title: Get staking signer stakers +sidebarTitle: Staking signer stakers +description: List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer.mdx new file mode 100644 index 000000000..3d3cd8c6d --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signer.mdx @@ -0,0 +1,12 @@ +--- +title: Get staking signer +sidebarTitle: Staking signer +description: Get a registered pox-5 staking signer along with the details of the transaction that registered its current key. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signers.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signers.mdx new file mode 100644 index 000000000..59b358d0f --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/get-staking-signers.mdx @@ -0,0 +1,12 @@ +--- +title: Get staking signers +sidebarTitle: Staking signers +description: Get the registered pox-5 staking signers and their current signing keys. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/staking/meta.json b/content/docs/en/apis/stacks-blockchain-api/reference/staking/meta.json new file mode 100644 index 000000000..a6043b466 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/staking/meta.json @@ -0,0 +1,17 @@ +{ + "title": "Staking", + "pages": [ + "get-principal-staking-summary", + "get-principal-bond-positions", + "get-bonds", + "get-bond", + "get-bond-allowlist-entries", + "get-bond-allowlist-entry", + "get-bond-registrations", + "get-bond-registration", + "get-staking-signers", + "get-staking-signer", + "get-staking-signer-stakers" + ], + "defaultOpen": false +} diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-block-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-block-transactions.mdx new file mode 100644 index 000000000..512e0dfaa --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-block-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get block transactions +sidebarTitle: Block transactions +description: Retrieves transactions confirmed in a single block +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-balance-changes.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-balance-changes.mdx new file mode 100644 index 000000000..67b791e56 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-balance-changes.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal balance changes +sidebarTitle: Principal balance changes +description: Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-mempool-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-mempool-transactions.mdx new file mode 100644 index 000000000..a7de78925 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-mempool-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal mempool transactions +sidebarTitle: Principal mempool transactions +description: "Returns a list of pending mempool transactions that involve a principal — as the sender, a token-transfer recipient, the deployed contract, or the called contract." +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transaction-balance-changes.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transaction-balance-changes.mdx new file mode 100644 index 000000000..78feac178 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transaction-balance-changes.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal transaction balance changes +sidebarTitle: Principal transaction balance changes +description: Returns the balance changes for a principal's transaction +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transactions.mdx new file mode 100644 index 000000000..fa34630c3 --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-principal-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get principal transactions +sidebarTitle: Principal transactions +description: Returns a list of confirmed transactions sent or received by a Stacks principal, including the transaction summary, the involvement of the principal in the transaction, and the balances affected by the transaction. +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction-events.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction-events.mdx new file mode 100644 index 000000000..e524f9f4a --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transaction-events.mdx @@ -0,0 +1,12 @@ +--- +title: Get transaction events +sidebarTitle: Transaction events +description: Retrieves events for a given transaction ID +full: true +--- + + diff --git a/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transactions.mdx b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transactions.mdx new file mode 100644 index 000000000..5d34d7cec --- /dev/null +++ b/content/docs/en/apis/stacks-blockchain-api/reference/transactions/get-transactions.mdx @@ -0,0 +1,12 @@ +--- +title: Get transactions +sidebarTitle: Transactions +description: Retrieves a list of recently mined transactions +full: true +--- + +