unisat-dev-docs

BRC20 Marketplace API

BRC-20 marketplace APIs for address binding, market discovery, listing inspection, activity history, and PSBT-based listing, purchase, delisting, and price update workflows.

👉 View Swagger UI


📑 Table of Contents

Route Summary
POST /v3/market/brc20/auction/bind_info Get marketplace payment and inscription addresses for an account
POST /v3/market/brc20/auction/brc20_kline Get BRC-20 marketplace price candles
POST /v3/market/brc20/auction/brc20_types Rank BRC-20 tickers by marketplace metrics
POST /v3/market/brc20/auction/brc20_types_specified Get marketplace metrics for selected BRC-20 tickers
POST /v3/market/brc20/auction/bind Bind marketplace payment and inscription addresses
POST /v3/market/brc20/auction/list Search BRC-20 token listings for sale
POST /v3/market/brc20/auction/inscription_info Get BRC-20 listing detail by inscription
POST /v3/market/brc20/auction/inscription_info_list Get BRC-20 listing details for multiple inscriptions
POST /v3/market/brc20/auction/actions List BRC-20 marketplace listing and sale events
POST /v3/market/brc20/auction/create_put_on Create a BRC-20 fixed-price listing PSBT
POST /v3/market/brc20/auction/confirm_put_on Publish a signed BRC-20 listing
POST /v3/market/brc20/auction/create_bid_prepare Estimate fees and balance for a BRC-20 purchase
POST /v3/market/brc20/auction/create_bid Create a BRC-20 purchase PSBT
POST /v3/market/brc20/auction/confirm_bid Submit a signed BRC-20 purchase
POST /v3/market/brc20/auction/create_put_off Create a BRC-20 delisting PSBT
POST /v3/market/brc20/auction/confirm_put_off Remove a signed BRC-20 listing
POST /v3/market/brc20/auction/create_modify_price Create a BRC-20 listing price-update PSBT
POST /v3/market/brc20/auction/confirm_modify_price Apply a signed BRC-20 listing price update

Marketplace-BRC20

Get marketplace payment and inscription addresses for an account

Method: POST
Path: /v3/market/brc20/auction/bind_info
Swagger Link: View in Swagger UI

Description

Returns the BTC payment address and NFT/inscription receiving address currently bound for BRC-20 marketplace trading. Use it before listing or buying to confirm which wallet addresses the marketplace will use.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get BRC-20 marketplace price candles

Method: POST
Path: /v3/market/brc20/auction/brc20_kline
Swagger Link: View in Swagger UI

Description

Returns time-series price points for a ticker over the requested time range and granularity. Use it to draw marketplace price charts or analyze short-term trading trends.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Rank BRC-20 tickers by marketplace metrics

Method: POST
Path: /v3/market/brc20/auction/brc20_types
Swagger Link: View in Swagger UI

Description

Returns paginated market statistics for BRC-20 tickers, including current price, price change, BTC volume, token volume, market cap, and featured deploy entries. Supports ticker length, time window, explicit ticker list, and pagination filters.

Request Body

Content-Type: application/json

Response (200)

Default Response


Get marketplace metrics for selected BRC-20 tickers

Method: POST
Path: /v3/market/brc20/auction/brc20_types_specified
Swagger Link: View in Swagger UI

Description

Returns market statistics for specific BRC-20 tickers, such as price, price change, volume, market cap, and related ticker metadata. Use it when the client already knows which tickers to compare or display.

Request Body

Content-Type: application/json

Response (200)

Default Response


Bind marketplace payment and inscription addresses

Method: POST
Path: /v3/market/brc20/auction/bind
Swagger Link: View in Swagger UI

Description

Records the BTC payment address and NFT/inscription receiving address pair used by BRC-20 marketplace workflows. Confirm both addresses carefully because later listing and purchase flows may rely on this binding.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Search BRC-20 token listings for sale

Method: POST
Path: /v3/market/brc20/auction/list
Swagger Link: View in Swagger UI

Description

Returns paginated marketplace listings with auction id, inscription id, seller address, ticker, token amount, total price, unit price, market type, and latest listing context. Use it to power order books, ticker detail pages, and buy-flow listing selection.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get BRC-20 listing detail by inscription

Method: POST
Path: /v3/market/brc20/auction/inscription_info
Swagger Link: View in Swagger UI

Description

Returns marketplace and asset metadata for one inscription, including whether it is listed, its auction context when available, ticker amount, price fields, owner or seller information, and inscription identifiers.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get BRC-20 listing details for multiple inscriptions

Method: POST
Path: /v3/market/brc20/auction/inscription_info_list
Swagger Link: View in Swagger UI

Description

Returns listing and asset metadata for a batch of inscription ids. Use it to hydrate search results, wallet views, or candidate listings without calling the single-inscription endpoint repeatedly.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


List BRC-20 marketplace listing and sale events

Method: POST
Path: /v3/market/brc20/auction/actions
Swagger Link: View in Swagger UI

Description

Returns paginated activity records for BRC-20 marketplace events such as listing, delisting, sale, claim, and price update. Records include auction id, inscription id, event type, price, addresses, timestamp, confirmation count, and ticker-specific metadata.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create a BRC-20 fixed-price listing PSBT

Method: POST
Path: /v3/market/brc20/auction/create_put_on
Swagger Link: View in Swagger UI

Description

Builds the seller-side listing draft for a transferable BRC-20 inscription and returns the auction id, PSBT, and signing indexes. Review the inscription id, ticker amount, total price, unit price, market type, public key, and payout address before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Publish a signed BRC-20 listing

Method: POST
Path: /v3/market/brc20/auction/confirm_put_on
Swagger Link: View in Swagger UI

Description

Submits the seller-signed listing PSBT for an auction id and activates the marketplace order. Success means the token amount can become visible for purchase, so verify the signed PSBT, price, ticker amount, seller address, and market type before calling.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Estimate fees and balance for a BRC-20 purchase

Method: POST
Path: /v3/market/brc20/auction/create_bid_prepare
Swagger Link: View in Swagger UI

Description

Calculates purchase preparation data for an auction id and bid price, including service fee, network fee, fee rate, estimated transaction size, inscription satoshi value, available balance, and total balance. Use it to decide whether a buy order can be created safely.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create a BRC-20 purchase PSBT

Method: POST
Path: /v3/market/brc20/auction/create_bid
Swagger Link: View in Swagger UI

Description

Builds the buyer-side order for a listed BRC-20 inscription and returns bid id, purchase PSBT, signing indexes, platform fee, network fee, fee rate, and inscription value. Confirm the auction id, bid price, buyer address, ticker amount, and total fees before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Submit a signed BRC-20 purchase

Method: POST
Path: /v3/market/brc20/auction/confirm_bid
Swagger Link: View in Swagger UI

Description

Confirms the signed purchase PSBT for an auction id and bid id, then returns the settlement transaction id when accepted. This can complete the transfer, so verify the PSBT, final price, ticker amount, buyer and seller addresses, and fee values before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create a BRC-20 delisting PSBT

Method: POST
Path: /v3/market/brc20/auction/create_put_off
Swagger Link: View in Swagger UI

Description

Builds the seller-side cancellation transaction for an active BRC-20 listing and returns the signing material needed to remove it. Review the auction id, owner addresses, listed ticker amount, fee settings, and returned signing payload before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Remove a signed BRC-20 listing

Method: POST
Path: /v3/market/brc20/auction/confirm_put_off
Swagger Link: View in Swagger UI

Description

Submits the signed delisting payload for an auction id and removes the listing when accepted. Verify the PSBT or signature payload, owner address, ticker amount, and target listing before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create a BRC-20 listing price-update PSBT

Method: POST
Path: /v3/market/brc20/auction/create_modify_price
Swagger Link: View in Swagger UI

Description

Builds signing material to change the total and unit price of an existing BRC-20 listing. Review the auction id, current ticker amount, current price, new price, seller address, and returned PSBT or sign indexes before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Apply a signed BRC-20 listing price update

Method: POST
Path: /v3/market/brc20/auction/confirm_modify_price
Swagger Link: View in Swagger UI

Description

Submits the signed price-update payload for an auction id and updates the active listing price when accepted. Verify the signed PSBT, ticker amount, seller address, and final total and unit prices before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response