search
Back to AppHelp Center

Search Inscriptions

Search millions of inscriptions for any text. Check if a hash of any data has been inscribed before.

circle-check

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 discordarrow-up-right.

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.

hashtag
Search all inscriptions for any text value

hashtag
Text Search

GET https://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 }

hashtag
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

hashtag
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":"87a1d452d2dcc89c66018a897c9910629d6c3173820979a740730e195433fd26",
         "inputindex":"0",
         "inscriptionid":"87a1d452d2dcc89c66018a897c9910629d6c3173820979a740730e195433fd26i0",
         "inscriptionnumber":"181258",
         "blockheight":"778281",
         "contentstr":"{\"p\":\"sns\",\"op\":\"reg\",\"name\":\"ordinalsbot.sats\"}",
         "contenttypestr":"text/plain;charset=utf-8",
         "contenthash":"c987a51dc14fb8e9e909b8482c1c62df246904442e851f41d6891e7af3042b23",
         "contentlength":"30",
         "metadatastr": "{\"integer\":123,\"float\":123.456,\"string\":\"hello world\",\"array\":[1,2,3],\"object\":{\"key1\":\"value1\",\"key2\":\"value2\"},\"boolean\":true,\"null\":null,\"undefined\":\"undefined\",\"byteString\":\"48656c6c6f20576f726c64\",\"taggedData\":{\"tag\":1,\"value\":\"2022-12-31T23:59:59Z\"}}",
         "createdat":"2023-03-08T21:05:16.349Z"
      }
   ]
}

hashtag
Search for an existing Image or File

Use this endpoint to check if a certain image was inscribed before. We call this a "hash check".

circle-info

Image Search is done by hashing the image file and checking against previous inscriptions' hashes.

To use this endpoint you need to sha256 hash the image file content as below:

hashtag
Search for Image

GET https://api.ordinalsbot.com/search

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

hashtag
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

hashtag
Headers

Name
Type
Description

x-api-key

String

API Key

Required if domain is not on allowlist.

hashtag
Search all inscriptions for any metadata value

hashtag
Metadata Search

GET https://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 }

hashtag
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

hashtag
Headers

Name
Type
Description

x-api-key

String

API Key

Required if domain is not on allowlist.

hashtag
Search for Inscription ID

GET https://api.ordinalsbot.com/indexer/inscription

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.

hashtag
Query Parameters

Name
Type
Description

id*

String

Inscription id i.e. 98e0f396ecff2eef7914e35a90a44e3bb7601c7071985cfacfd2d5f29c5207e7i0

hashtag
Headers

Name
Type
Description

x-api-key

String

API Key

Required if domain is not on allowlist.

PreviousCreate a Collection OrderNextCheck Rare Sats Inventory

Last updated