Wallet API
Query BRC-20 circulation information

Query BRC-20 circulation information#

Get specified 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
tokenStringYesBRC-20 inscription tick

Response param#

ParameterTypeDescription
tokenStringBRC-20 inscription tick
precisionStringPrecision
totalSupplyStringInscription total supply
mintAmountStringInscription mint amount
limitPerMintStringInscription maximum number of mint per time
holderStringInscription number of token addresses held
deployAddressStringthe address that deploy the inscription
logoUrlStringInscription logo
txIdStringInscription transaction hash
inscriptionIdStringInscription id
deployHeightStringInscription deploy height
deployTimeStringInscription deploy time
inscriptionNumberStringInscription number
stateStringInscription State (success, fail)
tokenTypeStringInsctiption type, BRC-20

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",
  }]
}