Hiro Docs

GET

/ordinals/v1/inscriptions

List of Inscriptions

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

Query Parameters

`genesis_block`Block Identifier

Bitcoin block identifier (height or hash)

`from_genesis_block_height`Block Height

Bitcoin block height

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

`to_genesis_block_height`Block Height

Bitcoin block height

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

`from_genesis_timestamp`Timestamp

Block UNIX epoch timestamp (milliseconds)

`to_genesis_timestamp`Timestamp

Block UNIX epoch timestamp (milliseconds)

`from_sat_ordinal`Ordinal Number

Ordinal number that uniquely identifies a satoshi

Minimum: 0

`to_sat_ordinal`Ordinal Number

Ordinal number that uniquely identifies a satoshi

Minimum: 0

`from_sat_coinbase_height`Block Height

Bitcoin block height

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

`to_sat_coinbase_height`Block Height

Bitcoin block height

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

`from_number`Inscription Number

Inscription number

`to_number`Inscription Number

Inscription number

`id`Inscription IDs

Array of inscription IDs

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

`number`Inscription Numbers

Array of inscription numbers

`output`Transaction Output

An UTXO for a Bitcoin transaction

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

`address`Addresses

Array of Bitcoin addresses

`genesis_address`Addresses

Array of Bitcoin addresses

`mime_type`MIME Types

Array of inscription MIME types

`rarity`Rarity

Array of satoshi rarity values

`recursive`Recursive

Whether or not the inscription is recursive

`cursed`Cursed

Whether or not the inscription is cursed

`offset`Offset

Result offset

Minimum: 0

`limit`Limit

Results per page

Minimum: 1Maximum: 60

`order_by`Order By

Parameter to order results by

`order`Order

Results order

Status code	Description
`200`	Default Response
`404`	Default Response

curl -X GET "https://api.hiro.so/ordinals/v1/inscriptions?genesis_block=0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133&from_genesis_block_height=string&to_genesis_block_height=string&from_genesis_timestamp=0&to_genesis_timestamp=0&from_sat_ordinal=2099999997689999&to_sat_ordinal=2099999997689999&from_sat_coinbase_height=string&to_sat_coinbase_height=string&from_number=0&to_number=0&id=%5B%0A++%2238c46a8bf7ec90bc7f6b797e7dc84baa97f4e5fd4286b92fe1b50176d03b18dci0%22%0A%5D&number=%5B%0A++%2210500%22%0A%5D&output=string&address=%5B%0A++%22bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5%22%0A%5D&genesis_address=%5B%0A++%22bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5%22%0A%5D&mime_type=%5B%0A++%22image%2Fpng%22%0A%5D&rarity=%5B%0A++%22uncommon%22%0A%5D&recursive=true&cursed=true&offset=0&limit=1&order_by=number&order=asc"

{
  "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

List of Inscriptions

Query Parameters

genesis_blockBlock Identifier

from_genesis_block_heightBlock Height

to_genesis_block_heightBlock Height

from_genesis_timestampTimestamp

to_genesis_timestampTimestamp

from_sat_ordinalOrdinal Number

to_sat_ordinalOrdinal Number

from_sat_coinbase_heightBlock Height

to_sat_coinbase_heightBlock Height

from_numberInscription Number

to_numberInscription Number

idInscription IDs

numberInscription Numbers

outputTransaction Output

addressAddresses

genesis_addressAddresses

mime_typeMIME Types

rarityRarity

Rarity

recursiveRecursive

cursedCursed

offsetOffset

limitLimit

order_byOrder By

orderOrder

Query

Response

Typescript

`genesis_block`Block Identifier

`from_genesis_block_height`Block Height

`to_genesis_block_height`Block Height

`from_genesis_timestamp`Timestamp

`to_genesis_timestamp`Timestamp

`from_sat_ordinal`Ordinal Number

`to_sat_ordinal`Ordinal Number

`from_sat_coinbase_height`Block Height

`to_sat_coinbase_height`Block Height

`from_number`Inscription Number

`to_number`Inscription Number

`id`Inscription IDs

`number`Inscription Numbers

`output`Transaction Output

`address`Addresses

`genesis_address`Addresses

`mime_type`MIME Types

`rarity`Rarity

`recursive`Recursive

`cursed`Cursed

`offset`Offset

`limit`Limit

`order_by`Order By

`order`Order