As of January 2024, access to search endpoints are restricted to API Keys and allowlisted domains, if you need access to these endpoints please reach out to us on .
All results are as sorted earliest first by inscription numbers, so they can be used to check which inscription is first for a certain hash.
Search all inscriptions for any text value
Text Search
GEThttps://api.ordinalsbot.com/search
You can search for any text string against all existing inscriptions.
Pagination options can be specified by adding itemsPerPage and page
values in the query parameters. Response provides an array of results as well as information on current page, total page numbers and total items available for the search criteria.
Response structure:
{
results: [{},{},{},{}], // array of restults
count: 0, // number of Ordinals in the current results array
currentPage: page, // current page number
totalPages: 0, // total pages that can be returned for the current search criteria
totalItems: 0 // total items in the database for the current search criteria
}
Query Parameters
Name
Type
Description
text*
String
The text you want to search
Note: text field can also accept a list of comma separated strings such that it will do a search where ALL of these strings exist in the inscription content.
?text=some,random,words
page
Number
The page number in the list of pages to return by default the first page is returned
itemsPerPage
Number
The number of iterms to return in each page, this defaults to 100
Check for previous occurrences of an image in inscriptions. Results array will be sorted by ascending block height.
Pagination parameters are the same as text search
Query Parameters
Name
Type
Description
hash*
String
sha256 hash of an image buffer in hex
page
Number
The page number in the list of pages to return by default the first page is returned
itemsPerPage
Number
The number of iterms to return in each page, this defaults to 100
Headers
Name
Type
Description
x-api-key
String
API Key
Required if domain is not on allowlist.
{
"status":"ok",
"count": 1,
"currentPage": 3,
"totalPages": 3,
"totalItems": 102
"itemsPerPage": 100,
"results":
[
{
"txid":"ea0d...a8",
"inputindex":"0",
"inscriptionid":"ea0d....8i0",
"blockheight":"775528", // use blockheight as timestamp
"contenttypestr":"image/png",
"contenthash":"59edca9...a9ca4c80d",
"contentlength":"217",
"createdat":"2023-03-08T16:30:38.690Z" // this is when record is parsed - not the block timestamp
},
...
]
}
{
status: 'error',
error: 'error reason'
}
{
status: 'error',
reason: 'server error'
}
Search all inscriptions for any metadata value
Metadata Search
GEThttps://api.ordinalsbot.com/indexer/metadata
You can search for any text inside metadata fields of all existing inscriptions.
Pagination options can be specified by adding itemsPerPage and page
values in the query parameters. Response provides an array of results as well as information on current page, total page numbers and total items available for the search criteria.
Response structure:
{
results: [{},{},{},{}], // array of restults
count: 0, // number of Ordinals in the current results array
currentPage: page, // current page number
totalPages: 0, // total pages that can be returned for the current search criteria
totalItems: 0 // total items in the database for the current search criteria
}
Query Parameters
Name
Type
Description
text*
String
The text you want to search inside metadata fields of all inscriptions.
This can be a list of strings separated by comma if you want to search for multiple strings at once (AND search) i.e.:
?text=donot,trust,verify
page
Number
The page number in the list of pages to return by default the first page is returned
itemsPerPage
Number
The number of iterms to return in each page, this defaults to 100
Check for an inscription in our indexer. This endpoint allows you to see if an inscription is indexed by our indexer and will return content hash and content string.
Query Parameters
Name
Type
Description
id*
String
Inscription id i.e. 98e0f396ecff2eef7914e35a90a44e3bb7601c7071985cfacfd2d5f29c5207e7i0
