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
8 changes: 8 additions & 0 deletions docs/reference/.gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@ redirects:
example-contracts/bns: clarity/example-contracts/bns.md
example-contracts/multi-send: clarity/example-contracts/multi-send.md
example-contracts/stacking: clarity/example-contracts/stacking.md

# Stacks Blockchain API pages removed when the section moved to Hiro's spec (node RPC tags)
api/stacks-blockchain-api/mining: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/signers: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/atlas: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/stacker-db: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/fees: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/models: api/stacks-blockchain-api/README.md
15 changes: 2 additions & 13 deletions docs/reference/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,18 @@
* [Pagination](api/stacks-blockchain-api/pagination.md)
* [Nonce Handling](api/stacks-blockchain-api/nonce-handling.md)
* [Requesting Proofs](api/stacks-blockchain-api/requesting-proofs.md)
* ```yaml
props:
models: true
downloadLink: false
type: builtin:openapi
dependencies:
spec:
ref:
kind: openapi
spec: stacks-blockchain-api-dereferenced
```
* ```yaml
props:
models: false
downloadLink: false
grouping: by-tag
type: builtin:openapi
dependencies:
spec:
ref:
kind: openapi
spec: bitcoin-staking
spec: stacks-blockchain-api
```
* [Bitcoin Staking](api/stacks-blockchain-api/bitcoin-staking.md)
* [Stacks Mesh API](api/stacks-mesh-api/README.md)
* ```yaml
props:
Expand Down
64 changes: 64 additions & 0 deletions docs/reference/api/stacks-blockchain-api/bitcoin-staking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: Endpoints for PoX-5 Bitcoin Staking positions, bonds, cycles, rewards and signers.
---

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/principals/{principal}/staking" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/principals/{principal}/staking/bonds" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/events" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/allowlist" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/allowlist/{principal}" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/registrations" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/registrations/{principal}" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/cycles/{cycle_number}" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/cycles/{cycle_number}/signers" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/rewards" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers/{principal}" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers/{principal}/stakers" method="get" %}
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
{% endopenapi-operation %}

Loading