Skip to content

Ordinals

Ordinals implements the GorillaPool Ordinals API as a Protocol subclass.

External docs: Ordinals API documentation

Commands

Command Method Path Response Escape hatch
get_tx GET /api/tx/{txid}/raw :raw yes
get_tx_details GET /api/tx/{txid} :json
get_tx_status GET /api/tx/{txid}/status :json
get_merkle_path GET /api/tx/{txid}/proof :raw
get_utxos GET /api/txos/address/{address}/unspent :json_array
get_balance GET /api/txos/address/{address}/balance lambda
get_spend GET /api/spends/{outpoint} :raw yes
get_chain_tip GET /api/blocks/tip :json

Escape Hatches

These commands use custom dispatch logic rather than the default HTTP template.

get_tx

Fetches the raw transaction and converts the binary response body to hex.

get_spend

Normalises the spend status response from the Ordinals API.