Skip to content

/bcmr Endpoints

Base URL: /bcmr

Available Endpoints

/token/<category>

Endpoint: GET /token/<category>

Status: Stable

Description: Fetches BCMR data for token from on-chain registry.

  • category: Token ID or symbol

Returns null if no BCMR data is found for the token.

Response Example:

{
"description" : "Cauldron socks",
"filemeta": {
"actual_hash":"c705cc90a56ac7ef9a15ef90ebbc8ba7e60e4c622e5464d52d8baf7887949fcc",
"expected_hash":"c705cc90a56ac7ef9a15ef90ebbc8ba7e60e4c622e5464d52d8baf7887949fcc"
"source":"onchain"
},
"name":"Cauldron Socks",
"token":{
"category":"b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92",
"decimals":0,
"symbol":"SOCK"
},
"uris":{
"icon":"https://sock.cauldron.quest/sock.png",
"web":"https://cauldron.quest"
}
}

Example URI: /token/b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92

/token/<category>/all

Endpoint: GET /token/<category>/all

Status: Unstable

Description: Fetches BCMR data for token from all registries (including OTR).

Return format is same as /token/<category> route; except it returns an array of BCMR entries. Returns an empty array if no BCMR data is found.

Example URI: /token/b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92/all

/token/<category>/authhead

Endpoint: GET /token/<category>/authhead

Status: Unstable

Description: Returns the current authhead of a token's auth chain — the outpoint that the next BCMR-revision transaction must spend. The authhead is always output 0 of the latest auth chain transaction, so outpoint is <txid>:0.

Not cached: consumers (e.g. the riften-ipfs staging-pin flow) need the live head to verify that an unbroadcast revision tx spends it.

Returns null if the token has no auth chain entry.

Response Example:

{
"txid": "8289fa09272ac7930e219a2314965096a441f2f2fffdddd1f766f2cd3734fe28",
"vout": 0,
"outpoint": "8289fa09272ac7930e219a2314965096a441f2f2fffdddd1f766f2cd3734fe28:0",
"height": 123456
}

Example URI: /token/b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92/authhead


← Back to Index