Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get BTC regtest or signet tokens
sidebarTitle: BTC regtest or signet tokens
description: "Sends BTC to the specified regtest or signet BTC address. The response reports the amount sent, in satoshis, and the transaction id, which you can use to view the transaction in a regtest or signet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a Bitcoin regtest/signet-only endpoint. This endpoint will not work on Bitcoin mainnet."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/faucets/btc', method: 'post' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get sBTC testnet tokens
sidebarTitle: SBTC testnet tokens
description: "Sends sBTC to the specified testnet address. The endpoint performs a SIP-010 `transfer` contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`. The response reports the amount sent, in satoshis, and the transaction id, which you can use to view the transaction in the [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/faucets/sbtc', method: 'post' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get STX testnet tokens
sidebarTitle: STX testnet tokens
description: "Sends STX to the specified testnet address. Testnet STX addresses begin with `ST`. The response reports the amount sent, in µSTX, and the transaction id, which you can use to view the transaction in the [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has been included in a block. Each request sends a fixed amount configured by the API operator, which the response reports. If you need more for testing (for example, to enroll in a staking bond), reach out to request a custom faucet transaction. **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/faucets/stx', method: 'post' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
{
"title": "Faucets",
"pages": [
"...",
"run-faucet-btc",
"run-faucet-sbtc"
],
"pages": ["get-faucet-stx", "get-faucet-btc", "get-faucet-sbtc"],
"defaultOpen": false
}

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get mempool summary
sidebarTitle: Mempool summary
description: "Retrieves a summary of the transactions currently pending in the mempool: how many there are, and the fee, size, and receipt percentiles across them, both overall and broken down by transaction type. Percentiles are discrete: each is a value some pending transaction actually has, not an interpolation between two of them."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/mempool', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
{
"title": "Mempool",
"pages": [
"...",
"get-mempool-transactions"
],
"pages": ["get-mempool-summary", "get-mempool-transactions", "transaction-fee-priorities"],
"defaultOpen": false
}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Search
sidebarTitle: Search
description: "Searches for the blocks, transactions, addresses, smart contracts, and token assets that a term refers to. The term can be a complete identifier or the beginning of one: a block or transaction hash, a Stacks or Bitcoin block height, an address, a contract id, or an asset identifier. Contract and asset names are matched anywhere in the name, so a term like `arkadiko` finds the contracts and tokens named after it. Names must contain the term; misspellings are not matched. At most 20 results are returned, best match first; there is no pagination, so narrow the term to see something that did not surface. A term that matches nothing returns an empty list rather than an error. Only canonical, mined entities are searched."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/search', method: 'get' }]}
hasHead={false}
/>

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get bond events
sidebarTitle: Bond events
description: "A bond's pox-5 event log, newest first: setup, allowlist additions, registrations and registration updates, early exits (`announce-l1-early-exit`, and `unstake-sbtc` with a `new_amount_sats` of 0), partial sBTC unstakes, reward distributions, and staker reward claims."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/staking/bonds/{bond_index}/events', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get staking cycle
sidebarTitle: Staking cycle
description: A summary of staking for one PoX reward cycle.
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/staking/cycles/{cycle_number}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get network staking reward totals
sidebarTitle: Network staking reward totals
description: Get the total Bitcoin generated by staking on the Stacks network across all history, along with the total BTC burned by block commits. Values are in satoshis and always reflect the latest ingested chain state.
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/staking/rewards', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@
"get-bond-allowlist-entry",
"get-bond-registrations",
"get-bond-registration",
"get-bond-events",
"get-staking-cycle",
"get-cycle-signers",
"get-staking-signers",
"get-staking-signer",
"get-staking-signer-stakers"
"get-staking-signer-stakers",
"get-staking-rewards"
],
"defaultOpen": false
}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Get a batch of transactions
sidebarTitle: Batch of transactions
description: "Retrieves the summaries of up to 20 mined transactions in a single call, given their transaction ids. Provide them as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). Results are returned in canonical chain order (newest first), not in the order the ids were supplied. Only transactions mined in the canonical chain are returned: an id that is unknown, non-canonical, or still in the mempool is absent from `results` rather than reported as an error, so compare the response against the ids you sent to find the ones that did not resolve. Use `GET /extended/v3/transactions/{tx_id}` for a single transaction, which also covers mempool transactions."
full: true
---

<APIPage
document="./openapi/stacks-blockchain-api.json"
operations={[{ path: '/extended/v3/transactions/batch', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"title": "Transactions",
"pages": [
"statistics-for-mempool-transactions",
"details-for-transactions",
"get-transactions-batch",
"get-block-transactions",
"get-principal-transactions",
"get-principal-transaction-balance-changes",
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ touched this principal" and "what changed for this principal".
For the FT and NFT detail that v1 packed into `stx_transfers` / `ft_transfers` / `nft_transfers`,
call `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes`, or fetch
several transactions at once with
`GET /extended/v3/principals/{principal}/balance-changes?tx_id=A,B,C` (up to 50 IDs).
`GET /extended/v3/principals/{principal}/balance-changes?tx_id=A,B,C` for several IDs in one call.

Each balance change is `{ asset: { type, identifier? }, balance_change: { sent, received, net } }`,
where `type` is `stx`, `ft`, or `nft`.
Expand Down
Loading