Skip to content

Commit 1b0542d

Browse files
BowTiedDevOpsgitbook-bot
authored andcommitted
GITBOOK-290: No subject
1 parent 485f4fa commit 1b0542d

File tree

1 file changed

+94
-1
lines changed

1 file changed

+94
-1
lines changed

reference/api.md

+94-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,97 @@ https://api.testnet.hiro.so/
2121
If you run a local node, it exposes an HTTP server on port `20443`. The info endpoint would be `localhost:20443/v2/info`.
2222
{% endhint %}
2323

24-
You can view the reference docs for the [Stacks RPC API](https://docs.hiro.so/stacks/api) on Hiro's documentation.
24+
25+
26+
### Stacks Node RPC API endpoints
27+
28+
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.
29+
30+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/transactions" method="post" %}
31+
[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)
32+
{% endswagger %}
33+
34+
{% 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" %}
35+
[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)
36+
{% endswagger %}
37+
38+
{% 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" %}
39+
[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)
40+
{% endswagger %}
41+
42+
{% 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" %}
43+
[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)
44+
{% endswagger %}
45+
46+
{% 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" %}
47+
[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)
48+
{% endswagger %}
49+
50+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/accounts/{principal}" method="get" %}
51+
[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)
52+
{% endswagger %}
53+
54+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/fees/transaction" method="post" %}
55+
[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)
56+
{% endswagger %}
57+
58+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/fees/transfer" method="get" %}
59+
[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)
60+
{% endswagger %}
61+
62+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/info" method="get" %}
63+
[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)
64+
{% endswagger %}
65+
66+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v2/pox" method="get" %}
67+
[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)
68+
{% endswagger %}
69+
70+
{% 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" %}
71+
[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)
72+
{% endswagger %}
73+
74+
{% 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" %}
75+
[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)
76+
{% endswagger %}
77+
78+
{% 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" %}
79+
[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)
80+
{% endswagger %}
81+
82+
{% 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" %}
83+
[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)
84+
{% endswagger %}
85+
86+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/block_proposal" method="post" %}
87+
[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)
88+
{% endswagger %}
89+
90+
{% 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" %}
91+
[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)
92+
{% endswagger %}
93+
94+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/blocks/{block_id}" method="get" %}
95+
[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)
96+
{% endswagger %}
97+
98+
{% 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" %}
99+
[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)
100+
{% endswagger %}
101+
102+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/tenures/info" method="get" %}
103+
[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)
104+
{% endswagger %}
105+
106+
{% swagger src="https://raw.githubusercontent.com/stacks-network/stacks-core/refs/heads/master/docs/rpc/openapi.yaml" path="/v3/tenures/{block_id}" method="get" %}
107+
[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)
108+
{% endswagger %}
109+
110+
{% 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" %}
111+
[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)
112+
{% endswagger %}
113+
114+
{% 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" %}
115+
[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)
116+
{% endswagger %}
117+

0 commit comments

Comments
 (0)