Skip to main content
API docs by Redocly

Ordinals API (v0.0.1)

Download OpenAPI specification:Download

A microservice that indexes Bitcoin Ordinal inscription data and exposes it via REST API endpoints.

Source Repository

Inscriptions

Endpoints to query ordinal inscriptions

Inscriptions

Retrieves a list of inscriptions with options to filter and sort results

query Parameters
Block Hash (string) or Block Height (string) (Block Identifier)
Examples:
  • genesis_block=777654 -
  • genesis_block=0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133 -

Bitcoin block identifier (height or hash)

from_genesis_block_height
string (Block Height) ^[0-9]+$
Example: from_genesis_block_height=777678

Bitcoin block height

to_genesis_block_height
string (Block Height) ^[0-9]+$
Example: to_genesis_block_height=777678

Bitcoin block height

from_genesis_timestamp
integer (Timestamp)
Example: from_genesis_timestamp=1677731361

Block UNIX epoch timestamp (milliseconds)

to_genesis_timestamp
integer (Timestamp)
Example: to_genesis_timestamp=1677731361

Block UNIX epoch timestamp (milliseconds)

from_sat_ordinal
integer (Ordinal Number) [ 0 .. 2099999997690000 )
Example: from_sat_ordinal=257418248345364

Ordinal number that uniquely identifies a satoshi

to_sat_ordinal
integer (Ordinal Number) [ 0 .. 2099999997690000 )
Example: to_sat_ordinal=257418248345364

Ordinal number that uniquely identifies a satoshi

from_sat_coinbase_height
string (Block Height) ^[0-9]+$
Example: from_sat_coinbase_height=777678

Bitcoin block height

to_sat_coinbase_height
string (Block Height) ^[0-9]+$
Example: to_sat_coinbase_height=777678

Bitcoin block height

from_number
integer (Inscription Number) >= 0
Example: from_number=10500

Inscription number

to_number
integer (Inscription Number) >= 0
Example: to_number=10500

Inscription number

output
string (Transaction Output) ^[a-fA-F0-9]{64}:[0-9]+$
Example: output=8f46f0d4ef685e650727e6faf7e30f23b851a7709714ec774f7909b3fb5e604c:0

An UTXO for a Bitcoin transaction

address
string (Address)
Example: address=bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5

Bitcoin address

mime_type
Array of strings (MIME Types)
Example: mime_type=image/png&mime_type=image/jpeg

Array of inscription MIME types

Array of Rarity (string) or Rarity (string) or Rarity (string) or Rarity (string) or Rarity (string) or Rarity (string) (Rarity)
Example: rarity=common&rarity=uncommon

Array of satoshi rarity values

offset
integer (Offset) >= 0

Result offset

limit
integer (Limit) [ 1 .. 60 ]

Results per page

Order By (string) or Order By (string) or Order By (string) (Order By)

Parameter to order results by

Order (string) or Order (string) (Order)

Results order

Responses

Response samples

Content type
application/json
{
  • "limit": 20,
  • "offset": 0,
  • "total": 1,
  • "results": [
    ]
}

Inscription

Retrieves a single inscription

path Parameters
required
Inscription ID (string) or Inscription Number (integer) (Inscription Identifier)
Examples:
  • 145000 -
  • 38c46a8bf7ec90bc7f6b797e7dc84baa97f4e5fd4286b92fe1b50176d03b18dci0 -

Inscription unique identifier (number or ID)

Responses

Response samples

Content type
application/json
{
  • "id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0",
  • "number": 248751,
  • "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
  • "genesis_address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
  • "genesis_block_height": 778921,
  • "genesis_block_hash": "0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133",
  • "genesis_tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
  • "genesis_fee": "3179",
  • "genesis_timestamp": 0,
  • "location": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218:0:0",
  • "output": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218:0",
  • "value": "546",
  • "offset": "0",
  • "sat_ordinal": "1232735286933201",
  • "sat_rarity": "common",
  • "sat_coinbase_height": 430521,
  • "mime_type": "text/plain",
  • "content_type": "text/plain;charset=utf-8",
  • "content_length": 59,
  • "timestamp": 1677733170000
}

Inscription content

Retrieves the contents of a single inscription

path Parameters
required
Inscription ID (string) or Inscription Number (integer) (Inscription Identifier)
Examples:
  • 145000 -
  • 38c46a8bf7ec90bc7f6b797e7dc84baa97f4e5fd4286b92fe1b50176d03b18dci0 -

Inscription unique identifier (number or ID)

Responses

Response samples

Content type
application/json
{ }

Satoshis

Endpoints to query Satoshi ordinal and rarity information

Satoshi Ordinal

Retrieves ordinal information for a single satoshi

path Parameters
ordinal
required
integer (Ordinal Number) [ 0 .. 2099999997690000 )
Example: 257418248345364

Ordinal number that uniquely identifies a satoshi

Responses

Response samples

Content type
application/json
{
  • "coinbase_height": 752860,
  • "cycle": 0,
  • "decimal": "752860.20444193",
  • "degree": "0°122860′892″20444193‴",
  • "inscription_id": "ff4503ab9048d6d0ff4e23def81b614d5270d341ce993992e93902ceb0d4ed79i0",
  • "epoch": 3,
  • "name": "ahehcbywzae",
  • "offset": 20444193,
  • "percentile": "91.15654869285287%",
  • "period": 373,
  • "rarity": "common"
}