Public APIs
GorillaPool maintains a public 1sat-server
Basic usage is documented below. See the auto-generated swagger documentation for a complete API reference.
The API is also available on Github.
Other APIs
There is also basic support from What's On Chain
The BMAP API can be used to resolve inscriptions with support for several other data protocols.
1SAT Server Endpoints
Get Files, Inscriptions
Get inscription file for a given origin.
Sample response
Get Inscriptions
Get inscription data for a given origin.
Get inscriptions for a given txid.
Sample response
Get Ordinal Utxos
Because ordinals exist in Bitcoin Script, . Get unspent utxos with ordinal locks matching a given address.
Sample response
You can also get inscriptions for UTXOs in a single request
Get Lock Utxos
Get unspent outputs for a given "lock", which is the scripthash of the locking script up to the point of an inscription.
Returns UTXOs:
Address Events - SSE
SSE endpoints are available for real-time mempool tx notifications. Watch multiple addresses or locking script hashes simultaneously, and get notified when a transaction occurs matching. Add query param address
for each address you want to monitor, and lock
for each script hash.
You will receive both new Inscription UTXOs AND spends from the same messages. If the spend
field is not null
, that means you have received a spend, and you should remove the UTXO identified by txid
:vout
from your UTXO set.
If the spend field is null
, then this is a new Inscription in your wallet.
Listening for ordinal address activity:
What's On Chain
WhatsOnChain.com also provides 1Sat Ordinals support by tagging the inscriptions and providing a plugin for rending ordinals by txid and outpout index as follows:
BMAP API
Get a BMAP Transaction object as a formatted JSON string
or non-formatted bmap
raw transaction hex
or BOB format
Last updated