UniSat Open API

Welcome to the UniSat Open API Documentation.

UniSat Open APIs provide standardized RESTful interfaces for accessing blockchain data, ticker information, marketplace operations, and more. These APIs empower developers to build wallets, explorers, marketplaces, and other blockchain-integrated applications. We provide an online interactive Swagger UI for quick exploration and testing: https://open-api.unisat.io

Available API Documentation

Full API documentation: https://github.com/unisat-wallet/unisat-dev-docs

Recommended Reading: BTC Assets and Other Protocol Assets Overview

Blockchain Indexing API

API Category
Description
Documentation Link

Blockchain Level

Core blockchain and transaction indexing

Inscription Level

Indexing of inscriptions

brc20

Indexing and data for BRC20 tokens

Runes

Indexing for Runes tokens

Alkanes

Developer-friendly API built on Alkanes indexer

Collection

NFT collections indexing

Fractal

Fractal network related APIs

UniSat Services API

API Category
Description
Documentation Link

UniSat Inscribe

Inscription creation and management

brc20 Marketplace

BRC20 marketplace

Runes Marketplace

Runes marketplace

Alkanes Marketplace

Alkanes marketplace

Collection Marketplace

Ordinals Collection marketplace

Domain Marketplace

Ordinals Domain marketplace

brc20 Swap

Swap functionality for BRC20 tokens

CAT20 DEX

Decentralized exchange for CAT20 tokens


Apply for a UniSat API Key

Before you start using UniSat API, you need to apply for a UniSat API Key.

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.

How to Acquire a UniSat API Key: https://docs.unisat.io/dev-center/developer-center/how-to-acquire-a-unisat-api-key

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.


Usage

  1. Use the Swagger UI 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


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

Last updated