This guide will walk you through migrating from Best in Slot (BiS) to Maestro. Transitioning from BiS involves mapping endpoints to their Maestro counterparts and adjusting request structures accordingly. Table of Contents:

Prerequisites

  1. Obtain a Maestro API key.
  2. Review Bitcoin API documentation.

Base URL

NetworkBiSMaestro
Mainnethttps://api.bestinslot.xyz/v3https://xbt-mainnet.gomaestro-api.org/v0
Testnet4https://testnet.api.bestinslot.xyzhttps://xbt-testnet.gomaestro-api.org/v0
Signethttps://signet.api.bestinslot.xyzNot currently supported

Headers

BiSMaestro
x-api-keyapi-key

Examples

Bash
# Maestro
curl -s 'https://xbt-mainnet.gomaestro-api.org/v0/assets/inscriptions/6d1cefe69ad686d6153bd1a6d34c6d55c6e3162cb2fac9b58a8d9d9e9fda13c6i0' \
--header 'Accept: application/json' \
--header 'api-key: <MAESTRO_API Key>'

# BiS
curl -s  'https://api.bestinslot.xyz/v3/inscription/single_info_id?inscription_id=6d1cefe69ad686d6153bd1a6d34c6d55c6e3162cb2fac9b58a8d9d9e9fda13c6i0' \
--header 'Accept: application/json' \
--header 'x-api-key: <BiS_API_KEY>'

Endpoints

This section details endpoint mapping by the following categories:

BIP-322

BiS Reference
BiSMaestro
TitleVerify BIP-322 Signatures-
Route/v3/bip322/verify-

Bitmap

BiS Reference
BiSMaestro
TitleGet Bitmap Holders-
Route/v3/bitmap/holders-
TitleGet Bitmap Inscriptions-
Route/v3/bitmap/inscription-
TitleGet Bitmap Sales Information-
Route/v3/bitmap/sales_info?marketplace_type=...-
TitleGet Bitmap Market Information-
Route/v3/bitmap/market_info-
TitleGet Bitmap Listings-
Route/v3/bitmap/listings-
TitleGet Bitmap Activity-
Route/v3/bitmap/activity-

BRC-20

BiS Reference
BiSMaestro
TitleBRC-20 Balances of WalletBRC20 by Address
Route/v3/brc20/wallet_balances?address=.../addresses/:address/brc20
TitleGet BRC-20 TickersList BRC20
Route/v3/brc20/tickers/assets/brc20
TitleGet BRC-20 Minting Ticker Count-
Route/v3/brc20/ticker_cnt-
TitleGet BRC-20 Ticker InformationBRC20 Info
Route/v3/brc20/ticker_info?ticker=.../assets/brc20/:ticker
TitleGet BRC-20 Valid Transfer Notes-
Route/v3/brc20/validtxnotes?ticker=...-
TitleGet BRC-20 Valid Transfer Notes of a WalletBRC20 Transfer Inscriptions by Address
Route/v3/brc20/validtxnotes_wallet?address=.../addresses/:address/brc20/transfer_inscriptions
TitleBRC-20 Validity Check-
Route/v3/brc20/single_info?inscription_id=...-
TitleBRC-20 Batch Validity Check-
Route/v3/brc20/batch_info-
TitleGet BRC-20 Ticker HoldersBRC20 Holders
Route/v3/brc20/holders?ticker=.../assets/brc20/:ticker/holders
TitleGet BRC-20 Event from TxId-
Route/v3/brc20/event_from_txid?txid=...-
TitleGet BRC-20 Sales Information-
Route/v3/brc20/sales_info?ticker=...-
TitleGet BRC-20 Market Information-
Route/v3/brc20/market_info?ticker=...-
TitleGet BRC-20 Listings-
Route/v3/brc20/listings?ticker=...-
TitleGet BRC-20 ActivityActivity by Inscription
Route/v3/brc20/activity?ticker=.../assets/inscriptions/:inscription_id/activity
TitleGet BRC-20 Wallet ActivityInscriptions by Address
Route/v3/brc20/wallet_activity?wallet_addr=.../addresses/:address/inscriptions
TitleGet BRC-20 Activity on BlockInscription Activity by Block
Route/v3/brc20/activity_on_block?block_height=.../blocks/:height_or_hash/inscriptions/activity
TitleGet BRC-20 Balance on Block-
Route/v3/brc20/balance_on_block?block_height=...-
TitleGet BRC-20 Balance on Block Batch-
Route/v3/brc20/batch_balance_on_block-
TitleGet BRC-20 All Valid Tx Notes-
Route/v3/brc20/all_validtxnotes-
TitleGet BRC-20 All Balances-
Route/v3/brc20/all_balances-

Collections

BiS Reference
BiSMaestro
TitleGet collections-
Route/v3/collection/collections-
TitleGet Collection InformationCollection Metadata by Collection Symbol
Route/v3/collection/info?slug=.../assets/collections/:collection_symbol/metadata
TitleGet Collection Holders-
Route/v3/collection/holders?slug=...-
TitleGet Collection InscriptionsInscription IDs by Collection Symbol
Route/v3/collection/inscriptions?slug=.../assets/collections/:collection_symbol/inscriptions
TitleGet Collection Sales Information-
Route/v3/collection/sales_info?slug=...-
TitleGet Collection Market Information-
Route/v3/collection/market_info?slug=...-
TitleGet Collection Listings-
Route/v3/collection/listings?slug=...-
TitleGet Collection Activity-
Route/v3/collection/activity?slug=...-

Inscriptions

BiS Reference
BiSMaestro
TitleGet Inscription InformationInscription Info
Route/v3/inscription/single_info_id?inscription_id=.../assets/inscriptions/:inscription_id
TitleGet Batch Inscription Information-
Route/v3/inscription/batch_info-
TitleGet Global Inscription Information-
Route/v3/inscription/global_info-
TitleRequest Render Refresh-
Route/v3/inscription/render_refresh?inscription_id=...-
TitleGet Inscription ActivityActivity by Inscription
Route/v3/inscription/activity?inscription_id=.../assets/inscriptions/:inscription_id/activity
TitleGet Inscriptions in TransactionInscription Activity by Transaction
Route/v3/inscription/in_transaction?tx_id=.../transactions/:tx_hash/inscriptions/activity
TitleGet Inscription Activity in BlockInscription Activity by Block
Route/v3/inscription/activity_on_block?block_height=.../blocks/:height_or_hash/inscriptions/activity
TitleGet New Inscriptions in Block-
Route/v3/inscription/new_inscriptions_in_block?block_height=...-

Mempool

BiS Reference
BiSMaestro
TitleGet All UTXOs of Bitcoin WalletUTxOs by Address (Mempool-aware)
Route/v3/mempool/all_utxos_of_wallet?wallet_addr=.../mempool/addresses/:address/utxos
TitleGet Cardinal UTXOs of Bitcoin Wallet-
Route/v3/mempool/cardinal_utxos_of_wallet?wallet_addr=...-
TitleGet Ordinal UTXOs of Bitcoin Wallet-
Route/v3/mempool/ordinal_utxos_of_wallet?wallet_addrs=...-
TitleGet Runic UTXOs of Bitcoin WalletRune UTxOs by Address and Rune (Mempool-aware)
Route/v3/mempool/runic_utxos_of_wallet?wallet_addr=.../mempool/addresses/:address/runes/utxos
TitleGet Cardinal Balance of Bitcoin Wallet-
Route/v3/mempool/cardinal_balance_of_wallet?wallet_addr=...-
TitleGet All Cardinal UTXOs in Mempool-
Route/v3/mempool/all_cardinal_utxos-
TitleGet All Ordinal UTXOs in MempoolAccess Mempool Transactions
Route/v3/mempool/all_ordinal_utxos-
TitleGet All Runic UTXOs in MempoolAccess Mempool Transactions
Route/v3/mempool/all_runic_utxos-
TitleGet All Runes Events in Mempool-
Route/v3/mempool/transactions-

Runes

BiS Reference
BiSMaestro
TitleRunes Testnet4 Faucet (only on testnet)-
Route/v3/runes/testnet_faucet?address=...-
TitleRunes TickersList Runes
Route/v3/runes/tickers/assets/runes
TitleRunes Ticker Count-
Route/v3/runes/ticker_cnt-
TitleRunes Single Ticker InfoRunes Info
Route/v3/runes/ticker_info?rune_Route=.../assets/runes/:rune
TitleGet Runes Sales InformationRune Trades for DEX
Route/v3/runes/sales_info?rune_Route=.../markets/dexs/trades/:dex/:symbol
TitleGet Runes Market Information-
Route/v3/runes/market_info?rune_Route=...-
TitleRunes Listings-
Route/v3/runes/listings?rune_id=...-
TitleRunes HoldersHolders by Rune
Route/v3/runes/holders?rune_Route=.../assets/runes/:rune/holders
TitleRunes Single Output Info-
Route/v3/runes/output_info?output=...-
TitleRunes Batch Output Info-
Route/v3/runes/batch_output_info-
TitleRunes Wallet BalancesRunes by Address
Route/v3/runes/wallet_balances?address=.../addresses/:address/runes
TitleRunes Wallet Valid OutputsRune UTXOs by Address
Route/v3/runes/wallet_valid_outputs?address=.../addresses/:address/runes/utxos
TitleRunes Wallet Valid Outputs Single RuneRune UTXOs by Address
Route/v3/runes/wallet_valid_outputs_single_rune?address=...&rune_id=.../addresses/:address/runes/utxos?rune=...
TitleRunes Valid Outputs-
Route/v3/runes/valid_outputs?rune_Route=...-
TitleRunes Wallet Activity-
Route/v3/runes/wallet_activity?address=...-
TitleRunes Activity of a TickerActivity by Inscription
Route/v3/runes/activity?rune_Route=.../assets/inscriptions/:inscription_id/activity
TitleRunes Activity in a Single TxInscription Activity by Transaction
Route/v3/runes/events_on_tx?txid=.../transactions/:tx_hash/inscriptions/activity
TitleRunes Historical Total SupplyRunes Info
Route/v3/runes/historical_total_supply?rune_Route=.../assets/runes/:rune
TitleRunes All Activity on Block HeightInscription Activity by Block
Route/v3/runes/activity_on_block?block_height=.../blocks/:height_or_hash/inscriptions/activity
TitleRunes All ID Route PairsList Runes
Route/v3/runes/all_id_Route_pairs/assets/runes
TitleRunes Historical PricesRune OHLC Data
Route/v3/runes/historical_prices/markets/dexs/ohlc/:dex/:symbol

Sats Routes

BiS Reference
BiSMaestro
TitleSats Validity Check-
Route/v3/sats/validity_check?inscription_id=...-
TitleSats Forward Lookup-
Route/v3/sats/forward_lookup?sats_Route=...-
TitleSats Reverse Lookup-
Route/v3/sats/reverse_lookup?address=...-
TitleGet Sats Activity-
Route/v3/sats/activity-

Wallets

BiS Reference Maestro Reference
BiSMaestro
TitleBTC Testnet4 Faucet (only on testnet)-
Route/v3/wallet/testnet_faucet-
TitleGet Wallet InscriptionsInscriptions by Address
Route/v3/wallet/inscriptions?address=.../addresses/:address/inscriptions
TitleGet Batch Wallet Inscriptions-
Route/v3/wallet/inscriptions_batch-
TitleGet Wallet Collections-
Route/v3/wallet/collections-
TitleGet Wallet Verified Sats-
Route/v3/wallet/sats_Routes-
TitleGet Wallet Listings-
Route/v3/wallet/listings?address=...-
TitleGet Wallet Activity (Inscriptions Only)-
Route/v3/wallet/activity?address=...-
TitleGet Wallet Global Activity (Inscriptions, BRC20 and Runes)-
Route/v3/wallet/global_activity?address=...-
TitleGet Wallet Metadata-
Route/v3/wallet/metadata?address=...-

Key Differences

  • API Structure: BiS uses RESTful endpoints with specific paths, while Maestro offers both RESTful as well as JSON-RPC interfaces.
  • Data Representation: Maestro’s responses may differ in structure; ensure to adapt your data parsing logic accordingly.

🎉 You’re Done!

You now have walked through a guide on how to migrate from Best-in-Slot to Maestro as your de-facto on-chain data provider.

Additional Resources

Be sure to review Maestro’s rate limits and pricing tiers to select the plan that best fits your application’s needs.
SupportIf you are experiencing any trouble with the above, reach out on Discord.