Inscriptions by Collection

This endpoint is commonly used to retrieve the list of inscriptions associated with an ordinal collection, together with their info and metadata.

get

Get inscriptions for an Ordinals collection.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

collectionIdstringRequiredExample: {"value":"wzrds"}

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · max: 25OptionalDefault: 10

Responses

200

Default Response

application/json

collectionIdstringRequired

collectionNamestringRequired

totalnumberRequired

offsetnumberRequired

limitnumberRequired

400

Invalid input

application/json

401

Unauthorized

application/json

404

Not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/v1/ordinals/collections/{collectionId}/inscriptions

HTTPcURLJavaScriptPython

GET /v1/ordinals/collections/{collectionId}/inscriptions HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "collectionId": "text",
  "collectionName": "text",
  "total": 1,
  "offset": 1,
  "limit": 1,
  "inscriptions": [
    {
      "id": "text",
      "number": 1,
      "sat": 1,
      "contentType": "text",
      "blockHeight": 1,
      "charms": [
        "text"
      ]
    }
  ]
}