Hiro Docs

GET
/ordinals/v1/inscriptions

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

Query parameters

`genesis_block`Any properties in string, string

Bitcoin block identifier (height or hash)

`from_genesis_block_height`string

Bitcoin block height

Pattern: "^[0-9]+$"

`to_genesis_block_height`string

Bitcoin block height

Pattern: "^[0-9]+$"

`from_genesis_timestamp`integer

Block UNIX epoch timestamp (milliseconds)

`to_genesis_timestamp`integer

Block UNIX epoch timestamp (milliseconds)

`from_sat_ordinal`integer

Ordinal number that uniquely identifies a satoshi

Minimum: 0

`to_sat_ordinal`integer

Ordinal number that uniquely identifies a satoshi

Minimum: 0

`from_sat_coinbase_height`string

Bitcoin block height

Pattern: "^[0-9]+$"

`to_sat_coinbase_height`string

Bitcoin block height

Pattern: "^[0-9]+$"

`from_number`integer

Inscription number

`to_number`integer

Inscription number

`id`array of string

Array of inscription IDs

Example: "/ordinals/v1/inscriptions?id={inscription_id}&id={inscription_id2}"

`number`array of integer

Array of inscription numbers

`output`string

An UTXO for a Bitcoin transaction

Pattern: "^[a-fA-F0-9]{64}:[0-9]+$"

`address`array of string

Array of Bitcoin addresses

`genesis_address`array of string

Array of Bitcoin addresses

`mime_type`array of string

Array of inscription MIME types

`rarity`array of Any properties in string, string, string, string, string, string

Array of satoshi rarity values

`recursive`boolean

Whether or not the inscription is recursive

`cursed`boolean

Whether or not the inscription is cursed

`offset`integer

Result offset

Minimum: 0

`limit`integer

Results per page

Minimum: 1Maximum: 60

`order_by`Any properties in string, string, string, string

Parameter to order results by

`order`Any properties in string, string

Results order

Status code	Description
`200`	Default response
`404`	Default response

curl

curl -X GET "https://api.hiro.so/ordinals/v1/inscriptions"

Example response

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "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,
      "tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
      "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,
      "curse_type": "p2wsh",
      "recursive": true,
      "recursion_refs": [
        "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0"
      ]
    }
  ]
}

Get inscriptions

GET/ordinals/v1/inscriptions

Query parameters

genesis_blockAny properties in string, string

from_genesis_block_heightstring

to_genesis_block_heightstring

from_genesis_timestampinteger

to_genesis_timestampinteger

from_sat_ordinalinteger

to_sat_ordinalinteger

from_sat_coinbase_heightstring

to_sat_coinbase_heightstring

from_numberinteger

to_numberinteger

idarray of string

numberarray of integer

outputstring

addressarray of string

genesis_addressarray of string

mime_typearray of string

rarityarray of Any properties in string, string, string, string, string, string

recursiveboolean

cursedboolean

offsetinteger

limitinteger

order_byAny properties in string, string, string, string

orderAny properties in string, string

Schema

GET
/ordinals/v1/inscriptions

`genesis_block`Any properties in string, string

`from_genesis_block_height`string

`to_genesis_block_height`string

`from_genesis_timestamp`integer

`to_genesis_timestamp`integer

`from_sat_ordinal`integer

`to_sat_ordinal`integer

`from_sat_coinbase_height`string

`to_sat_coinbase_height`string

`from_number`integer

`to_number`integer

`id`array of string

`number`array of integer

`output`string

`address`array of string

`genesis_address`array of string

`mime_type`array of string

`rarity`array of Any properties in string, string, string, string, string, string

`recursive`boolean

`cursed`boolean

`offset`integer

`limit`integer

`order_by`Any properties in string, string, string, string

`order`Any properties in string, string