Skip to main content

BRC721 REST API (1.0.0)

Download OpenAPI specification:Download

Rate limit: 120 requests/min. For higher limit, apply for API key: https://forms.gle/Jh3KbNHyTHWMmcko6

COLLECTIONS

/collections

query Parameters
cursor
string

Cursor for pagination

search
string

Search query

limit
integer [ 1 .. 100 ]

Maximum number of collections to return

Responses

Response samples

Content type
application/json
{
  • "collections": [
    ],
  • "cursor": "string"
}

/collections/{id}

path Parameters
id
required
string

Collection ID

Responses

Response samples

Content type
application/json
{
  • "blockHeight": 0,
  • "transactionIndex": 0,
  • "maxSupply": 0,
  • "maxPerAddress": 0,
  • "maxBlockHeight": 0,
  • "version": "string",
  • "name": "string",
  • "symbol": "string",
  • "paymentAddress": "string",
  • "signerPublicKey": "string",
  • "inscriberAddress": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "reindexing": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "position": 0,
  • "baseURI": "string"
}

INSCRIPTIONS

/inscriptions

query Parameters
cursor
string

The cursor ID for pagination

valid
boolean

Filter by inscription validity

collectionId
string

Filter by collection ID

inscriberAddress
string

Filter by inscriber address

initialOwnerAddress
string

Filter by initial owner address

ids
string

Comma-separated list of inscription IDs to retrieve. Max 10 IDs at a time

limit
integer
Default: 50

Maximum number of inscriptions to retrieve (default: 50)

sort
string
Default: "desc"

Sorting order ("desc" or "asc", default: "desc")

order
string
Default: "createdAt"

Sorting field ("createdAt" or "updatedAt", default: "createdAt")

Responses

Response samples

Content type
application/json
{
  • "inscriptions": [
    ],
  • "cursor": "string"
}

/inscriptions/{id}

path Parameters
id
required
string

The ID of the inscription to retrieve

Responses

Response samples

Content type
application/json
{
  • "blockHeight": 0,
  • "transactionIndex": 0,
  • "position": 0,
  • "price": 0,
  • "verificationErrors": [
    ],
  • "inscriberAddress": "string",
  • "version": "string",
  • "collectionId": "string",
  • "initialOwnerAddress": "string",
  • "id": "string",
  • "valid": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "reindexing": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "revealWeight": 0,
  • "media": {
    },
  • "tokenURI": "string"
}

BITCOIN

/bitcoin/verifymessage

Request Body schema: application/json
message
string
signature
string
address
string

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "signature": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}