๐ JSON-RPC
Code samples
POST /api/v1/btc/jsonrpc
Proxies any valid Bitcoin JSON-RPC 1.0 request to the configured BTC node. The request body is forwarded as-is and the node's response is returned.
Body parameter
{
"jsonrpc": "1.0",
"method": "getblockchaininfo",
"params": [
null
]
}
๐ ๏ธ Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
Example responses
200 Response
{}
500 Response
{
"error": {
"code": -32603,
"message": "Failed to connect to BTC node"
}
}
502 Response
{
"error": {
"code": -32603,
"message": "Failed to connect to BTC node"
}
}
๐ Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | JSON-RPC response from BTC node | Inline |
| 500 | Internal Server Error | BTC node URL or credentials are not configured | Inline |
| 502 | Bad Gateway | Failed to connect to BTC node | Inline |
๐ Response Schema
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ยป error | object | false | none | none |
| ยปยป code | integer | false | none | none |
| ยปยป message | string | false | none | none |
Status Code 502
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ยป error | object | false | none | none |
| ยปยป code | integer | false | none | none |
| ยปยป message | string | false | none | none |