unisat-dev-docs

Alkanes MarketPlace API

This API provides endpoints for alkanes marketplace services

👉 View Swagger UI

---

📑 Table of Contents

Route	Summary
POST /v3/market/alkanes/auction/alkanes_types	Get statistical data
POST /v3/market/alkanes/auction/alkanes_types_specified	Get statistical data for specified alkanes.
POST /v3/market/alkanes/auction/list	Retrieve the list information of the market.
POST /v3/market/alkanes/auction/actions	Get information on listings, delistings, and sales.
POST /v3/market/alkanes/auction/create_put_on	Create listing order.
POST /v3/market/alkanes/auction/confirm_put_on	Confirm listing order.
POST /v3/market/alkanes/auction/create_bid_prepare	Return params before creating purchase order.
POST /v3/market/alkanes/auction/create_bid	Create purchase order.
POST /v3/market/alkanes/auction/confirm_bid	Confirm purchase order.
POST /v3/market/alkanes/auction/create_put_off	Create delisting order.
POST /v3/market/alkanes/auction/confirm_put_off	Confirm delisting order.
POST /v3/market/alkanes/auction/create_modify_price	Create the order for price adjustment.
POST /v3/market/alkanes/auction/confirm_modify_price	Confirm the order for price adjustment.
POST /v3/market/alkanes/auction/create_batch_put_on	Create batch listing order.
POST /v3/market/alkanes/auction/confirm_batch_put_on	Confirm batch listing order.
POST /v3/market/alkanes/auction/create_batch_bid_prepare	Return params before creating purchase order.
POST /v3/market/alkanes/auction/create_batch_bid	Create purchase order.
POST /v3/market/alkanes/auction/confirm_batch_bid	Confirm purchase order.

---

MarketPlace-Alkanes

Get statistical data

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

Description

Get statistical data, price, market capitalization, etc. for alkanes.

Response (200)

• code (number):
• msg (string):
• data (object):
  • BTCPrice (number):
  • list (array):
    • tick (string):
    • curPrice (number):
    • changePrice (number):
    • btcVolume (number):
    • amountVolume (number):
    • cap (string):
    • holders (integer):
    • transactions (integer):
    • warning (boolean):

---

Get statistical data for specified alkanes.

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

Description

Get statistical data, price, market capitalization, etc. for Alkanes.

Response (200)

• code (number):
• msg (string):
• data (object):
  • tick (string):
  • symbol (string):
  • curPrice (number):
  • changePrice (number):
  • btcVolume (number):
  • amountVolume (number):
  • cap (string):
  • capUSD (string):
  • deployTime (integer):
  • holders (integer):
  • number (integer):
  • transactions (integer):
  • warning (boolean):

---

Retrieve the list information of the market.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • list (array):
    • auctionId (string):
    • inscriptionId (string):
    • inscriptionNumber (number):
    • marketType (string):
    • address (string):
    • price (number):
    • nftType (string):
    • tick (string): Brc20 field
    • limit (number): Brc20 field
    • amount (number): Brc20 field
    • unitPrice (number): Brc20 field
  • total (number):
  • timestamp (number):

---

Get information on listings, delistings, and sales.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • list (array):
    • auctionId (string):
    • inscriptionId (string):
    • inscriptionNumber (number):
    • event (string):
    • price (number):
    • from (string):
    • to (string):
    • timestamp (number):
    • nftConfirmNum (number):
    • nftType (string):
    • endMsg (string): An error message generated by the order
    • newest (boolean): The update order generates multiple events
    • name (string): Brc20 filed
    • unitPrice (number): Brc20 filed
    • amount (number): Brc20 filed
    • domain (string): Domain filed
    • domainType (string): Domain filed

    • domainCategorys (array):

    • collectionId (string): Collection filed
    • collectionItemName (string): Collection filed
    • contentType (string): Collection filed
    • contentBody (string): Collection filed
    • attributes (array):
      • trait_type (string):
      • value (string):
  • total (number):

---

Create listing order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • auctionId (string):
  • psbt (string):
  • signIndexes (array):

---

Confirm listing order.

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

Response (200)

• code (number):
• msg (string):
• data (object):

---

Return params before creating purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • serverFee (number): Expected service fee.
  • serverReal (number): Real service fee.
  • serverFeeRate (number): Real service fee rate.
  • txSize (number): Estimated transaction size
  • nftValue (number): Satoshis carried by the inscription
  • feeRate (number): Network fee rate
  • availableBalance (number): Available confirmed balance for the user
  • allBalance (number): Available total balance for the user

---

Create purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • bidId (string):
  • psbtBid (string): Bid psbt
  • psbtBid2 (string): Auction mode is used, and the current empty string can be passed
  • psbtSettle (string): Auction mode is used, and the current empty string can be passed
  • serverFee (number): The service fee charged by the platform
  • networkFee (number): BTC network total fee
  • feeRate (number): BTC network fee rate
  • nftValue (number):
  • bidSignIndexes (array):

---

Confirm purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • txid (string): Transaction txid

---

Create delisting order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • psbt (string):
  • txSize (number):

  • btcSignIndexes (array):

  • nftSignIndexes (array):

---

Confirm delisting order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • txid (string):

---

Create the order for price adjustment.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • psbt (string):
  • signIndexes (array):

---

Confirm the order for price adjustment.

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

Response (200)

• code (number):
• msg (string):
• data (object):

---

Create batch listing order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • batchAuctionId (string):
  • psbt (string):
  • signIndexes (array):

---

Confirm batch listing order.

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

Response (200)

• code (number):
• msg (string):
• data (object):

---

Return params before creating purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • serverFee (number): Expected service fee.
  • serverReal (number): Real service fee.
  • serverFeeRate (number): Real service fee rate.
  • txSize (number): Estimated transaction size
  • feeRate (number): Network fee rate
  • availableBalance (number): Available confirmed balance for the user

  • validAuctionIds (array):

  • invalidAuctionIds (array):

---

Create purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • bidId (string):
  • psbtBid (string): Bid psbt
  • serverFee (number): The service fee charged by the platform
  • networkFee (number): BTC network total fee
  • feeRate (number): BTC network fee rate
  • bidSignIndexes (array):

---

Confirm purchase order.

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

Response (200)

• code (number):
• msg (string):
• data (object):
  • txid (string): Transaction txid

---