Skip to content

Commit

Permalink
GITBOOK-290: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
@BowTiedDevOps @gitbook-bot
BowTiedDevOps authored and gitbook-bot committed Feb 14, 2025
1 parent 485f4fa commit 1b0542d
Showing 1 changed file with 94 additions and 1 deletion.
95 changes: 94 additions & 1 deletion reference/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,97 @@ https://api.testnet.hiro.so/
If you run a local node, it exposes an HTTP server on port `20443`. The info endpoint would be `localhost:20443/v2/info`.
{% endhint %}

You can view the reference docs for the [Stacks RPC API](https://docs.hiro.so/stacks/api) on Hiro's documentation.


### Stacks Node RPC API endpoints

The Stacks 2.0 Blockchain API (Hiro's API) is centrally hosted. However, every running Stacks node exposes an RPC API, which allows you to interact with the underlying blockchain. Instead of using a centrally hosted API, you can directly access the RPC API of a locally hosted Node.

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/transactions" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/contracts/interface/{contract_address}/{contract_name}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/map_entry/{contract_address}/{contract_name}/{map_name}" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/contracts/source/{contract_address}/{contract_name}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/accounts/{principal}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/fees/transaction" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/fees/transfer" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/info" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/pox" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/clarity/marf/{clarity_marf_key}" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/constant_val/{contract_address}/{contract_name}/{constant_name}" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/block_proposal" method="post" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/stacker_set/{cycle_number}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/blocks/{block_id}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/blocks/height/{block_height}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/tenures/info" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/tenures/{block_id}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/sortitions/{lookup_kind}/{lookup}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/signer/{signer}/{cycle_number}" method="get" %}
[https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml](https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml)
{% endswagger %}

0 comments on commit 1b0542d

Please sign in to comment.