unisat-dev-docs

UniSat OPEN API

Welcome to the UniSat Open API documentation repository. This directory contains API specifications and resources for programmatic access to the UniSat ecosystem services.

Overview

UniSat Open APIs provide standardized RESTful interfaces for accessing blockchain data, token information, marketplace operations, and more. These APIs empower developers to build wallets, explorers, marketplaces, and other blockchain-integrated applications.

Available API Documentation

Blockchain Indexing API

API Category	Description	Documentation Link
Blockchain Level	Core blockchain and transaction indexing	`blockchain-indexer.md`
Inscription Level	Indexing of inscriptions	`inscription-indexer.md`
BRC20	Indexing and data for BRC20 tokens	`brc20-indexer.md`
Runes	Indexing for Runes tokens	`runes-indexer.md`
Alkanes	Developer-friendly API built on Alkanes indexer	`alkanes-indexer.md`
Collection	NFT collections indexing	`collection-indexer.md`

UniSat Services API

API Category	Description	Documentation Link
UniSat Inscribe	Inscription creation and management	`inscribe.md`
BRC20 Marketplace	BRC20 marketplace	`brc20-marketplace.md`
Runes Marketplace	Runes marketplace	`runes-marketplace.md`
Alkanes Marketplace	Alkanes marketplace	`alkanes-marketplace.md`
Collection Marketplace	Ordinals Collection marketplace	`collection-marketplace.md`
Domain Marketplace	Ordinals Domain marketplace	`domain-marketplace.md`

Fractal Bitcoin Specific API

API Category	Description	Documentation Link
Fractal	Fractal network related APIs	`fractal.md`
BRC20 Swap	Swap functionality for BRC20 tokens	`brc20-swap.md`
CAT20 DEX	Decentralized exchange for CAT20 tokens	`cat20-dex.md`

Accessing API Documentation

We provide an online interactive Swagger UI for quick exploration and testing:

https://open-api.unisat.io

Alternatively, you can load the OpenAPI YAML files into popular API client tools such as Postman or Insomnia, or generate client SDKs for your preferred language.

Usage

Choose the API and version you want to work with.
Review the endpoint definitions, parameters, and response schemas in the OpenAPI YAML files or generated Markdown docs.
Use the Swagger UI or client tools to test API calls.
Authenticate as required by each API (refer to the security section).
Handle error codes and messages according to the error codes documentation.

Contact & Support

For questions, support, or discussions, please open an issue in this repository or contact UniSat developer support channels.

Thank you for using UniSat Open API!