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,13 @@
---
title: Block by height (v3)
sidebarTitle: Block by height (v3)
description: Retrieves a block by its height using the v3 endpoint.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/blocks/height/{block_height}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
"recent-blocks",
"block-by-hash",
"block-by-height",
"block-by-height-v3",
"block-by-burn-block-hash",
"block-by-burn-block-height",
"block-proposal"
"block-proposal",
"upload-block"
],
"defaultOpen": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Upload block
sidebarTitle: Upload block
description: Upload a block to the node.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/blocks/upload', method: 'post' }]}
hasHead={false}
/>
13 changes: 13 additions & 0 deletions content/docs/apis/stacks-blockchain-api/reference/info/health.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Health check
sidebarTitle: Health
description: Get health information about the node's synchronization status.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/health', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"pages": [
"status",
"core-api",
"health",
"network-block-time",
"network-given-block-time",
"total-and-unlocked-stx-supply",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"pages": [
"nakamoto-block",
"tenure-blocks",
"tenure-metadata"
"tenure-metadata",
"tenure-fork-info",
"tenure-tip"
],
"defaultOpen": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Tenure fork info
sidebarTitle: Tenure fork info
description: Get information about tenure forks between two block IDs.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/tenures/fork_info/{start}/{stop}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Tenure tip
sidebarTitle: Tenure tip
description: Get the tip block ID of the tenure associated with a given consensus hash.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/tenures/tip/{consensus_hash}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"cycle",
"signers-in-cycle",
"signer-in-cycle",
"signer-details",
"stackers-for-signer-in-cycle",
"pox-details",
"stacker-set"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Signer details
sidebarTitle: Signer details
description: Get signer information for a specific signer and cycle.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/signer/{signer_pubkey}/{cycle_number}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Fast call read-only function
sidebarTitle: Fast call read-only
description: Call a read-only function on a smart contract without cost and memory tracking for faster execution.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/contracts/fast-call-read/{contract_address}/{contract_name}/{function_name}', method: 'post' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
"interface",
"map-entry",
"read-only",
"fast-read-only",
"events",
"constants",
"traits"
],
"defaultOpen": false
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Get sortitions
sidebarTitle: Get sortitions
description: Retrieves information about sortitions from the burnchain.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/sortitions', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Latest and last sortitions
sidebarTitle: Latest and last sortitions
description: Retrieves information about the latest and last sortitions.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/sortitions/latest_and_last', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"title": "Sortitions",
"pages": [
"get-sortitions",
"sortition-by-burn-hash",
"sortition-by-burn-height",
"sortition-by-consensus-hash",
"latest-and-last-sortitions"
],
"defaultOpen": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Sortition by burn hash
sidebarTitle: Sortition by burn hash
description: Retrieves information about a sortition by its burn block hash.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/sortitions/burn/{burn_header_hash}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Sortition by burn height
sidebarTitle: Sortition by burn height
description: Retrieves information about a sortition by its burn block height.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/sortitions/burn_height/{height}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Sortition by consensus hash
sidebarTitle: Sortition by consensus hash
description: Retrieves information about a sortition by its consensus hash.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/sortitions/consensus/{consensus_hash}', method: 'get' }]}
hasHead={false}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"recent-transactions",
"get-transaction",
"get-raw-transaction",
"transaction-details-v3",
"address-transactions",
"transactions-by-block",
"events-for-an-address-transaction",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Transaction details (v3)
sidebarTitle: Transaction details (v3)
description: Get transaction details by transaction ID using the v3 endpoint.
full: true
isRpc: true
---

<APIPage
document="./openapi/stacks-node-rpc-api.json"
operations={[{ path: '/v3/transaction/{txid}', method: 'get' }]}
hasHead={false}
/>