> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bestinslot.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

<Warning>
  **This API has been retired.** The hosted endpoints at `api.bestinslot.xyz` are no longer operated, and new API keys are not being issued.

  Run [OPI (Open Protocol Indexer)](https://github.com/bestinslot-xyz/OPI) instead — our open-source, self-hosted indexer for BRC-20, Bitmap and SNS, with a REST API per module. See the [introduction](/docs/introduction) for what it covers and what you need to run it.

  The pages below are kept online for historical reference only.
</Warning>

### Rate Limiting

There were 4 API-Key categories: `Basic`, `Pro`, `Enterprise` and `Dedicated`. Some endpoints were only available in some plans. Free plan and trial keys were rate limited with daily limits, all other plans used monthly limits. New API keys are no longer issued.

Endpoints' API-Key-Tier availabilities are written for each endpoint in documentation.

Expired API-Keys automatically turn into Free-Tier API Key.

### General Usage Information

* API Key should be sent in `x-api-key` header.
* Offset is limited to 5000 for most endpoints. Some endpoints may have increased offset limit or may not have an offset limit (such as `brc20/holders`), please see the parameter list to check limits.
* Maximum count value is 100 for most endpoints. Some endpoints may have increased count limit (such as `brc20/holders`), please see the parameter list to check limits.
* Offset and count must be a multiple of 20.

An example curl request to `brc20/ticker_info` with an API Key:

```powershell theme={null}
curl --location 'https://api.bestinslot.xyz/v3/brc20/ticker_info?ticker=ordi' \
--header 'x-api-key: xxxx'
```

### **Response Scheme**

```
{
    "data": ... ,
    "block_height": 805712
}
```

Here, block\_height in the response indicates the **latest indexed** block height.

### Testnet & Signet API

To use our full API running on Bitcoin Testnet4 or Signet, just use `https://testnet.api.bestinslot.xyz` or `https://signet_api.bestinslot.xyz` respectively on your requests. Same API-Keys can be used on testnet4 and signet.

## Categories

* [Mempool](/api-reference/mempool)
* [Collections](/api-reference/collections)
* [Wallets](/api-reference/wallets)
* [Inscriptions](/api-reference/inscriptions)
* [Sats Names](/api-reference/sats-names)
* [BRC-20](/api-reference/brc-20)
* [Runes](/api-reference/runes)
* [Bitmap](/api-reference/bitmap)
* [BIP-322](/api-reference/bip-322)
* [Changelog](/api-reference/api-changelog)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.