> ## 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.

# Ordinals API

> The bestinslot.xyz Ordinals API has been retired — run OPI instead

<Warning>
  **The Best in Slot Ordinals API has been retired.**

  We no longer operate the hosted API at `api.bestinslot.xyz`. Instead, we recommend running [OPI (Open Protocol Indexer)](https://github.com/bestinslot-xyz/OPI) yourself — it is open source, self-hosted, and gives you full control over your own data.

  The API reference on this site is kept online for historical reference only.
</Warning>

## Migrating to OPI

[OPI](https://github.com/bestinslot-xyz/OPI) is our open-source indexing client for meta-protocols on Bitcoin. It is built on a modified version of `ord`, is modular, and has reorg protection built into every module.

OPI currently indexes:

* **BRC-20** — follows the official protocol rules and tracks all historical balance changes and events
* **Bitmap** — indexes bitmap-number and inscription-id pairs per the official specification
* **SNS (Sats Names)** — tracks name, domain and namespace registrations

Each module ships with its own REST API, so you can query block activity and events, wallet balances at a given height, block and cumulative hashes for verification, and protocol-specific lookups from your own infrastructure.

### What you'll need

* PostgreSQL
* Rust toolchain (to build `ord` and the BRC-20 indexer)
* Node.js (for the API services)
* Python 3 with virtual environment support

Setup instructions, including a step-by-step Ubuntu guide, are in the [OPI repository](https://github.com/bestinslot-xyz/OPI).

## Want to learn about our BRC-20 indexer?

The [BRC-20 Indexer Rules](/docs/brc-20-indexer-rules) still apply to the BRC-20 module in OPI:

[BRC-20 Indexer Rules](/docs/brc-20-indexer-rules)

## Looking for the old API reference?

The retired endpoint documentation remains available for reference:

[API Reference](/api-reference/overview)


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