- APIs
- Ordinals API
- Get Inscriptions
Get inscriptions
Retrieves a list of inscriptions with options to filter and sort results.
GET
Parameters
Query Parameters
genesis_block
string Bitcoin block identifier (height or hash)
from_genesis_block_height
string Bitcoin block height
to_genesis_block_height
string Bitcoin block height
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
to_sat_ordinal
integer Ordinal number that uniquely identifies a satoshi
from_sat_coinbase_height
string Bitcoin block height
to_sat_coinbase_height
string Bitcoin block height
from_number
integer Inscription number
to_number
integer Inscription number
id
array Array of inscription IDs
number
array Array of inscription numbers
output
string An UTXO for a Bitcoin transaction
address
array Array of Bitcoin addresses
genesis_address
array Array of Bitcoin addresses
mime_type
array Array of inscription MIME types
rarity
array 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
limit
integer Results per page
order_by
string Parameter to order results by
order
string Results order
Status code | Description |
---|---|
200 | Default Response |
404 | Default Response |
cURL
curl -L \"https://api.hiro.so/ordinals/v1/inscriptions?genesis_block={genesis_block}&from_genesis_block_height=777678&to_genesis_block_height=777678&from_genesis_timestamp=1677731361&to_genesis_timestamp=1677731361&from_sat_ordinal=257418248345364&to_sat_ordinal=257418248345364&from_sat_coinbase_height=777678&to_sat_coinbase_height=777678&from_number=10500&to_number=10500&id=38c46a8bf7ec90bc7f6b797e7dc84baa97f4e5fd4286b92fe1b50176d03b18dci0,e3af144354367de58c675e987febcb49f17d6c19e645728b833fe95408feab85i0&number=10500,65&output=8f46f0d4ef685e650727e6faf7e30f23b851a7709714ec774f7909b3fb5e604c:0&address=bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5,bc1pscktlmn99gyzlvymvrezh6vwd0l4kg06tg5rvssw0czg8873gz5sdkteqj&genesis_address=bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5,bc1pscktlmn99gyzlvymvrezh6vwd0l4kg06tg5rvssw0czg8873gz5sdkteqj&mime_type=image/png,image/jpeg&rarity=common,uncommon&recursive={recursive}&cursed={cursed}&offset={offset}&limit={limit}&order_by={order_by}&order={order}" \-H 'Accept: application/json'
Response
{"limit": 20,"offset": 0,"total": 1,"results": [{"id": "string","number": 0,"address": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP","genesis_address": "string","genesis_block_height": 144000,"genesis_block_hash": "string","genesis_tx_id": "string","genesis_fee": "string","genesis_timestamp": 0,"tx_id": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","location": "string","output": "string","value": "string","offset": "string","sat_ordinal": "string","sat_rarity": "string","sat_coinbase_height": 144000,"mime_type": "string","content_type": "string","content_length": 0,"timestamp": 0,"curse_type": "string","recursive": false,"recursion_refs": ["string"]}]}