{ "openapi": "3.0.0", "info": { "title": "BCH Blockbook API", "description": "Get access to balances, transactions, and UTXOs for addresses or xpubs. Adds 10 new methods via JSON-RPC and REST..", "version": "1.0.0", "contact": { "email": "support@quicknode.com", "url": "https://support.quicknode.com/" } }, "servers": [ { "url": "https://{quicknode_endpoint}", "description": "Your Quicknode endpoint", "variables": { "quicknode_endpoint": { "default": "your-endpoint.quiknode.pro", "description": "Your Quicknode endpoint URL" } } } ], "tags": [ { "name": "REST API", "description": "endpoints for the add-on" }, { "name": "JSON-RPC", "description": "See request body examples for the available methods you can call on this add-on" } ], "paths": { "/addon/1118/api/v2/address/{address}": { "get": { "summary": "Returns balances and transactions of an address. The returned transactions are sorted by block height, newest blocks first.", "description": "Returns balances and transactions of an address. The returned transactions are sorted by block height, newest blocks first.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1000" }, { "name": "fromHeight", "in": "query", "required": false, "schema": { "type": "string" }, "example": "0" }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string" }, "example": "txids" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/block-index/{block_height}": { "get": { "summary": "Returns the hash of the block at the given height.", "description": "Returns the hash of the block at the given height.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "block_height", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/tx-specific/{txid_specific}": { "get": { "summary": "Returns transaction data in the exact format as returned by backend.", "description": "Returns transaction data in the exact format as returned by backend.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "txid_specific", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/tickers-list": { "get": { "summary": "Returns a list of available currency rate tickers (secondary currencies) for the specified date, along with an actual data timestamp.", "description": "Returns a list of available currency rate tickers (secondary currencies) for the specified date, along with an actual data timestamp.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1574346615" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/tickers": { "get": { "summary": "Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the next closest rate will be returned. All responses contain an actual rate timestamp.", "description": "Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the next closest rate will be returned. All responses contain an actual rate timestamp.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1574346615" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/balancehistory/{xpub_or_address}": { "get": { "summary": "Returns a balance history for the specified XPUB or address.", "description": "Returns a balance history for the specified XPUB or address.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "xpub_or_address", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1683684000" }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1700042400" }, { "name": "fiatcurrency", "in": "query", "required": false, "schema": { "type": "string" }, "example": "usd" }, { "name": "groupBy", "in": "query", "required": false, "schema": { "type": "string" }, "example": "3600" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/xpub/{xpub}": { "get": { "summary": "Returns balances and transactions of an xpub or output descriptor.", "description": "Returns balances and transactions of an xpub or output descriptor.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "xpub", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1000" }, { "name": "fromHeight", "in": "query", "required": false, "schema": { "type": "string" }, "example": "0" }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string" }, "example": "txids" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/utxo/{xpub_or_address}": { "get": { "summary": "Returns array of unspent transaction outputs of address or xpub. By default, the list contains both confirmed and unconfirmed transactions. The option { confirmed: true } disables return of unco...", "description": "Returns array of unspent transaction outputs of address or xpub. By default, the list contains both confirmed and unconfirmed transactions. The option { confirmed: true } disables return of unco...", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "xpub_or_address", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" }, { "name": "confirmed", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/tx/{txid}": { "get": { "summary": "Returns transaction object for txHash.", "description": "Returns transaction object for txHash.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/addon/1118/api/v2/block/{block}": { "get": { "summary": "Returns the block data with transaction objects.", "description": "Returns the block data with transaction objects.", "externalDocs": { "url": "https://github.com/trezor/blockbook/blob/master/docs/api.md" }, "parameters": [ { "name": "block", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "tags": [ "REST API" ] } }, "/rpc": { "post": { "summary": "JSON-RPC methods for https://blockbook-json-rpc.quicknode.com/rpc", "description": "Available methods:\n• bb_getTxSpecific: Returns transaction data in the exact format as returned by backend.\n• bb_getTickersList: Returns a list of available currency rate tickers (secondary currencies) for the specified date, along with an actual data timestamp.\n• bb_getTx: bb_getTx(txHash) Returns transaction object for txHash.\n• bb_getBlock: bb_getBlock(block_hash_or_height) Returns the block data with transaction objects.\n• bb_getBlockHash: Returns the hash of the block at the given height.\n• bb_getTickers: Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the next closest rate will be returned. All responses contain an actual rate timestamp.\n• bb_getXPUB: bb_getXPUB(xpub_or_descriptor, options_object)Returns balances and transactions of an xpub or output descriptor.\n• bb_getBalanceHistory: Returns a balance history for the specified XPUB or address.\n• bb_getUTXOs: bb_getUTXOs(address_or_xpub_or_descriptor, options_object)Returns array of unspent transaction outputs of address or xpub. By default, the list contains both confirmed and unconfirmed transactions. The option { confirmed: true } disables return of unconfirmed transactions.\n• bb_getAddress: bb_getAddress(address, options_object)Returns balances and transactions of an address. The returned transactions are sorted by block height, newest blocks first.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getTxSpecific" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "1019fac3daa5e0d1383b33f7da00ca2269a770c6b2b1de2bd04e8cead3bc3ca9" ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getTickersList" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ { "timestamp": 1574346615 } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getTx" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "1019fac3daa5e0d1383b33f7da00ca2269a770c6b2b1de2bd04e8cead3bc3ca9" ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getBlock" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "000000000000000000f746f35524e7a9861e06f3c1199c733ff213379c94a31b", { "page": 1 } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getBlockHash" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "816884" ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getTickers" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ { "timestamp": 1574346615 } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getXPUB" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL", { "page": 1, "size": 1000, "fromHeight": 0, "details": "txids" } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getBalanceHistory" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "bitcoincash:qzf9ax7we6swngffah3e9gr4mgh0qw3zcy6kq5afau", { "from": "1672531200", "to": "1757280000", "fiatcurrency": "usd", "groupBy": 86400 } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getUTXOs" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "bitcoincash:qzf9ax7we6swngffah3e9gr4mgh0qw3zcy6kq5afau", { "confirmed": true } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "method": { "type": "string", "enum": [ "bb_getAddress" ] }, "id": { "type": "integer", "example": 1 }, "params": { "type": "array", "description": "Positional parameters", "items": { "description": "Parameter value (can be string, number, boolean, object, etc.)" }, "example": [ "bc1p72h09wplu60qdxyr8q3ftgdhga7jxnjhdz08qs4u9we9q3lzmqmqa4yzj6", { "page": 1, "size": 1000, "fromHeight": 0, "details": "txids" } ] } }, "required": [ "jsonrpc", "method", "id", "params" ] } ], "discriminator": { "propertyName": "method" } }, "examples": { "bb_getTxSpecific": { "summary": "Returns transaction data in the exact format as returned by backend.", "value": { "jsonrpc": "2.0", "method": "bb_getTxSpecific", "id": 1, "params": [ "1019fac3daa5e0d1383b33f7da00ca2269a770c6b2b1de2bd04e8cead3bc3ca9" ] } }, "bb_getTickersList": { "summary": "Returns a list of available currency rate tickers (secondary currencies) for the specified date, along with an actual data timestamp.", "value": { "jsonrpc": "2.0", "method": "bb_getTickersList", "id": 1, "params": [ { "timestamp": 1574346615 } ] } }, "bb_getTx": { "summary": "bb_getTx(txHash) Returns transaction object for txHash.", "value": { "jsonrpc": "2.0", "method": "bb_getTx", "id": 1, "params": [ "1019fac3daa5e0d1383b33f7da00ca2269a770c6b2b1de2bd04e8cead3bc3ca9" ] } }, "bb_getBlock": { "summary": "bb_getBlock(block_hash_or_height) Returns the block data with transaction objects.", "value": { "jsonrpc": "2.0", "method": "bb_getBlock", "id": 1, "params": [ "000000000000000000f746f35524e7a9861e06f3c1199c733ff213379c94a31b", { "page": 1 } ] } }, "bb_getBlockHash": { "summary": "Returns the hash of the block at the given height.", "value": { "jsonrpc": "2.0", "method": "bb_getBlockHash", "id": 1, "params": [ "816884" ] } }, "bb_getTickers": { "summary": "Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the next closest rate will be returned. All responses contain an actual rate timestamp.", "value": { "jsonrpc": "2.0", "method": "bb_getTickers", "id": 1, "params": [ { "timestamp": 1574346615 } ] } }, "bb_getXPUB": { "summary": "bb_getXPUB(xpub_or_descriptor, options_object)Returns balances and transactions of an xpub or output descriptor.", "value": { "jsonrpc": "2.0", "method": "bb_getXPUB", "id": 1, "params": [ "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL", { "page": 1, "size": 1000, "fromHeight": 0, "details": "txids" } ] } }, "bb_getBalanceHistory": { "summary": "Returns a balance history for the specified XPUB or address.", "value": { "jsonrpc": "2.0", "method": "bb_getBalanceHistory", "id": 1, "params": [ "bitcoincash:qzf9ax7we6swngffah3e9gr4mgh0qw3zcy6kq5afau", { "from": "1672531200", "to": "1757280000", "fiatcurrency": "usd", "groupBy": 86400 } ] } }, "bb_getUTXOs": { "summary": "bb_getUTXOs(address_or_xpub_or_descriptor, options_object)Returns array of unspent transaction outputs of address or xpub. By default, the list contains both confirmed and unconfirmed transactions. The option { confirmed: true } disables return of unconfirmed transactions.", "value": { "jsonrpc": "2.0", "method": "bb_getUTXOs", "id": 1, "params": [ "bitcoincash:qzf9ax7we6swngffah3e9gr4mgh0qw3zcy6kq5afau", { "confirmed": true } ] } }, "bb_getAddress": { "summary": "bb_getAddress(address, options_object)Returns balances and transactions of an address. The returned transactions are sorted by block height, newest blocks first.", "value": { "jsonrpc": "2.0", "method": "bb_getAddress", "id": 1, "params": [ "bc1p72h09wplu60qdxyr8q3ftgdhga7jxnjhdz08qs4u9we9q3lzmqmqa4yzj6", { "page": 1, "size": 1000, "fromHeight": 0, "details": "txids" } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "description": "Method result" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": { "description": "Additional error data" } } } }, "required": [ "jsonrpc", "id" ] } } } } }, "externalDocs": { "url": "https://www.quicknode.com/docs/bitcoincash/bb_gettxspecific", "description": "Documentation: bb_getTxSpecific: https://www.quicknode.com/docs/bitcoincash/bb_gettxspecific, bb_getTickersList: https://www.quicknode.com/docs/bitcoincash/bb_gettickerslist, bb_getTx: https://www.quicknode.com/docs/bitcoincash/bb_gettx, bb_getBlock: https://www.quicknode.com/docs/bitcoincash/bb_getblock, bb_getBlockHash: https://www.quicknode.com/docs/bitcoincash/bb_getblockhash, bb_getTickers: https://www.quicknode.com/docs/bitcoincash/bb_gettickers, bb_getXPUB: https://www.quicknode.com/docs/bitcoincash/bb_getxpub, bb_getBalanceHistory: https://www.quicknode.com/docs/bitcoincash/bb_getbalancehistory, bb_getUTXOs: https://www.quicknode.com/docs/bitcoincash/bb_getutxos, bb_getAddress: https://www.quicknode.com/docs/bitcoincash/bb_getaddress" }, "tags": [ "JSON-RPC" ] } } }, "externalDocs": { "description": "Support Documentation", "url": "https://support.quicknode.com/" } }