Introduction
In order to use the Ordiscan API you first need to create an account and obtain an API key.
Your API key is used to authenticate all your requests to the Ordiscan API. You need to pass it as a Bearer token in the "Authorization" header:
Example request:
curl -G https://ordiscan.com/v1/inscription \
-H "Authorization: Bearer {token}" \
-d id="b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0"
Limits:
Free plan
200 requests / month
100 requests / min
Standard plan
1M requests / month
100 requests / min
Inscription Info
Properties
- Name
inscription_id
- Type
- string
- Description
Unique identifier for the inscription.
- Name
inscription_number
- Type
- number
- Description
The inscription number.
- Name
content_type
- Type
- string
- Description
The inscription content type.
- Name
owner_address
- Type
- string
- Description
The current owner of the inscription (Bitcoin address)
- Name
owner_output
- Type
- string
- Description
The current tx output associated with the inscription
- Name
genesis_address
- Type
- string
- Description
The initial owner of the inscription (Bitcoin address)
- Name
genesis_output
- Type
- string
- Description
The initial tx output associated with the inscription
- Name
timestamp
- Type
- string
- Description
A datetime string for when the inscription was created
- Name
content_url
- Type
- string
- Description
URL to the inscription content (can be a text file, image, video, etc.)
- Name
submodules
- Type
- string array (optional)
- Description
If it's a recursive inscription, this will return a list of inscription IDs that are being used as modules to generate the recursive inscription
- Name
sats_name
- Type
- string (optional)
- Description
The sats name (e.g.
tristan.sats
) registered through this inscription (if the inscription is identified as a sats name)
- Name
brc20_action
- Type
- object (optional)
- Description
Experimental! A BRC-20 Action object (if the inscription has been identified as a BRC-20 action)
Get inscription info
Retrieve the info for a specific inscription. You need to supply either an inscription ID (id
) or an inscription number (number
) as a query parameter.
Parameters
One of the following must be supplied:
- Name
id
- Type
- string
- Description
The inscription ID (e.g.
b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0
)
- Name
number
- Type
- integer
- Description
The inscription number (e.g.
224530
)
curl -G https://ordiscan.com/v1/inscription \
-H "Authorization: Bearer {token}" \
-d id="b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0"
{
"data": {
"inscription_id": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
"inscription_number": 348020,
"content_type": "text/plain;charset=utf-8",
"owner_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
"owner_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0",
"genesis_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
"genesis_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0",
"timestamp": "2023-03-08T04:16:31.000Z",
"content_url": "https://ordiscan.com/content/b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
"brc20_action": {
"tick": "ORDI",
"action": "deploy"
}
}
}
Get list of inscriptions
Retrieve a list of inscriptions based on different filters. The max number of inscriptions returned per request is 100.
Parameters
- Name
address
- Type
- string (optional)
- Description
A valid Bitcoin address. Specify this to only return inscriptions owned by this address.
- Name
content_type
- Type
- string (optional)
- Description
Filter the inscriptions by content type (e.g.
text/plain
,image/jpeg
...). You can specify multiple content types by separating them with a comma (,
).
- Name
sort
- Type
- string (optional)
- Description
Specify the sorting order for the returned inscriptions. Can be either:
inscription_number_desc
(default). Sorts by descending inscription number.inscription_number_asc
. Sorts by ascending inscription number.
- Name
afterNumber
- Type
- integer (optional)
- Description
Only return inscriptions above a certain inscription number. Useful for pagination.
- Name
beforeNumber
- Type
- integer (optional)
- Description
Only return inscriptions below a certain inscription number. Useful for pagination.
curl -G https://ordiscan.com/v1/inscriptions \
-H "Authorization: Bearer {token}" \
-d address="112AmK5SB2uT7miUTqjLrcRJB7myLBM7xu"
{
"data": [
{
"inscription_id": "1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0",
"inscription_number": 1523361,
"content_type": "text/plain;charset=utf-8",
"owner_address": "112AmK5SB2uT7miUTqjLrcRJB7myLBM7xu",
"owner_output": "71c28a89a7898f3c667f6f68022d263eb96afa283d6ed4cb900bd204638d7883:0",
"timestamp": "2023-04-23T21:48:00.000Z",
"content_url": "https://ordiscan.com/content/1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0",
"brc20_action": {
"tick": "PEPE",
"amount": 0,
"action": "transfer"
}
}
]
}
Address Activity
Properties
- Name
txid
- Type
- string
- Description
The TXID (Transaction ID) of the transaction
- Name
type
- Type
- string
- Description
The type of activity. Can be one of the following:
SEND
: the address sent an inscription to another addressRECEIVE
: the address received an inscription from another addressINSCRIBE
: the address created (and received) a new inscription
- Name
inscription_id
- Type
- string
- Description
Unique identifier for the inscription.
- Name
counterpart_address
- Type
- string
- Description
The Bitcoin address of the counterpart (if the activity is a
SEND
orRECEIVE
)
- Name
spent_as_fee
- Type
- boolean
- Description
Whether the inscription was spent as a fee (if the activity is a
SEND
)
- Name
timestamp
- Type
- string
- Description
A datetime string for when the inscription was created
Get address activity
Retrieve all Ordinals-related activity for a specific Bitcoin address.
Parameters
- Name
address
- Type
- string
- Description
A valid Bitcoin address
curl -G https://ordiscan.com/v1/activity \
-H "Authorization: Bearer {token}" \
-d address="112AmK5SB2uT7miUTqjLrcRJB7myLBM7xu"
{
"data": [
{
"txid": "71c28a89a7898f3c667f6f68022d263eb96afa283d6ed4cb900bd204638d7883",
"type": "RECEIVE",
"inscription_id": "1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0",
"counterpart_address": "bc1qmjru4ce5xuma66lsmw2pv38wv9nscq9nxmwkv9",
"spent_as_fee": false,
"timestamp": "2023-04-23T21:48:00.000Z"
}
]
}