Skip to main content
Retired. These endpoints are no longer served. Run OPI instead — see the introduction. Kept for historical reference.
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

Terminology

[Used in this API for standardization] : [Terminology in Runes]
  • rune_name: Non-spaced unique Rune Name
  • deploy_txid: etching
  • decimals: divisibility
  • per_mint_amount: terms.amount (each mint event mints this amount for this rune)
  • mint_cnt: mints (count of mint events)
  • mint_cnt_limit: terms.cap (maximum allowed mint events for this rune)
  • premined_supply: premine (rune amount mined while deploying the rune)
  • total_minted_supply: premine + mint_cnt * per_mint_amount
  • circulating_supply: premine + mint_cnt * per_mint_amount - burned_supply
  • mintable: mint_cnt < mint_cnt_limit & (mint_start_block <= current_block < mint_end_block)
  • auto_upgrade: turbo (should ticker auto opt-in to new runes features)
  • output - <txid>:<output_index>
  • pkscript - bitcoin ScriptPubKey
  • avg_unit_price_in_sats - Calculated by taking the median unit price of sales in last 6 hrs. If there are not enough sale in last 6 hrs, it’ll look at latest several sales, if there is not enough sale on the ticker, it’ll return null. Note that this is scaled by decimals to make ordering more meaningful.
  • event_type - possible options are: input, new-allocation, mint, output, burn

Runes Testnet4 Faucet (only on testnet)

Included in: Basic, Pro, Dedicated GET https://testnet.api.bestinslot.xyz/v3/runes/testnet_faucet A testnet rune faucet that mints 1.0 (1_0000_0000) test rune to target address. NOTE: Limited with 10 request per 24 hours per key. Sample query: https://testnet.api.bestinslot.xyz/v3/runes/testnet_faucet?address=tb1qvhl8k0xu0stk956tjqx6q5ujp6tdyh24xcz0qq

Query Parameters

Response

Runes Tickers

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/tickers Returns information about runes tickers. NOTE: avg_unit_price_in_sats is scaled by decimals to make ordering more meaningful. Sample query: https://api.bestinslot.xyz/v3/runes/tickers?sort_by=rune_number&order=asc&offset=0&count=100

Query Parameters

Response

Runes Ticker Count

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/ticker_cnt Returns count of all runes tickers and mintable runes tickers Sample query: https://api.bestinslot.xyz/v3/runes/ticker_cnt

Runes Single Ticker Info

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/ticker_info Returns information about given runes ticker.
avg_unit_price_in_sats, min_listed_unit_price_in_sats, listed_supply, listed_supply_ratio, marketcap and total_sale_info are only available in PRO tier.
Sample query: https://api.bestinslot.xyz/v3/runes/ticker_info?rune_name=UNCOMMONGOODS

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response

Get Runes Sales Information

Included in: Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/sales_info Returns sales and volume information about a specific runes ticker. Sample query: https://api.bestinslot.xyz/v3/runes/sales_info?rune_name=SATOSHINAKAMOTO&marketplace_type=unisat

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified

Get Runes Market Information

Included in: Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/market_info Returns market information about a specific runes ticker. Sample query: https://api.bestinslot.xyz/v3/runes/market_info?rune_name=SATOSHINAKAMOTO

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified

Runes Listings

Included in: Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/listings Returns listing information of a given rune. Sample query: https://api.bestinslot.xyz/v3/runes/listings?rune_id=840000:3&sort_by=min_unit_price&order=asc&offset=0&count=100

Query Parameters

NameTypeDescription
rune_namestring(optional) Non-Spaced name of Rune
rune_idstring(optional) Rune ID
rune_numberint(optional) Rune Number
sort_by*stringoutput, min_price, unisat_price
order*stringasc, desc
offset*int0 <= offset
count*int20 <= count <= 100
NOTE: One of rune_name, rune_id or rune_number must be specified. Response

Runes Holders

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/holders Returns balances of holders of a given runes ticker. Sample query: https://api.bestinslot.xyz/v3/runes/holders?rune_name=UNCOMMONGOODS&sort_by=balance&order=desc&count=500&offset=0

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response

Runes Single Output Info

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/output_info Returns runes information about given bitcoin output. Sample query: https://api.bestinslot.xyz/v3/runes/output_info?output=314e5e53024ec5860bd2fa2a4e85db2fc9097fcf58caa63f253bb4f86ad4b412:1

Query Parameters

Response

Runes Batch Output Info

Included in: Basic, Pro, Dedicated POST https://api.bestinslot.xyz/v3/runes/batch_output_info Returns runes information about given bitcoin outputs. Sample query:
url:
https://api.bestinslot.xyz/v3/runes/batch_output_info
data:
&#123; "queries": [ "314e5e53024ec5860bd2fa2a4e85db2fc9097fcf58caa63f253bb4f86ad4b412:1", "0979edfb33fa380fb8c80e53809e9d865169ac6857688b31446d577d5f6df869:1", "200380702f43b2a6403bd9576c48e74e7cf184d5ead280eaa25a2d71be9cb2c8:1" ] &#125;
headers:
&#123; "Content-Type":"application/json", "x-api-key":"...." &#125;

Request Body

Response

Runes Wallet Balances

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/wallet_balances Returns runes balance information about given bitcoin wallet address or pkscript. NOTE: avg_unit_price_in_sats and min_listed_unit_price_in_sats is scaled by decimals. Sample query: https://api.bestinslot.xyz/v3/runes/wallet_balances?address=tb1pd368q84tuark4naym2u5382p59jkd27nw5vu5s44uz8dwdlrcwhqzdl2l2

Query Parameters

NOTE: One of address or pkscript must be specified Response

Runes Wallet Valid Outputs

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/wallet_valid_outputs Returns unspent output information of a given wallet. Sample query: https://api.bestinslot.xyz/v3/runes/wallet_valid_outputs?pkscript=51206c74701eabe7476acfa4dab9489d41a16566abd37519ca42b5e08ed737e3c3ae&sort_by=output&order=asc&offset=0&count=2000

Query Parameters

NameTypeDescription
addressstring(optional) Bitcoin wallet address
pkscriptstring(optional) Bitcoin script_pub_key
sort_by*stringoutput, min_price, unisat_price
order*stringasc, desc
offset*int0 <= offset
count*int20 <= count <= 2000
NOTE: One of address or pkscript must be specified Response

Runes Wallet Valid Outputs Single Rune

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/wallet_valid_outputs_single_rune Returns unspent output information of a given wallet of a given rune. Sample query: https://api.bestinslot.xyz/v3/runes/wallet_valid_outputs_single_rune?address=bc1paa9fl7ae5cnlf9dr7gj0p4egga5fqxvgz0vhjd07h0znnf9xvz8qfsw3e8&sort_by=min_price&order=asc&offset=0&count=2000&rune_id=840000:3

Query Parameters

NameTypeDescription
rune_namestring(optional) Non-Spaced name of Rune
rune_idstring(optional) Rune ID
rune_numberint(optional) Rune Number
addressstring(optional) Bitcoin wallet address
pkscriptstring(optional) Bitcoin script_pub_key
sort_by*stringoutput, min_price, unisat_price
order*stringasc, desc
offset*int0 <= offset
count*int20 <= count <= 2000
NOTE: One of address or pkscript must be specified, one of rune_name, rune_id or rune_number must be specified Response

Runes Valid Outputs

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/valid_outputs Returns unspent output information of a given ticker. Sample query: https://api.bestinslot.xyz/v3/runes/valid_outputs?rune_name=UNCOMMONGOODS&sort_by=output&order=asc&offset=0&count=2000

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response

Runes Wallet Activity

Included in: Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/wallet_activity Returns runes activity of a given wallet. If the given wallet is involved in a runes transaction, all activity in the transaction will be returned (even if that activity is an input/output to a different wallet) The endpoint includes an optional rune filter. You can leave the parameters rune_name, rune_id, and rune_number blank to retrieve all wallet activity. Alternatively, you may supply at most one of these parameters to filter transactions where one of the events in the tx involves both the specified wallet and rune. If optional runes_filter_only_wallet parameter is set to true, the endpoint only returns the runes events with the selected wallet. Otherwise it also includes the other runes events in the transaction. Sample query: https://api.bestinslot.xyz/v3/runes/wallet_activity?pkscript=51206c74701eabe7476acfa4dab9489d41a16566abd37519ca42b5e08ed737e3c3ae&sort_by=ts&order=desc&offset=0&count=2000

Query Parameters

NameTypeDescription
addressstring(optional) Bitcoin wallet address
pkscriptstring(optional) Bitcoin script_pub_key
rune_namestring(optional) Non-Spaced name of Rune
rune_idstring(optional) Rune ID
rune_numberint(optional) Rune Number
sort_by*stringcurrently only option is ts (timestamp)
order*stringasc, desc
offset*int0 <= offset
count*int20 <= count <= 2000
runes_filter_only_walletstring(optional) “true” or “false”
NOTE: One of address or pkscript must be specified Response

Runes Activity of a Ticker

Included in: Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/activity Returns activity of a given ticker. Sample query: https://api.bestinslot.xyz/v3/runes/activity?rune_name=UNCOMMONGOODS&sort_by=ts&order=desc&offset=0&count=2000

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response

Runes Activity in a Single Tx

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/events_on_tx Returns runes activity on a given bitcoin transaction. Sample query: https://api.bestinslot.xyz/v3/runes/events_on_tx?txid=e49f0912f94b915c0dd12b7970083b348945c2fc7bc01a21e0bfa403827607cf

Query Parameters

NameTypeDescription
txid*stringBitcoin txid
Response

Runes Historical Total Supply

Included in: Basic, Pro, Dedicated GET https://api.bestinslot.xyz/v3/runes/historical_total_supply Returns historical total supply for selected rune in selected block height. Sample query: https://api.bestinslot.xyz/v3/runes/historical_total_supply?rune_name=UNCOMMONGOODS&block_height=860000

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response

Runes All Activity on Block Height

Included in: Enterprise, Dedicated with Enterprise Endpoints GET https://api.bestinslot.xyz/v3/runes/activity_on_block Returns all runes activity in a given block height. Sample query: https://api.bestinslot.xyz/v3/runes/activity_on_block?block_height=840000

Query Parameters

Response

Runes All ID Name Pairs

Included in: Enterprise, Dedicated with Enterprise Endpoints GET https://api.bestinslot.xyz/v3/runes/all_id_name_pairs Returns all runes id-name pairs
If send_urls is set to true, we’ll also return content and render urls for rune icon. Response will include render_prefix, render_suffix, content_prefix, content_suffix and r and ic fields in data array. r denotes if render is available and urls are constructed using prefix + ic + suffix.
Sample query: https://api.bestinslot.xyz/v3/runes/all_id_name_pairs

Query Parameters

Response

Runes Historical Prices

Included in: Dedicated GET https://api.bestinslot.xyz/v3/runes/historical_prices Returns all historical prices for selected rune If granularity is set to 1d, it’ll return the average price for the day. Sample query: https://api.bestinslot.xyz/v3/runes/historical_prices?sort_by=ts&order=desc&offset=0&count=2000&rune_id=1:0

Query Parameters

NOTE: One of rune_name, rune_id or rune_number must be specified Response