Wallet API
Query BRC-20 circulation information

Query BRC-20 circulation information#

Get BRC-20 token circulation information, including number of holder addresses, number of minted, etc.

Request address#

GET https://www.okx.com/api/v5/explorer/brc20/token-details

Request param#

ParameterTypeRequiredDescription
tokenStringYestick

Response param#

ParameterTypeDescription
tokenStringtick
precisionStringPrecision
totalSupplyStringTotal supply
mintAmountStringMint amount
limitPerMintStringMaximum number of casts per time
holderStringNumber of token addresses held
deployAddressStringDeploy address
logoUrlStringLogo
txIdStringTransaction hash
inscriptionIdStringInscription id
deployHeightStringDeploy height
deployTimeStringDeploy time
inscriptionNumberStringInscription number
stateStringState (success, fail)
tokenTypeStringToken type, BRC20
msgStringMsg

Request example#

shell
curl --location --globoff 'https://www.okx.com/api/v5/explorer/brc20/token-details?token=sats' \
     --header 'OK-ACCESS-KEY: ******' \
     --header 'OK-ACCESS-SIGN: ******' \
     --header 'OK-ACCESS-TIMESTAMP: ******'

Response example#

200
{
  "code": "0",
  "msg": "",
  "data": [{
    "token": "sats",
    "precision": "18",
    "totalSupply": "2100000000000000",
    "mintAmount": "30658561856757.1",
    "limitPerMint": "100000000",
    "holder": "8354",
    "deployAddress": "bc1prtawdt82wfgrujx6d0heu0smxt4yykq440t447wan88csf3mc7csm3ulcn",
    "logoUrl": "",
    "txId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333",
    "inscriptionId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333i0",
    "deployHeight": "779971",
    "deployTime": "1678339934000",
    "inscriptionNumber": "357097",
    "state": "success",
    "tokenType": "BRC20",
    "msg": ""
  }]
}