Repository navigation
docs: update stacks api reference and v3 migration guide for v9.7.1 - #1160
Merged
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
rafaelcr
approved these changes
Oct 27, 2026
There was a problem hiding this comment.
🟢 Approval recommended
The documentation and navigation changes are consistent with the v9.7.1 migration scope, with no unresolved blocking issues identified.
No open issues 🎉
What changed in this PR
Updates the Stacks Blockchain API documentation for v9.7.1, guiding consumers from deprecated endpoints to their v3 replacements.
Changes:
- Adds v3 Stacks block, Bitcoin block, and principal mining references, replacing deprecated v2 block pages.
- Expands the migration guide with endpoint replacements, field mappings, and sunset exceptions.
- Clarifies staking, account, status, and fee endpoint descriptions.
Paths below are relative to content/docs/en/apis/stacks-blockchain-api/.
| File | Description |
|---|---|
v1-to-v3-migration.mdx |
Expands migration guidance through v9.7.1. |
reference/staking/get-staking-signers.mdx |
Clarifies the all-time signer registry. |
reference/staking/get-staking-signer-stakers.mdx |
Describes per-staker staking types. |
reference/staking/get-principal-staking-summary.mdx |
Points to paginated bond details. |
reference/staking/get-cycle-signers.mdx |
Refines the signer-set description. |
reference/staking/get-bond.mdx |
Explains projected bond responses. |
reference/smart-contracts/status.mdx |
Clarifies the page title. |
reference/mempool/transaction-fee-priorities.mdx |
Clarifies the mempool fee title and wording. |
reference/info/status.mdx |
Documents version and chain-tip information. |
reference/burn-blocks/meta.json |
Removes obsolete burn-block navigation. |
reference/burn-blocks/get-burn-blocks.mdx |
Removes the deprecated v2 list page. |
reference/burn-blocks/get-burn-block.mdx |
Removes the deprecated v2 detail page. |
reference/blocks/meta.json |
Switches navigation to v3 block pages. |
reference/blocks/get-stacks-blocks.mdx |
Adds the v3 block summaries reference. |
reference/blocks/get-stacks-block.mdx |
Adds the v3 block details reference. |
reference/blocks/get-blocks.mdx |
Removes the deprecated v2 list page. |
reference/blocks/get-blocks-by-burn-block.mdx |
Removes the deprecated burn-block lookup page. |
reference/blocks/get-block.mdx |
Removes the deprecated v2 detail page. |
reference/blocks/average-times.mdx |
Specifies seconds as the time unit. |
reference/bitcoin-blocks/meta.json |
Adds Bitcoin block navigation. |
reference/bitcoin-blocks/get-bitcoin-blocks.mdx |
Adds the v3 Bitcoin block list reference. |
reference/bitcoin-blocks/get-bitcoin-block.mdx |
Adds detail and future-block lookup documentation. |
reference/bitcoin-blocks/get-bitcoin-block-stacks-blocks.mdx |
Documents Stacks blocks by Bitcoin block. |
reference/accounts/meta.json |
Adds mining pages to account navigation. |
reference/accounts/get-principal-nonces.mdx |
Clarifies supported principals and confirmed transactions. |
reference/accounts/get-principal-mining-summary.mdx |
Adds lifetime matured mining totals. |
reference/accounts/get-principal-mining-rewards.mdx |
Adds individual matured reward documentation. |
reference/accounts/get-principal-balances-nft.mdx |
Documents optional asset-class filtering. |
reference/accounts/get-principal-balance-ft.mdx |
Clarifies zero-balance responses. |
Review effort: Balanced
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the Stacks Blockchain API reference in line with the v9.7.1 spec: it adds the v3 block, Bitcoin block and principal mining endpoints and removes the now-deprecated v2 block and burn-block pages. It also updates the v1 to v3 migration guide with the deprecations and new v3 replacements added from 9.4.0 through 9.7.1.