BRC-20 API
Introduction
Return Parameters
The request return parameters:
code
string
0 - success
msg
string
data
string
Example
Inscription API
Get inscription list
Request
GET /v1/btc/inscriptionList
Parameters
address
string
No
page
number
No
request page number
size
number
No
request page size
Return data
total
number
total amount
page
number
page number
limit
number
returned amount
list
array
inscription list
Inscription:
inscriptionNumber
number
inscriptionId
string
owner
string
output
string
Example
Request:
Response:
Get inscription
Request
GET /v1/btc/inscription
Parameters
inscriptionId
string
No
inscriptionNumber
string
No
Return data
inscriptionNumber
string
inscriptionId
string
txid
string
holder
string
creator
string
deployHeight
string
deployTime
string
output
string
Example
Get inscription transaction list
Request
GET /v1/btc/inscriptionHistory
Parameters
inscriptionId
string
Yes
start
string
No
request start index
limit
string
No
request limit
Return data
inscriptionId
string
inscriptionNumber
string
total
string
total amount
start
string
start index
limit
string
returned amount
transactionList
array
inscription transaction list
Inscription Transaction:
txid
string
tx Id
block
string
block height
txType
string
transaction type: inscribe, transfer
from
string
from address
to
string
to address
time
string
Example
BRC20 API
Get BRC20 token list
Request
GET /v1/btc/tokenList
Parameters
page
number
No
request page number
size
number
No
request page size
status
number
No
token status (0: all status, 1: minting, 2: complate)
Return data
total
number
total token amount
page
number
start page number
limit
number
returned amount
list
array
token list
Token:
tokenType
string
token type: brc20
token
string
total tick
totalSupply
number
total supply
limit
number
mint limit
decimals
number
minted
number
minted amount
creator
string
deployTime
string
deployHeight
string
holders
string
holder amount
Example
Request:
Response:
Get BRC20 token info
Request
GET /v1/btc/token
Parameters
token
string
Yes
token tick
Return data
tokenType
string
token type: brc20
token
string
total tick
totalSupply
number
total supply
limit
number
mint limit
minted
number
minted amount
decimals
number
txid
string
deploy tx id
creator
string
deployHeight
number
deployTime
number
inscriptionNumberStart
string
inscriptionNumberEnd
string
Example
Request:
Response:
Get BRC20 token holder list
Request
GET /v1/btc/tokenHolders
Parameters
token
string
Yes
token tick
start
string
No
limit
string
No
Return data
total
string
total holder amount
start
string
start index
limit
string
returned amount
holderList
Array
holder list
Holder:
address
string
amount
string
token amount
Get BRC20 token transaction list
Request
GET /v1/btc/tokenHistory
Parameters
token
string
Yes
token tick
type
string
No
transaction type: all, deploy, mint, transfer, inscribeTransfer
start
string
No
start index
limit
string
No
from
string
No
from address
to
string
No
to address
Return data
token
string
token tick
total
string
total amount
start
string
start index
limit
string
returned amount
txList
array
transaction list
Transaction:
txid
string
tx Id
block
string
block height
tokenType
string
token type: brc20
token
string
token tick
txType
string
transaction type: all, deploy, mint, transfer, inscribeTransfer
from
string
from address
to
string
to address
amount
string
transaction amount
inscriptionNumber
string
inscription number
inscriptionId
string
inscription Id
time
string
Example
Get Address token list
Request
GET /v1/btc/addressTokenBalance
Parameters
address
string
Yes
token
string
No
token tick
start
string
No
limit
string
No
Return data
address
string
total
string
total amount
start
string
start index
limit
string
returned amount
tokenList
array
token list
TokenBalance:
tokenType
string
token type: brc20
token
string
total token count
balance
string
transferableBalance
string
avaliableBalance
string
Example
Get Address inscribe-transfer list
Request
GET /v1/btc/addressTransferList
Parameters
address
string
Yes
token
string
No
token tick
start
string
No
limit
string
No
Return data
address
string
total
string
total amount
start
string
start index
limit
string
returned amount
transferList
array
inscribe-transfer list
Inscribe-transfer:
tokenType
string
token type: brc20
token
string
total token count
amount
string
inscribe-transfer amount
inscriptionId
string
inscriptionNumber
string
Example
Get Address transaction list
Request
GET /v1/btc/addressHistory
Parameters
address
string
Yes
token
string
Yes
token tick
type
string
No
transaction type: all, deploy, mint, transfer, inscribeTransfer
start
string
No
limit
string
No
Return data
total
string
total amount
start
string
start index
limit
string
returned amount
txList
array
transaction list
Transaction:
txid
string
tx Id
block
string
block height
tokenType
string
token type: brc20
token
string
token tick
txType
string
transaction type: all, deploy, mint, transfer, inscribeTransfer
from
string
from address
to
string
to address
amount
string
transaction amount
inscriptionNumber
string
inscription number
inscriptionId
string
inscription Id
time
string
Example
Last updated