# Open API Documentation

{% hint style="info" %} <mark style="color:orange;">Please read</mark> [developer-service-legal-disclaimer](https://docs.unisat.io/developer-support/developer-service-legal-disclaimer "mention") <mark style="color:orange;">before using the OpenAPI below.</mark>
{% endhint %}

<figure><img src="https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FrItWXkDwExIiAXvWKX8M%2F20240516-175257.png?alt=media&#x26;token=e1bf87fe-af60-47e9-a6d0-6342967180b0" alt=""><figcaption></figcaption></figure>

### Overview

UniSat Developer Service is open to community developers, allowing you to explore the world of Bitcoin and ordinals. You can deploy your own inscribing services, build wallet applications, develop browsers, and much more using the API.

### Getting an API Key

To use the OpenAPI, please register and log in at the [UniSat Developer Center](https://developer.unisat.io). Once registered, you can directly obtain a free-plan API key through the developer center.<br>

When you obtain the API key, please add it to the request header with the `Authorization` format as follows:

```bash
curl -X 'GET' \
  'https://open-api.unisat.io/v1/indexer/blockchain/info' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'
```

### Endpoint URLs

<table><thead><tr><th>Network</th><th width="316">URL</th><th>Swagger</th></tr></thead><tbody><tr><td>Mainnet</td><td>https://open-api.unisat.io<br><br>https://open-api-s1.unisat.io (Only WhiteList)<br></td><td><a href="https://open-api.unisat.io/swagger.html">https://open-api.unisat.io/swagger.html</a></td></tr><tr><td>Testnet</td><td>https://open-api-testnet.unisat.io</td><td><a href="https://open-api-testnet.unisat.io/swagger.html">https://open-api-testnet.unisat.io/swagger.html</a></td></tr></tbody></table>

### Rate Limits

| API Tier | Rate Limit                             |
| -------- | -------------------------------------- |
| Free     | 5 calls/second , up to 2,000 calls/day |

{% hint style="info" %}
If you require higher limits than those provided by our free plan, you can directly purchase a higher-tier plan through the [UniSat Developer Center](https://developer.unisat.io/plan).
{% endhint %}

### Issues & Feature Requests

For issue reports and feature requests, please visit the repository below:

* <https://github.com/unisat-wallet/unisat-dev-support/issues>


---

# 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/open-api-documentation.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.