BRC-20
Endpoints related to BRC-20 Protocol.
Endpoints' API-Key-Tier availabilities are written for each endpoint.
To use on testnet4/signet, use your current api-key and send the request to https://testnet.api.bestinslot.xyz
/ https://signet_api.bestinslot.xyz
BRC-20 Balances of Wallet
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/wallet_balances
Returns BRC-20 token balances of a bitcoin wallet.
Sample query: https://api.bestinslot.xyz/v3/brc20/wallet_balances?address=bc1pgmtxez2cnp3wk5q52wjcakrkqqfxukgmannrtttm4kq64q53qw7qw44juz
NOTE: min_listed_unit_price is only available on Pro Tier.
Query Parameters
address*
string
bitcoin wallet address
ticker
string
(optional) Filter reponse to only show the selected ticker
Get BRC-20 Tickers
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/tickers
Returns ordered list of brc-20 tickers with detailed information about them.
Sample query: https://api.bestinslot.xyz/v3/brc20/tickers?sort_by=remaining_supply&order=asc&offset=0&count=100&minting_status=not_complete
NOTE: min_listed_unit_price, listed_supply, marketcap and total_sale_info is only available on Pro Tier.
Query Parameters
sort_by*
string
deploy_ts, max_supply, burned_supply, minted_supply, remaining_supply, holder_count, tx_count, mint_progress PRO TIER: min_listed_unit_price, min_listed_unit_price_ordinalswallet, min_listed_unit_price_unisat, min_listed_unit_price_okx, listed_supply, listed_supply_ratio, marketcap
order*
string
asc, desc
offset*
int
0 <= offset
count*
int
20 <= count <= 100
minting_status
string
(optional) set to "not_complete" for searching only the tickers with minting_progress<100 set to "completed" for searching only the tickers with minting_progress=100 do not set to search within all tickers
Get BRC-20 Minting Ticker Count
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/ticker_cnt
Returns the count of brc-20 tickers which haven't finished minting and total brc-20 ticker count.
Sample query: https://api.bestinslot.xyz/v3/brc20/minting_ticker_cnt
Get BRC-20 Ticker Information
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/ticker_info
Returns detailed information about a specific BRC-20 ticker.
Sample query: https://api.bestinslot.xyz/v3/brc20/ticker_info?ticker=ORDI
Query Parameters
ticker*
string
BRC-20 ticker
Get BRC-20 Valid Transfer Notes
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/validtxnotes
Returns ordered list of brc-20 valid transfer notes of a given ticker with detailed information about them.
Sample query: https://api.bestinslot.xyz/v3/brc20/validtxnotes?ticker=ordi&sort_by=min_unit_price&order=asc&offset=0&count=100
Query Parameters
sort_by*
string
inscr_num, min_price, min_unit_price, transfer_amount
order*
string
asc, desc
offset*
int
0 <= offset
count*
int
20 <= count <= 2000
ticker*
string
BRC-20 ticker
Get BRC-20 Valid Transfer Notes of a Wallet
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/validtxnotes_wallet
Returns ordered list of brc-20 valid transfer notes of a given BTC wallet with detailed information about them.
Sample query: https://api.bestinslot.xyz/v3/brc20/validtxnotes_wallet?address=bc1pgmtxez2cnp3wk5q52wjcakrkqqfxukgmannrtttm4kq64q53qw7qw44juz&sort_by=min_unit_price&order=asc&offset=0&count=100
Query Parameters
sort_by*
string
inscr_num, min_price, min_unit_price, transfer_amount
order*
string
asc, desc
offset*
int
0 <= offset
count*
int
20 <= count <= 2000
address*
string
bitcoin wallet address
BRC-20 Validity Check
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/single_info
Returns validity details about a specific inscription.
Sample query: https://api.bestinslot.xyz/v3/brc20/single_info?inscription_id=859905a264deaab7ce88832ad73684ddc45cf9e0022e2700b8ac549f14199279i0
Query Parameters
inscription_id*
string
inscription id
BRC-20 Batch Validity Check
Included in: Basic, Pro, Dedicated
POST
https://api.bestinslot.xyz/v3/brc20/batch_info
Returns validity details about a specific inscription.
Sample query:
url:
https://api.bestinslot.xyz/v3/brc20/batch_info
data:
{ "queries": [ "859905a264deaab7ce88832ad73684ddc45cf9e0022e2700b8ac549f14199279i0", "62a2e184ae03ef3ca20a92b628b45b644147fad3e0b1de096f511d41bfcb32bai0", "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0" ] }
headers:
{ "Content-Type":"application/json", "x-api-key":"...." }
Request Body
queries*
Array
Array of inscription id strings Max length: 100
Get BRC-20 Ticker Holders
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/holders
Returns ordered list of brc-20 holders and their balances.
Sample query: https://api.bestinslot.xyz/v3/brc20/holders?ticker=ordi&sort_by=balance&order=desc&offset=10000&count=500
Query Parameters
sort_by*
string
balance
order*
string
asc, desc
offset*
int
0 <= offset
count*
int
20 <= count <= 500
ticker*
string
BRC-20 ticker
Get BRC-20 Event from TxId
Included in: Basic, Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/event_from_txid
Returns BRC-20 events in a given bitcoin txid.
Sample query: https://api.bestinslot.xyz/v3/brc20/event_from_txid?txid=21b7b3bf48b04af8102a560acdbf3993411a96caa9327b6c07423096ec2e17da
NOTE: price and marketplace_type information is only available in PRO Tier.
Query Parameters
txid*
string
Bitcoin txid
Get BRC-20 Sales Information
Included in: Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/sales_info
Returns sales and volume information about a specific brc-20 ticker.
Sample query: https://api.bestinslot.xyz/v3/brc20/sales_info?ticker=ordi&marketplace_type=magiceden
Query Parameters
ticker*
string
BRC-20 ticker
marketplace_type
string
Optional parameter to filter only by a given marketplace. You can find the allowed types on Constants Page.
Get BRC-20 Market Information
Included in: Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/market_info
Returns market information like marketcap, listed count, floor price about a specific BRC-20 ticker.
Sample query: https://api.bestinslot.xyz/v3/brc20/market_info?ticker=ordi
Query Parameters
ticker*
string
BRC-20 ticker
Get BRC-20 Listings
Included in: Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/listings
Returns ordered list of listings of a specific BRC-20 ticker.
Sample query: https://api.bestinslot.xyz/v3/brc20/listings?ticker=ordi&sort_by=min_unit_price&order=desc&offset=0&count=100
Query Parameters
sort_by*
string
min_price, min_unit_price, ordinalswallet_price, ordinalswallet_unit_price, unisat_price, unisat_unit_price, okx_price, okx_unit_price
order*
string
asc, desc
offset*
int
0 <= offset <= 5k
count*
int
20 <= count <= 100
ticker*
string
BRC-20 ticker
Get BRC-20 Activity
Included in: Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/activity
Returns ordered list of inscribes, sales and transfers of a specific BRC-20 ticker.
NOTE: Use last_new_satpoint to continue fetching the activity from where you've left off. new_satpoint uniquely addresses a single inscription transfer, so by setting order to asc, and last_new_satpoint to the latest new_satpoint value that you've received, you can retrieve the new activities.
Sample query: https://api.bestinslot.xyz/v3/brc20/activity?ticker=ordi&activity_filter=7&sort_by=ts&order=desc&offset=1000&count=100&last_new_satpoint=a47f806f7fa622a44bc77bc886c8e0646cc61878d412285aa4a297cf2a5ce296:0:0
Query Parameters
sort_by*
string
ts, unit_price, amount, sale_price
order*
string
asc, desc
offset*
int
0 <= offset <= 5k
count*
int
20 <= count <= 100
ticker*
string
BRC-20 ticker
activity_filter*
int
1 -> mints 2 -> transfers 4 -> sales combine with or operator (e.g. sold & transferred: 2 | 4 = 6)
last_new_satpoint
string
(optional) use this with offset 0 to continue from a known transfer
wallet
string
(optional) bitcoin wallet filter
Get BRC-20 Wallet Activity
Included in: Pro, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/wallet_activity
Returns ordered list of deploy-inscribe, mint-inscribe, transfer-inscribe and transfer-transfer of a given bitcoin wallet.
Sample query: https://api.bestinslot.xyz/v3/brc20/wallet_activity?order=asc&offset=0&count=2000&wallet_addr=bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06
Query Parameters
order*
string
asc, desc (ordered by timestamp)
offset*
int
0 <= offset <= 5k
count*
int
20 <= count <= 2000
wallet_addr*
string
bitcoin wallet address
Get BRC-20 Activity on Block
Included in: Enterprise, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/activity_on_block
Returns ordered list of mint note and transfer note inscribes, and transfer note transfers in a given block height.
NOTE: block_height at the response is not the queried block height. It is the final indexed block height of our indexer.
Sample query: https://api.bestinslot.xyz/v3/brc20/activity_on_block?block_height=802396
Query Parameters
block_height*
int
block height, must be smaller than or equal to current bitcoin block height
Get BRC-20 Balance on Block
Included in: Enterprise, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/balance_on_block
Returns BRC-20 balances of a given wallet (address or pkscript(scriptPubKey)) at the beginning of the given block height.
NOTE: block_height at the response is not the queried block height. It is the final indexed block height of our indexer.
Sample query: https://api.bestinslot.xyz/v3/brc20/balance_on_block?block_height=802397&pkscript=0014cd6cccc69331a96ea0fe0fa5d1d184a811979a8b
Query Parameters
block_height*
int
block height, must not be bigger than (current bitcoin block height + 1)
pkscript
string
scriptPubKey of the wallet. Only one of the wallet/pkscipt parameters should be set!
wallet
string
address of the wallet. Only one of the wallet/pkscipt parameters should be set!
Get BRC-20 Balance on Block Batch
Included in: Enterprise, Dedicated
POST
https://api.bestinslot.xyz/v3/brc20/batch_balance_on_block
Returns BRC-20 ticker balance of several given wallet (address or pkscript(scriptPubKey)) at the beginning of the given block height.
Query limit is 100 per request.
NOTE: block_height at the response is not the queried block height. It is the final indexed block height of our indexer.
NOTE: if the queried block hasn't been indexed yet, it'll return {error: "block not indexed yet"}
in response.
Sample query:
url:
https://api.bestinslot.xyz/v3/brc20/batch_balance_on_block
data:
{"queries":[{"pkscript":"0014cd6cccc69331a96ea0fe0fa5d1d184a811979a8b","block_height":802397,"ticker":"pepe"},{"pkscript":"512037679ea62eab55ebfd442c53c4ad46b6b75e45d8a8fa9cb31a87d0df268b029a","block_height":802397,"ticker":"meme"}]}
headers:
{ "Content-Type":"application/json", "x-api-key":"...." }
Request Body
queries*
JSON Array
List of (block_height, ticker, (wallet|pkscript)) objects. (only one of wallet / pkscript is required for each query)
Get BRC-20 All Valid Tx Notes
Included in: Enterprise, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/all_validtxnotes
Returns All valid BRC-20 tx notes.
Sample query: https://api.bestinslot.xyz/v3/brc20/all_validtxnotes
Get BRC-20 All Balances
Included in: Enterprise, Dedicated
GET
https://api.bestinslot.xyz/v3/brc20/all_balances
Returns All BRC-20 balances of all wallets.
Sample query: https://api.bestinslot.xyz/v3/brc20/all_balances
Last updated