Ordinals & Runes API
Overview
The Ordinals & Runes API is a marketplace add-on that provides access to Bitcoin Ordinals inscriptions and Runes fungible tokens. Quicknode exposes this API supporting both REST and JSON-RPC interfaces.
How to Access the Ordinals & Runes API
To enable the Ordinals & Runes API add-on on your Quicknode endpoint:
- Navigate to your Quicknode Dashboard
- Select your Bitcoin endpoint (or create a new one)
- Go to the Add-ons tab
- Find Ordinals & Runes API in the marketplace and enable it
Once enabled, the Ordinals & Runes API is accessible via your endpoint URL using the add-on path: /addon/679/
Supported Interfaces
REST API
The REST API provides a familiar HTTP interface with path parameters for querying inscriptions, runes, sats, and block data.
Base path: /addon/679/
The Accept: application/json header is required for all REST API requests.
Example:
curl -X GET \
"https://YOUR_QUICKNODE_ENDPOINT_HERE.com/addon/679/status" \
-H "Accept: application/json"
JSON-RPC API
The JSON-RPC API wraps Ordinals methods behind standard JSON-RPC calls (e.g., ord_getInscription, ord_getRune). This is useful if your application already uses JSON-RPC for other blockchain interactions.
Example:
curl -X POST \
"https://YOUR_QUICKNODE_ENDPOINT_HERE.com" \
-H "Content-Type: application/json" \
--data '{"method":"ord_getBlockHash","params":["800000"],"id":1,"jsonrpc":"2.0"}'
REST to RPC Method Mapping
| REST Endpoint | JSON-RPC Method |
|---|---|
GET /collections/{page} | ord_getCollections |
GET /content/{inscription_id} | ord_getContent |
GET /inscription/{inscription_id} | ord_getInscription |
GET /inscriptions/{page} | ord_getInscriptions |
GET /inscriptions/block/{blockheight}/{page} | ord_getInscriptionsByBlock |
GET /output/{outpoint} | ord_getOutput |
GET /r/blockhash | ord_getCurrentBlockHash |
GET /r/blockhash/{blockheight} | ord_getBlockHash |
GET /r/blockheight | ord_getCurrentBlockHeight |
GET /r/blockinfo/{blockheight} | ord_getBlockInfo |
GET /r/blocktime | ord_getCurrentBlockTime |
GET /r/children/{inscription_id}/{page} | ord_getChildren |
GET /r/inscription/{inscription_id} | ord_getInscriptionRecursive |
GET /r/metadata/{inscription_id} | ord_getMetadata |
GET /r/sat/{sat}/at/{index} | ord_getSatAtIndex |
GET /r/sat/{sat}/{page} | ord_getSatRecursive |
GET /rune/{runeid} | ord_getRune |
GET /runes/{page} | ord_getRunes |
GET /sat/{sat} | ord_getSat |
GET /status | ord_getStatus |
GET /tx/{txid} | ord_getTx |
We ❤ Feedback!
If you have any feedback or questions about this documentation, let us know. We'd love to hear from you!