# UniSat Open API

UniSat Open APIs provide standardized RESTful interfaces and an online interactive Swagger UI for quick exploration and testing: [https://open-api.unisat.io](https://open-api.unisat.io/)

<figure><img src="/files/OgbNXM9GC37xj7QBip1O" alt=""><figcaption></figcaption></figure>

### Available API Documentation

Full API documentatio&#x6E;**:** <https://github.com/unisat-wallet/unisat-dev-docs>

Recommended Reading: [BTC Assets and Other Protocol Assets Overview](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/btc-and-protocol-assets.md)

#### Blockchain Indexing API

<table><thead><tr><th width="201.25">API Category</th><th>Description</th><th>Documentation Link</th></tr></thead><tbody><tr><td>Blockchain Level</td><td>Core blockchain and transaction indexing</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/blockchain-indexer.md">blockchain-indexer.md</a></td></tr><tr><td>Inscription Level</td><td>Indexing of inscriptions</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/inscription-indexer.md">inscription-indexer.md</a></td></tr><tr><td>brc20</td><td>Indexing and data for BRC20 tokens</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/brc20-indexer.md">brc20-indexer.md</a></td></tr><tr><td>Runes</td><td>Indexing for Runes tokens</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/runes-indexer.md">runes-indexer.md</a></td></tr><tr><td>Alkanes</td><td>Developer-friendly API built on Alkanes indexer</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/alkanes-indexer.md">alkanes-indexer.md</a></td></tr><tr><td>Collection</td><td>NFT collections indexing</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/collection-indexer.md">collection-indexer.md</a></td></tr><tr><td>Fractal</td><td>Fractal network related APIs</td><td><a href="https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/fractal.md">fractal.md</a></td></tr></tbody></table>

#### UniSat Services API

| API Category           | Description                             | Documentation Link                                                                                                                               |
| ---------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| UniSat Inscribe        | Inscription creation and management     | [inscribe.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/inscribe.md)                             |
| brc20 Marketplace      | BRC20 marketplace                       | [brc20-marketplace.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/brc20-marketplace.md)           |
| Runes Marketplace      | Runes marketplace                       | [runes-marketplace.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/runes-marketplace.md)           |
| Alkanes Marketplace    | Alkanes marketplace                     | [alkanes-marketplace.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/alkanes-marketplace.md)       |
| Collection Marketplace | Ordinals Collection marketplace         | [collection-marketplace.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/collection-marketplace.md) |
| Domain Marketplace     | Ordinals Domain marketplace             | [domain-marketplace.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/domain-marketplace.md)         |
| brc20 Swap             | Swap functionality for BRC20 tokens     | [brc20-swap.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/brc20-swap.md)                         |
| CAT20 DEX              | Decentralized exchange for CAT20 tokens | [cat20-dex.md](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/open-api/auto-generated/docs/cat20-dex.md)                           |

***

### Apply for a UniSat API Key

\
Before you start using UniSat API, you need to apply for a UniSat API Key.&#x20;

We offer several plans: Free, Specialist, Enterprise, Custom, and Pay-as-you-go. Visit <https://developer.unisat.io/> and follow the on-page instructions to apply.<br>

How to Acquire a UniSat API Key: [https://docs.unisat.io/dev-center/developer-center/how-to-acquire-a-unisat-api-key](/developer-support/how-to-acquire-a-unisat-api-key.md)

Note: UniSat API can still be accessed without an API key. However, to ensure fair allocation of resources, we recommend including an API key in all requests. Requests made without a key, or with a free key, may face strict rate limits or even no response under high load.&#x20;

***

### Usage

1. Use the Swagger UI [https://open-api.unisat.io](https://open-api.unisat.io/) and read the documents <https://github.com/unisat-wallet/unisat-dev-docs> to test API calls.
2. Register at <https://developer.unisat.io/> and authenticate as required by each API.
3. Handle error codes and messages according to the [error codes documentation](https://github.com/unisat-wallet/unisat-dev-docs/blob/master/errors/README.md)

***

\
For any questions, support, or discussions, please reach out to us on Discord: <http://discord.gg/unisat>\
Thank you for using UniSat Open API!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.unisat.io/developer-support/unisat-open-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.