### Get Wallet Global Activity API Request Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets Example of a GET request to the wallet global activity endpoint with specified query parameters for address, sorting, and count. ```http GET https://api.bestinslot.xyz/v3/wallet/global_activity?address=bc1pg7j3rwqnjfsrj66gcgtfx99c6l3vnrs9v7arx3kpjmh9ukmv47wq0jdgg0&sort_by=ts&order=desc&count=500&cursor=384298391__14396391 ``` -------------------------------- ### Get Wallet Activity API Request Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets An example GET request to the BestInSlot API for retrieving wallet activity, specifically inscriptions. It includes parameters for filtering, sorting, and pagination. ```http GET https://api.bestinslot.xyz/v3/wallet/activity?address=bc1par0t76nmjf55wp0rpzu58p97mzz6tf3cd67js077a2qx5ez8knlqfnccjq&activity_filter=7&sort_by=ts&order=desc&offset=0&count=100 ``` -------------------------------- ### Collection Listings API Request Example (URL) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/collections This is an example URL for the Get Collection Listings API endpoint. It demonstrates how to specify query parameters such as the collection slug, sorting criteria (by minimum price, ascending order), offset, and count. ```url https://api.bestinslot.xyz/v3/collection/listings?slug=bitcoin-frogs\&sort\_by=min\_price\&order=asc\&offset=0\&count=100 ``` -------------------------------- ### Get BRC-20 Tickers List (Example Query) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/brc-20 This example demonstrates how to query the BRC-20 tickers endpoint to retrieve an ordered list of BRC-20 tickers with detailed information. It includes parameters for sorting, ordering, pagination, and filtering by minting status. Note that several fields like 'min_listed_unit_price' are restricted to the Pro Tier. ```url https://api.bestinslot.xyz/v3/brc20/tickers?sort_by=remaining_supply&order=asc&offset=0&count=100&minting_status=not_complete ``` -------------------------------- ### Get Batch Wallet Inscriptions API Request Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets This example demonstrates how to make a POST request to the `inscriptions_batch` endpoint to retrieve inscriptions for multiple wallet addresses. It includes the sample URL, a JSON payload containing the list of addresses, pagination parameters (offset and count), sorting criteria, and the required headers, including the API key. ```bash POST https://api.bestinslot.xyz/v3/wallet/inscriptions_batch url: https://api.bestinslot.xyz/v3/wallet/inscriptions_batch data: {"addresses":["bc1pfxhh3yh5pp4s8pf6wjthe5dwsl6nva04n8zdsw4wsnq76kpy2fsqxgse5d","bc1psrvymaz9gx4ljw0x4lpsscrsh2xy8u4yx0ru9z8spdjsgp99qchsaawzw4","bc1pqvkxuvy6cquv0x9kggy0c3skavmwh2arr22xghxae6pqwq4jk4gqw6dpu9"],"offset":0,"count":2000,"sort_by":"inscr_num","order":"desc"} headers: { "Content-Type":"application/json", "x-api-key":"...." } ``` -------------------------------- ### Get BRC-20 Wallet Balances (Example Query) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/brc-20 This example shows how to construct a URL to query the BRC-20 wallet balances endpoint. It requires a Bitcoin wallet address as a parameter and optionally accepts a ticker for filtering results. The endpoint returns BRC-20 token balances. ```url https://api.bestinslot.xyz/v3/brc20/wallet_balances?address=bc1pgmtxez2cnp3wk5q52wjcakrkqqfxukgmannrtttm4kq64q53qw7qw44juz ``` -------------------------------- ### Collection Activity API Request Example (URL) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/collections This URL exemplifies a request to the Get Collection Activity endpoint. It shows the inclusion of parameters like the collection slug, activity filter type, sorting by timestamp, order, offset, count, and the crucial last_new_satpoint for pagination. ```url https://api.bestinslot.xyz/v3/collection/activity?slug=degods\&activity\_filter=7\&sort\_by=ts\&order=asc\&offset=0\&count=100\&last\_new\_satpoint=32b63c4844db4f704a8df0cf27fcf6ee966a716ea5410e598fe40734b1a7027f:1:0 ``` -------------------------------- ### Runes Activity API Request Example (URL) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/runes This is an example URL for fetching runes activity for a specific ticker. It demonstrates the use of query parameters such as rune_name, sort_by, order, offset, and count to filter and paginate the results. Note that 'rune_name' is a required parameter for this specific query. ```text https://api.bestinslot.xyz/v3/runes/activity?rune_name=UNCOMMONGOODS&sort_by=ts&order=desc&offset=0&count=2000 ``` -------------------------------- ### Get BRC-20 Wallet Balances (JSON Example) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/brc-20 This snippet shows a successful JSON response for retrieving BRC-20 token balances for a Bitcoin wallet. It includes details such as ticker, overall balance, available balance, and transferrable balance. Note that 'min_listed_unit_price' is only available on the Pro Tier. ```json { "data": [ { "ticker": "oxbt", "overall_balance": "5000.0000000000000000", "available_balance": "0.000000000000000000000000000000000000", "transferrable_balance": "5000.0000000000000000", "image_url": null, "min_listed_unit_price": 335.94 }, { "ticker": "mnga", "overall_balance": "50000.000000000000", "available_balance": "0.000000000000000000000000000000000000", "transferrable_balance": "50000.000000000000", "image_url": null, "min_listed_unit_price": 0.4072 }, { "ticker": "btoc", "overall_balance": "500.0000000000000000", "available_balance": "0.000000000000000000000000000000000000", "transferrable_balance": "500.0000000000000000", "image_url": null, "min_listed_unit_price": 144.556 } ], "block_height": 795037 } ``` -------------------------------- ### Testnet & Signet API Access Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet Instructions for accessing the API on Bitcoin Testnet4 and Signet. ```APIDOC ## Testnet & Signet API To use our full API running on Bitcoin Testnet4 or Signet, use the following base URLs: - **Testnet4:** `https://testnet.api.bestinslot.xyz` - **Signet:** `https://signet_api.bestinslot.xyz` Same API-Keys can be used on testnet4 and signet. ``` -------------------------------- ### Get Inscription Activity - Success Response Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/inscriptions This JSON snippet represents a successful response from the 'Get Inscription Activity on Block' endpoint, showing a list of inscription objects. ```json { "data": [ { "inscription_id": "7fd3aca38fd8acb22efe231ef5d5439e391c0394be3967ee07484cffc1b792fai0" }, { "inscription_id": "251c744ceb0ad4c6e1ee0d391cfa0451d958065e73605b543190cda62723f6f8i0" }, { "inscription_id": "b089b8df8392d0ac3b47b8e51fb008aa40442b6bb250ad2a1d8d60d88cc65585i0" }, { "inscription_id": "ec9570ada981607bd93a5a7e6fd99760faaa8fc87989aa6646fe8c9b2aab494ei0" }, { "inscription_id": "7c679ba4a2b8460fb60d62912e812206a031abeef19983564953c14bb4e091d5i0" }, { "inscription_id": "9c233d4b62e1fde06c1a238fcef26e398eaee5a9abf32a6de8eef12cd4e523dai0" } ], "block_height": 815901 } ``` -------------------------------- ### Testnet Environment Endpoints - Bash Source: https://context7.com/context7/bestinslot_xyz/llms.txt Demonstrates how to use testnet and signet endpoints for development purposes, including retrieving BRC-20 ticker info and requesting funds from a testnet faucet. Uses the same API key. ```bash # Testnet4 endpoint curl --location 'https://testnet.api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test' \ --header 'x-api-key: your_api_key_here' # Signet endpoint curl --location 'https://signet_api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test' \ --header 'x-api-key: your_api_key_here' # Testnet BTC faucet (10 requests per 24h per key) curl --location 'https://testnet.api.bestinslot.xyz/v3/wallet/testnet_faucet?address=tb1p9ts4eu2s4adgjwumdmcu9qfw0hcavrh8m54tyrd39lkk7h4940yq2dmvzx' \ --header 'x-api-key: your_api_key_here' ``` -------------------------------- ### Get Collection Information - Example JSON Response Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/collections This snippet shows a successful JSON response for the 'Get Collection Information' API endpoint. It includes details about a collection like name, supply, floor prices, and trading volumes. The data structure is useful for developers integrating with the Bestinslot API to display collection metrics. ```json { "data": [ { "name": "Quantum Cats", "slug": "quantum_cats", "inscription_icon_id": "https://creator-hub-prod.s3.us-east-2.amazonaws.com/ord-taproot_wizards_presents_pfp_1706542390359.png", "icon_url": "https://creator-hub-prod.s3.us-east-2.amazonaws.com/ord-taproot_wizards_presents_pfp_1706542390359.png", "icon_render_url": null, "bis_url": "https://bestinslot.xyz/ordinals/collection/quantum_cats", "supply": "3333", "min_number": 53785860, "median_number": 53788086, "max_number": 53790617, "listed_count": 132, "floor_price": 12136980, "floor_price_ordswap": null, "floor_price_magiceden": 12136980, "floor_price_ordinalswallet": null, "floor_price_gammaio": null, "floor_price_ordynals": null, "floor_price_unisat": null, "floor_price_ordinalsmarket": 199000000, "floor_price_okx": 20000000, "vol_3h_in_btc": 0.20895894, "vol_24h_in_btc": 0.20895894, "vol_7d_in_btc": 16.14854946, "vol_30d_in_btc": 92.46122358, "sale_cnt_7d": 139, "vol_total_in_btc": 1683.87253749, "sale_cnt_total": 6352, "marketcap": 40452554340 }, ... ], "block_height": 889392 } ``` -------------------------------- ### General Usage Information Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet Details on how to use the API, including authentication, rate limiting, and parameter constraints. ```APIDOC ## General Usage Information ### API Key Authentication API Key should be sent in the `x-api-key` header. ### Offset and Count Limits - Offset is limited to 5000 for most endpoints. Some endpoints may have increased offset limits or no offset limit (e.g., `brc20/holders`). - Maximum count value is 100 for most endpoints. Some endpoints may have increased count limits (e.g., `brc20/holders`). - Offset and count must be a multiple of 20. ### Example Request ```powershell curl --location 'https://api.bestinslot.xyz/v3/brc20/ticker_info?ticker=ordi' \ --header 'x-api-key: xxxx' ``` ### Response Scheme ```json { "data": ..., "block_height": 805712 } ``` The `block_height` indicates the latest indexed block height. ``` -------------------------------- ### Get Single Inscription Info Response (JSON) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/inscriptions Example of a successful JSON response for the 'Get Single Inscription Information' endpoint. It includes comprehensive details about the inscription, such as its name, ID, metadata, wallet, content URLs, and genesis information. Pricing fields like 'last_sale_price' and 'collection_floor_price' may be null or unavailable depending on the API tier. ```json { "data": { "inscription_name": "Runestone", "inscription_id": "5f3dafcdd142358b332e0939d37174b76472735df8df29325901d2c7d18a152ci19", "inscription_number": 64362443, "metadata": { "name": "Runestone" }, "wallet": "12dSsr8sFs21kpWaD2spSweFmyNzkZ8eRu", "mime_type": "model/gltf+json", "media_length": 0, "genesis_ts": 1710447063, "genesis_height": 834708, "genesis_fee": 1345, "output_value": 546, "satpoint": "5f3dafcdd142358b332e0939d37174b76472735df8df29325901d2c7d18a152c:20:0", "last_sale_price": null, "collection_name": "Runestone", "collection_slug": "runestone", "last_transfer_block_height": 834708, "utxo": "5f3dafcdd142358b332e0939d37174b76472735df8df29325901d2c7d18a152c:20", "parent_ids": [ "fdb2df5d2b16db1ebcbf09e2d23b3f4e417db44b58e712c99b61f26b52c7cbb5i0" ], "collection_floor_price": 3950000, "min_price": null, "ordswap_price": null, "magiceden_price": null, "ordinalswallet_price": null, "gammaio_price": null, "nostr_price": null, "odynals_price": null, "unisat_price": null, "ordinalsmarket_price": null, "okx_price": null, "content_url": "https://bis-ord-content.fra1.cdn.digitaloceanspaces.com/ordinals/5f3dafcdd142358b332e0939d37174b76472735df8df29325901d2c7d18a152ci19", "bis_url": "https://bestinslot.xyz/ordinals/inscription/5f3dafcdd142358b332e0939d37174b76472735df8df29325901d2c7d18a152ci19", "render_url": null, "byte_size": 0, "bitmap_number": null, "delegate": { "delegate_id": "ed76bf35918948b8b78be0e6397ad4916d926dd3d65679a8b7e67d8699a672a0i0", "render_url": "https://bis-ord-renders.fra1.cdn.digitaloceanspaces.com/renders/ed76bf35918948b8b78be0e6397ad4916d926dd3d65679a8b7e67d8699a672a0i0.png", "mime_type": "model/gltf+json", "content_url": "https://bis-ord-content.fra1.cdn.digitaloceanspaces.com/ordinals/ed76bf35918948b8b78be0e6397ad4916d926dd3d65679a8b7e67d8699a672a0i0", "bis_url": "https://bestinslot.xyz/ordinals/inscription/ed76bf35918948b8b78be0e6397ad4916d926dd3d65679a8b7e67d8699a672a0i0" } }, "block_height": 836798 } ``` -------------------------------- ### Testnet Environment Source: https://context7.com/context7/bestinslot_xyz/llms.txt Endpoints and utilities for development and testing purposes, including testnet and signet environments, and a BTC faucet. ```APIDOC ## Testnet Environment ### Description Use testnet or signet endpoints with the same API key for development. ### Endpoints #### Testnet4 Endpoint - **URL**: `https://testnet.api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test` - **Method**: GET #### Signet Endpoint - **URL**: `https://signet_api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test` - **Method**: GET #### Testnet BTC Faucet - **URL**: `https://testnet.api.bestinslot.xyz/v3/wallet/testnet_faucet?address=tb1p9ts4eu2s4adgjwumdmcu9qfw0hcavrh8m54tyrd39lkk7h4940yq2dmvzx` - **Method**: GET - **Description**: Provides testnet BTC to a specified address. Limited to 10 requests per 24 hours per API key. #### Headers for all testnet requests - **x-api-key** (string) - Required - Your API key. ### Request Examples ```bash # Testnet4 endpoint curl --location 'https://testnet.api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test' \ --header 'x-api-key: your_api_key_here' # Signet endpoint curl --location 'https://signet_api.bestinslot.xyz/v3/brc20/ticker_info?ticker=test' \ --header 'x-api-key: your_api_key_here' # Testnet BTC faucet (10 requests per 24h per key) curl --location 'https://testnet.api.bestinslot.xyz/v3/wallet/testnet_faucet?address=tb1p9ts4eu2s4adgjwumdmcu9qfw0hcavrh8m54tyrd39lkk7h4940yq2dmvzx' \ --header 'x-api-key: your_api_key_here' ``` ### Response Example (Faucet) #### Success Response (200) - **transfer_txid** (string) - The transaction ID of the testnet BTC transfer. ```json { "transfer_txid": "d32bb47c7728dbe89289694a54827ecabd8052a5e6c1475ac5a126986e79be1b" } ``` ``` -------------------------------- ### Get Bitcoin Transaction ID - Query Parameter Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/inscriptions This snippet shows the expected query parameter for retrieving Bitcoin transaction information. It specifies 'tx_id' as a required string parameter. ```json { "tx_id": "string" } ``` -------------------------------- ### API Authentication using cURL Source: https://context7.com/context7/bestinslot_xyz/llms.txt Demonstrates how to authenticate API requests using an API key in the request header with cURL. This is a general example applicable to all endpoints. ```bash curl --location 'https://api.bestinslot.xyz/v3/brc20/ticker_info?ticker=ordi' \ --header 'x-api-key: your_api_key_here' ``` -------------------------------- ### Example cURL Request for BRC-20 Ticker Info Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet This snippet demonstrates how to make a cURL request to the `brc20/ticker_info` endpoint, including the necessary API key in the request header. It shows the basic structure for interacting with the API. ```powershell curl --location 'https://api.bestinslot.xyz/v3/brc20/ticker_info?ticker=ordi' \ --header 'x-api-key: xxxx' ``` -------------------------------- ### Get Inscription Activity on Block - Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/inscriptions This snippet demonstrates a successful response for retrieving inscription activity on a specific block height. It returns an array of inscription data, including IDs, wallet addresses, transaction details, and sale information. ```json { "data": [ { "inscription_id": "b4f3838eecc0600531264e3dfcffbe997c73d77c7aa6fb7e9afc7cc20fad2fa9i0", "from_wallet": "bc1pz5sdw9zqek9vhc52w7du4yskwk8rmcz0m7wmqhfv24gv5tdqqzcqpwvdt0", "to_wallet": "bc1pk6t7u08vtpx7r79m8hhxrhsd9s7xpqck9aa75hlgq3fm8ww83n9s8hex94", "block_height": 805002, "sale_price": 417950, "new_satpoint": "fab1dbe521900e73a87b2410c84559320cbdf7b21415fbfc57a1d5dfbed662de:1:0", "ts": "2023-08-27T04:12:43.000Z", "marketplace_type": "magiceden", "inscription_name": "Ordinal Insider #29", "inscription_number": 921122, "collection_name": "Ordinal Insiders", "collection_slug": "ordinal-insiders", "tx_id": "fab1dbe521900e73a87b2410c84559320cbdf7b21415fbfc57a1d5dfbed662de" } ], "block_height": 815969 } ``` -------------------------------- ### Get Wallet Listings (Sample Query) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets Fetches an ordered list of Bitcoin inscriptions listed for sale by a specific wallet address. Supports sorting by minimum price and ordering by ascending or descending. Pagination is handled via 'offset' and 'count' parameters. ```url https://api.bestinslot.xyz/v3/wallet/listings?address=bc1par0t76nmjf55wp0rpzu58p97mzz6tf3cd67js077a2qx5ez8knlqfnccjq\&sort\_by=min\_price\&order=asc\&offset=0\&count=100 ``` -------------------------------- ### Get Bitmap Activity - JSON Response Example Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/bitmap This JSON structure represents a successful response from the /v3/bitmap/activity endpoint, detailing bitmap inscription, sale, or transfer events. It includes event-specific data such as inscription ID, wallet addresses, block height, sale price, transaction ID, and timestamps. The response is paginated and can be used to track blockchain activity. ```json { "data": [ { "inscription_id": "10490d6e63cdced2810011dcbb0952e26ca7a7bc609167487b76f567306dbfd5i0", "from_wallet": "bc1pn4zg6zwk256tlhgkxlj2jn6khnrtuynafw9cz6lrp6wvgmywkmusn6m8xd", "to_wallet": "bc1p4kdgatpw9sdawnjzt206yyu33uhxnfpnv476td8m0tt8rznnvxkqk49rvh", "block_height": 814057, "sale_price": 21242, "new_satpoint": "31226b1ea0acc7a46ff7b1a86745e88dab759deaf50836b62d044d5f17801bad:1:0", "ts": "2023-10-27T11:47:28.000Z", "marketplace_type": "magiceden", "tx_id": "31226b1ea0acc7a46ff7b1a86745e88dab759deaf50836b62d044d5f17801bad" } ], "block_height": 795035 } ``` -------------------------------- ### Get Wallet Collections API Endpoint Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets This GET endpoint retrieves an ordered list of collections associated with a specific wallet address. It supports sorting and ordering parameters. Availability depends on the API tier (Basic, Pro, Dedicated). ```http GET https://api.bestinslot.xyz/v3/wallet/collections?address=bc1pp5xk5dxklrfxk4yzdkel09yeqqczk5s3425zg9fj6p8qpm8axdes94yhu7&sort_by=inscription_count&order=desc ``` -------------------------------- ### GET /v3/brc20/wallet_activity Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/brc-20 Retrieves a list of deploy-inscribe, mint-inscribe, transfer-inscribe, and transfer-transfer activities for a given Bitcoin wallet. ```APIDOC ## GET /v3/brc20/wallet_activity ### Description Retrieves a list of deploy-inscribe, mint-inscribe, transfer-inscribe and transfer-transfer of a given bitcoin wallet. ### Method GET ### Endpoint https://api.bestinslot.xyz/v3/brc20/wallet_activity ### Parameters #### Query Parameters - **order** (string) - Required - asc, desc (ordered by timestamp) - **offset** (int) - Required - 0 <= offset <= 5k - **count** (int) - Required - 20 <= count <= 2000 - **wallet_addr** (string) - Required - Bitcoin wallet address ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **ticker** (string) - BRC-20 ticker - **event_type** (string) - Type of event (e.g., deploy-inscribe, mint-inscribe) - **to_wallet** (string) - Receiver wallet address - **block_height** (int) - Block height - **ts** (string) - Timestamp - **inscription_id** (string) - Inscription ID - **sale_price** (null) - Sale price (null if not applicable) - **unit_price** (null) - Unit price (null if not applicable) - **amount** (null) - Amount (null if not applicable) #### Response Example ```json { "data": [ { "ticker": "ordi", "event_type": "deploy-inscribe", "to_wallet": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06", "block_height": 779832, "ts": "2023-03-08T04:16:31.000Z", "inscription_id": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0", "sale_price": null, "unit_price": null, "amount": null } ], "block_height": 844736 } ``` ``` -------------------------------- ### Get Bitmap Holders - JSON Response Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/bitmap This JSON structure represents a successful response from the 'Get Bitmap Holders' endpoint. It includes an array of wallet addresses and their associated collected inscription IDs, along with the current block height. ```json { "data": [ { "wallet": "12ufzRLA89ZyLPTe6HCUnVGRtdNfr8tYXp", "inscription_ids": [ "5e7989591908aa5e1874545518b4b2d9ccfbde83f40a94340cc5fbd5d923b981i0", "b5eced1df647a5a55c2753d44dfb8976a5a7c6c0035f68c76c6a96bb60e14700i0", "689616aeeb568d3e93fae34563b2134b81fa46ebc58b32b45b26332b945f8569i0", "c7117a8e524b657b3f37b9d42d7fce5d62a920307e569448131cd3ab9cb2cb43i0", "d9875cf906b853a3204270bbc8f53a8054716ba3ffdc2da4d2a87e77631c473di0" ] }, ... ], "block_height": 795035 } ``` -------------------------------- ### Get Collection Sales Information (JSON Response) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/collections This snippet illustrates a successful JSON response for the 'Get Collection Sales Information' endpoint. It provides trading volume and sale count data aggregated over various time periods. The 'marketplace' field indicates the source of the data. ```json { "data": { "vol_3h": "9970000", "vol_6h": "45228879", "vol_9h": "82738348", "vol_12h": "94525896", "vol_1d": "140485613", "vol_3d": "995189800", "vol_7d": "2282078504", "vol_30d": "20435090360", "vol_total": "49541749144", "sale_count": 12274, "marketplace": "all" }, "block_height": 795035 } ``` -------------------------------- ### GET /v3/collection/market_info Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/changelog Retrieves market information for collections, including Unisat floor prices. ```APIDOC ## GET /v3/collection/market_info ### Description Retrieves market information for collections, including Unisat floor prices. ### Method GET ### Endpoint /v3/collection/market_info ### Parameters #### Query Parameters - **collection_slug** (string) - Optional - Filter by collection slug. - **limit** (integer) - Optional - The number of results to return. - **offset** (integer) - Optional - The number of results to skip. ``` -------------------------------- ### Get Wallet Listings Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets Returns an ordered list of listings for a given Bitcoin wallet. ```APIDOC ## Get Wallet Listings ### Description Returns an ordered list of listings for a given Bitcoin wallet. This endpoint is available for Pro and Dedicated plan users. ### Method GET ### Endpoint /v3/wallet/listings ### Parameters #### Query Parameters - **address** (string) - Required - The Bitcoin wallet address. - **sort_by** (string) - Optional - The field to sort the listings by. Possible values: `slug`, `inscription_count`. - **order** (string) - Optional - The order of sorting. Possible values: `asc`, `desc`. - **offset** (integer) - Optional - The number of listings to skip. Defaults to 0. - **count** (integer) - Optional - The number of listings to return. Defaults to 100. ### Request Example ``` GET https://api.bestinslot.xyz/v3/wallet/listings?address=bc1par0t76nmjf55wp0rpzu58p97mzz6tf3cd67js077a2qx5ez8knlqfnccjq&sort_by=min_price&order=asc&offset=0&count=100 ``` ### Response #### Success Response (200) - **data** (array) - An array of listing objects. - **collection_slug** (string) - The slug of the collection. - **inscription_ids** (array) - An array of inscription IDs. - **collection_info** (object) - Information about the collection. - **name** (string) - The name of the collection. - **slug** (string) - The slug of the collection. - **inscription_icon_id** (string) - The inscription ID of the collection icon. - **icon_url** (string) - The URL of the collection icon. - **icon_render_url** (string or null) - The render URL of the collection icon. - **bis_url** (string) - The BestInSlot URL for the collection. - **supply** (string) - The total supply of the collection. - **min_number** (integer) - The minimum inscription number in the collection. - **median_number** (integer) - The median inscription number in the collection. - **max_number** (integer) - The maximum inscription number in the collection. - **listed_count** (integer) - The number of items listed in the collection. - **floor_price** (integer) - The floor price of the collection. - **floor_price_ordswap** (integer or null) - The floor price on OrdSwap. - **floor_price_magiceden** (integer) - The floor price on Magic Eden. - **floor_price_ordinalswallet** (integer) - The floor price on OrdinalsWallet. - **floor_price_gammaio** (integer or null) - The floor price on Gamma.io. - **floor_price_ordynals** (integer or null) - The floor price on Ordynals. - **floor_price_unisat** (integer or null) - The floor price on UniSat. - **floor_price_ordinalsmarket** (integer or null) - The floor price on OrdinalsMarket. - **floor_price_okx** (integer) - The floor price on OKX. - **vol_3h_in_btc** (integer) - Trading volume in BTC in the last 3 hours. - **vol_24h_in_btc** (integer) - Trading volume in BTC in the last 24 hours. - **vol_7d_in_btc** (integer) - Trading volume in BTC in the last 7 days. - **vol_30d_in_btc** (integer) - Trading volume in BTC in the last 30 days. - **sale_cnt_7d** (integer) - Number of sales in the last 7 days. - **vol_total_in_btc** (number) - Total trading volume in BTC. - **sale_cnt_total** (integer) - Total number of sales. - **marketcap** (integer) - The market capitalization of the collection. - **block_height** (integer) - The current block height at the time of the request. #### Response Example ```json { "data": [ { "collection_slug": "rune_pizza", "inscription_ids": [ "a77c2fda458fc67028cb444b3b3fdcdf36b168d89ceb7286630d2fc76b21a714i292", "d8e56a07f5dc3b6ca8976502637aa50480f883ed89b46dedfcd3196a7e9e5b19i323", "3a94a50d3df80794c606fe1cca66d88cfcbacbe1ddafc2493d7da123ef19f4a6i771", "9fd85f3c8fdde5bd89525e4cfc0ad147555ef57a3f4afe01570905340e88699di1110" ], "collection_info": { "name": "Rune Piza", "slug": "rune_pizza", "inscription_icon_id": "https://creator-hub-prod.s3.us-east-2.amazonaws.com/ord-rune_pizza_pfp_1713024144812.jpeg", "icon_url": "https://creator-hub-prod.s3.us-east-2.amazonaws.com/ord-rune_pizza_pfp_1713024144812.jpeg", "icon_render_url": null, "bis_url": "https://bestinslot.xyz/ordinals/collection/rune_pizza", "supply": "10892", "min_number": 68699615, "median_number": 68705556, "max_number": 68713500, "listed_count": 823, "floor_price": 1530, "floor_price_ordswap": null, "floor_price_magiceden": 1530, "floor_price_ordinalswallet": 811921, "floor_price_gammaio": null, "floor_price_ordynals": null, "floor_price_unisat": null, "floor_price_ordinalsmarket": null, "floor_price_okx": 6000, "vol_3h_in_btc": 0, "vol_24h_in_btc": 0, "vol_7d_in_btc": 0, "vol_30d_in_btc": 0, "sale_cnt_7d": 0, "vol_total_in_btc": 23.96608198, "sale_cnt_total": 4921, "marketcap": 16664760 } } ], "block_height": 889397 } ``` #### Error Response (429) - Too Many Requests: Rate limit exceeded. ``` -------------------------------- ### Get Wallet Metadata (API Request) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/wallets This snippet demonstrates how to make a GET request to the BestInSlot API to retrieve wallet metadata. It requires a Bitcoin wallet address as a query parameter. The response includes inscription counts and the last transfer block height. ```http GET https://api.bestinslot.xyz/v3/wallet/metadata?address=bc1p4wj6n9c80zvrjwq3lke2n8esuv8rzw6ch0jlqfrlpanlyn3ftx2s6dgwec ``` -------------------------------- ### Get Collection Listings Response (JSON) Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/collections This JSON snippet shows a successful response for the Get Collection Listings endpoint. It returns an array of listings, each containing the inscription ID, minimum price across different platforms, and the owner's wallet address. The block height is also included. ```json { "data": [ { "inscription_id": "02696786f173f05e55b457d12ef41bfcc905acd6ee5c0c61b80d8679a4ea91c9i0", "min_price": 4284000, "ordswap_price": null, "magiceden_price": 4284000, "ordinalswallet_price": null, "gammaio_price": null, "nostr_price": null, "odynals_price": null, "unisat_price": null, "ordinalsmarket_price": null, "okx_price": null, "owner_wallet_addr": "bc1pg95hedhcnrv9gu595n7ysy4apu6c0cz9vrs08dxd59p7kn5zyv0s6zdv0p" }, ... ], "block_height": 803265 } ``` -------------------------------- ### API Categories Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet Overview of the different categories of API endpoints available. ```APIDOC ## API Categories - **Mempool:** `/mempool` - **Collections:** `/collections` - **Wallets:** `/wallets` - **Inscriptions:** `/inscriptions` - **Sats Names:** `/sats-names` - **BRC-20:** `/brc-20` - **Runes:** `/runes` - **Bitmap:** `/bitmap` - **BIP-322:** `/bip-322` - **Changelog:** `/changelog` ``` -------------------------------- ### Runes Batch Output Info Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/runes Retrieves runes information for multiple Bitcoin outputs in a single request. This endpoint is available for Basic, Pro, and Dedicated plans. ```APIDOC ## POST /v3/runes/batch_output_info ### Description Returns runes information about given bitcoin outputs. ### Method POST ### Endpoint https://api.bestinslot.xyz/v3/runes/batch_output_info ### Parameters #### Request Body - **queries** (array of strings) - Required - Array of outpoint strings. Maximum length: 100. ### Request Example ```json { "queries": [ "314e5e53024ec5860bd2fa2a4e85db2fc9097fcf58caa63f253bb4f86ad4b412:1", "0979edfb33fa380fb8c80e53809e9d865169ac6857688b31446d577d5f6df869:1", "200380702f43b2a6403bd9576c48e74e7cf184d5ead280eaa25a2d71be9cb2c8:1" ] } ``` ### Response #### Success Response (200) - **data** (array of objects) - Contains rune information for each queried output. - **pkscript** (string) - The public key script of the output. - **wallet_addr** (string) - The wallet address associated with the output. - **output** (string) - The outpoint identifier. - **rune_ids** (array of strings) - IDs of the runes associated with the output. - **balances** (array of strings) - Balances of the runes. - **spent** (boolean) - Indicates if the output has been spent. - **rune_names** (array of strings) - Names of the runes. - **spaced_rune_names** (array of strings) - Rune names with spacing. - **decimals** (array of numbers) - Decimal places for each rune balance. - **block_height** (number) - The block height at which this information was recorded. #### Response Example ```json { "data": [ { "pkscript": "512024034ada955f1716ed7833d56744bd08119355cf5b1bbdbc48e66bc357bdb3b7", "wallet_addr": "bc1pysp54k54tut3dmtcx02kw39apqgex4w0tvdmm0zgue4ux4aakwms3pumq8", "output": "4ee2151d7010574cadc749ce85ae813599c33fc62148a0352eaa946f2da1d2be:0", "rune_ids": [ "840000:22" ], "balances": [ "190000000000" ], "spent": false, "rune_names": [ "SATOSHINAKAMOTO" ], "spaced_rune_names": [ "SATOSHI•NAKAMOTO" ], "decimals": [ 8 ] } // ... more items ], "block_height": 840350 } ``` ``` -------------------------------- ### GET /v3/runes/listings Source: https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-and-runes-and-bitmap-v3-api-mainnet%2Btestnet%2Bsignet/changelog Retrieves active listings for Runes. ```APIDOC ## GET /v3/runes/listings ### Description Retrieves active listings for Runes. ### Method GET ### Endpoint /v3/runes/listings ### Parameters #### Query Parameters - **rune_id** (string) - Optional - Filter by rune ID. - **limit** (integer) - Optional - The number of results to return. - **offset** (integer) - Optional - The number of results to skip. ```