unisat-dev-docs

Alkanes Marketplace API

This API provides endpoints for Alkanes marketplace services, including market statistics, listing search, activity history, and order preparation/submission for Alkanes assets.

👉 View Swagger UI


📑 Table of Contents

Route Summary
POST /v3/market/alkanes/auction/alkanes_types List Alkanes market statistics by time window
POST /v3/market/alkanes/auction/alkanes_types_specified Get market statistics for one Alkanes ticker
POST /v3/market/alkanes/auction/list Search active and ended Alkanes marketplace listings
POST /v3/market/alkanes/auction/actions List Alkanes marketplace listing, sale, and update events
POST /v3/market/alkanes/auction/create_put_on Create an Alkanes listing PSBT
POST /v3/market/alkanes/auction/confirm_put_on Publish a signed Alkanes listing
POST /v3/market/alkanes/auction/create_bid_prepare Estimate fees and balance for an Alkanes purchase
POST /v3/market/alkanes/auction/create_bid Create an Alkanes purchase PSBT
POST /v3/market/alkanes/auction/confirm_bid Submit a signed Alkanes purchase
POST /v3/market/alkanes/auction/create_put_off Create an Alkanes delisting PSBT
POST /v3/market/alkanes/auction/confirm_put_off Remove a listed Alkanes order
POST /v3/market/alkanes/auction/create_modify_price Create an Alkanes listing price-update PSBT
POST /v3/market/alkanes/auction/confirm_modify_price Apply a signed Alkanes listing price update
POST /v3/market/alkanes/auction/create_batch_put_on Create batch Alkanes listing PSBTs
POST /v3/market/alkanes/auction/confirm_batch_put_on Publish signed batch Alkanes listings
POST /v3/market/alkanes/auction/create_batch_bid_prepare Estimate fees and validate listings for batch Alkanes purchases
POST /v3/market/alkanes/auction/create_batch_bid Create batch Alkanes purchase PSBTs
POST /v3/market/alkanes/auction/confirm_batch_bid Submit signed batch Alkanes purchases

Marketplace-Alkanes

List Alkanes market statistics by time window

Method: POST
Path: /v3/market/alkanes/auction/alkanes_types
Swagger Link: View in Swagger UI

Description

Returns paginated market metrics for Alkanes tickers, including current price, price change, BTC and asset volume, market cap, holder count, transaction count, warning flag, and the BTC price used for valuation.

Request Body

Content-Type: application/json

Response (200)

Default Response


Get market statistics for one Alkanes ticker

Method: POST
Path: /v3/market/alkanes/auction/alkanes_types_specified
Swagger Link: View in Swagger UI

Description

Returns ticker-level marketplace metrics such as symbol, current price, price change, BTC and asset volume, cap in BTC and USD, deploy time, holder count, inscription number, transaction count, and warning flag.

Request Body

Content-Type: application/json

Response (200)

Default Response


Search active and ended Alkanes marketplace listings

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

Description

Returns paginated listing records with auction id, inscription id and number, seller address, price, ticker, amount, unit price, market type, and latest listing timestamp context.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


List Alkanes marketplace listing, sale, and update events

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

Description

Returns paginated marketplace activity records, including auction id, inscription id and number, event type, price, from/to addresses, timestamp, confirmation count, newest-event marker, and asset-specific metadata.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create an Alkanes listing PSBT

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

Description

Builds a fixed-price listing draft for an Alkanes UTXO and returns an auction id, PSBT, and wallet sign indexes. Review the asset UTXO, total price, unit price, public key, and receiving address before use.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Publish a signed Alkanes listing

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

Description

Confirms the signed listing PSBT for an auction id and activates the marketplace listing. The response is empty on success, so callers should verify state through listing or activity queries after confirmation.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Estimate fees and balance for an Alkanes purchase

Method: POST
Path: /v3/market/alkanes/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, real fee, fee rate, estimated transaction size, inscription satoshi value, network fee rate, available balance, and total balance.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create an Alkanes purchase PSBT

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

Description

Builds a purchase order for a listing and returns bid id, bid PSBT, optional auction-mode PSBT fields, platform fee, network fee, fee rate, inscription value, and wallet sign indexes.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Submit a signed Alkanes purchase

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

Description

Confirms the signed bid PSBT for an auction and bid id, then returns the settlement transaction id when the purchase is accepted.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create an Alkanes delisting PSBT

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

Description

Builds a delisting transaction for an auction id and returns PSBT, estimated transaction size, BTC sign indexes, and asset sign indexes. Optional inputs support custom UTXOs, RBF, off-chain cancellation, and multi-address wallets.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Remove a listed Alkanes order

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

Description

Confirms the signed delisting PSBT for an auction id and returns the cancellation transaction id when removal is completed or accepted.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create an Alkanes listing price-update PSBT

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

Description

Builds a PSBT to change an existing listing’s total and unit price, returning the signing payload and sign indexes for the specified auction id.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Apply a signed Alkanes listing price update

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

Description

Confirms the signed price-update PSBT for an auction id and updates the active listing price. The response is empty on success, so use listing or activity queries to verify the new price.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create batch Alkanes listing PSBTs

Method: POST
Path: /v3/market/alkanes/auction/create_batch_put_on
Swagger Link: View in Swagger UI

Description

Builds a batch listing draft for multiple Alkanes UTXOs and returns batch auction id, PSBT, and sign indexes. Verify every UTXO, shared unit price, public key, and receiving address before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Publish signed batch Alkanes listings

Method: POST
Path: /v3/market/alkanes/auction/confirm_batch_put_on
Swagger Link: View in Swagger UI

Description

Confirms a signed batch listing PSBT and activates all listings in the batch. The response is empty on success, so verify the published listings through list or activity endpoints.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Estimate fees and validate listings for batch Alkanes purchases

Method: POST
Path: /v3/market/alkanes/auction/create_batch_bid_prepare
Swagger Link: View in Swagger UI

Description

Calculates batch purchase preparation data for auction ids, including service fee, real fee, fee rate, estimated transaction size, network fee rate, available balance, valid auction ids, and invalid auction ids.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create batch Alkanes purchase PSBTs

Method: POST
Path: /v3/market/alkanes/auction/create_batch_bid
Swagger Link: View in Swagger UI

Description

Builds batch purchase orders for multiple auction ids and bid prices, returning bid id, bid PSBT, platform fee, network fee, fee rate, and wallet sign indexes.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Submit signed batch Alkanes purchases

Method: POST
Path: /v3/market/alkanes/auction/confirm_batch_bid
Swagger Link: View in Swagger UI

Description

Confirms the signed batch bid PSBT and returns the settlement transaction id when the batch purchase is accepted.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response