Runes Marketplace

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

post

/v3/market/runes/auction/runes_types

Authorizations

Body

startnumber

limitnumber

timeTypeundefined · enum

Optional: day1, day7, day30

Options: day1, day7, day30

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/runes_types' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": 1,
    "limit": 1,
    "timeType": "day1"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "BTCPrice": 1,
    "list": [
      {
        "tick": "text",
        "curPrice": 1,
        "changePrice": 1,
        "btcVolume": 1,
        "amountVolume": 1,
        "cap": "text",
        "holders": 1,
        "transactions": 1,
        "warning": true
      }
    ]
  }
}

Default Response

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

post

/v3/market/runes/auction/runes_types_specified

Authorizations

Body

tickstring

timeTypestring · enum

Options: day1, day7, day30

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/runes_types_specified' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "tick": "text",
    "timeType": "day1"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "tick": "text",
    "symbol": "text",
    "curPrice": 1,
    "changePrice": 1,
    "btcVolume": 1,
    "amountVolume": 1,
    "cap": "text",
    "capUSD": "text",
    "deployTime": 1,
    "holders": 1,
    "number": 1,
    "transactions": 1,
    "warning": true
  }
}

Default Response

Retrieve the list information of the market.

post

/v3/market/runes/auction/list

Authorizations

Body

startnumberrequired

The data is looked up from start

limitnumber · max: 100required

Limit the amount of data

filterobjectrequired

sortobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": 1,
    "limit": 1,
    "filter": {
      "address": "text",
      "tick": "text",
      "minPrice": 1,
      "maxPrice": 1,
      "nftConfirm": true,
      "isEnd": true,
      "all": true,
      "nftType": "brc20"
    },
    "sort": {
      "unitPrice": 1,
      "onSaleTime": 1,
      "initPrice": 1,
      "inscriptionNumber": 1
    }
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "total": 1,
    "timestamp": 1,
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "nftType": "text",
        "tick": "text",
        "limit": 1,
        "amount": 1,
        "unitPrice": 1
      }
    ]
  }
}

Default Response

Get information on listings, delistings, and sales.

post

/v3/market/runes/auction/actions

Authorizations

Body

startnumberrequired

limitnumber · max: 100required

filterobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/actions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": 1,
    "limit": 1,
    "filter": {
      "address": "text",
      "inscriptionId": "text",
      "tick": "text",
      "nftType": "brc20",
      "event": "Cancel"
    }
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "total": 1,
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "price": 1,
        "from": "text",
        "to": "text",
        "timestamp": 1,
        "nftConfirmNum": 1,
        "endMsg": "text",
        "newest": true,
        "name": "text",
        "unitPrice": 1,
        "amount": 1,
        "domain": "text",
        "collectionId": "text",
        "collectionItemName": "text",
        "contentType": "text",
        "contentBody": "text",
        "event": "Listed",
        "nftType": "brc20",
        "domainType": "sats",
        "domainCategorys": [
          "Keyboard"
        ],
        "attributes": [
          {
            "trait_type": "text",
            "value": "text"
          }
        ]
      }
    ]
  }
}

Default Response

Create listing order.

post

/v3/market/runes/auction/create_put_on

Authorizations

Body

nftTypestring

inscriptionIdstringrequired

initPricestringrequired

Set the initial total price

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

btcAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive address

marketTypestring · enumrequired

Example: fixedPrice

Options: auction, fixedPrice

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "nftType": "text",
    "inscriptionId": "text",
    "initPrice": "text",
    "unitPrice": "text",
    "pubkey": "text",
    "btcAddress": "text",
    "marketType": "fixedPrice"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm listing order.

post

/v3/market/runes/auction/confirm_put_on

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

Return params before creating purchase order.

post

/v3/market/runes/auction/create_bid_prepare

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_bid_prepare' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidPrice": 1,
    "address": "text",
    "pubkey": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "serverFee": 1,
    "serverReal": 1,
    "serverFeeRate": 1,
    "txSize": 1,
    "nftValue": 1,
    "feeRate": 1,
    "availableBalance": 1,
    "allBalance": 1
  }
}

Default Response

Create purchase order.

post

/v3/market/runes/auction/create_bid

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address

utxosobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidPrice": 1,
    "address": "text",
    "pubkey": "text",
    "feeRate": 1,
    "nftAddress": "text",
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "bidId": "text",
    "psbtBid": "text",
    "psbtBid2": "text",
    "psbtSettle": "text",
    "serverFee": 1,
    "networkFee": 1,
    "feeRate": 1,
    "nftValue": 1,
    "bidSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm purchase order.

post

/v3/market/runes/auction/confirm_bid

Authorizations

Body

auctionIdstringrequired

bidIdstringrequired

psbtBidstringrequired

psbtBid2string

Auction mode is used, and the current empty string can be passed

psbtSettlestring

Auction mode is used, and the current empty string can be passed

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidId": "text",
    "psbtBid": "text",
    "psbtBid2": "text",
    "psbtSettle": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create delisting order.

post

/v3/market/runes/auction/create_put_off

Authorizations

Body

auctionIdstringrequired

nftAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address.

btcPubkeystring

(Optional) Only for multi-address wallet, such as Xverse, hiro. The public key used in the inscription of the order.

rbfboolean

offChainboolean

utxosobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "nftAddress": "text",
    "btcPubkey": "text",
    "rbf": true,
    "offChain": true,
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "txSize": 1,
    "btcSignIndexes": [
      1
    ],
    "nftSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm delisting order.

post

/v3/market/runes/auction/confirm_put_off

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

offChainboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true,
    "offChain": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create the order for price adjustment.

post

/v3/market/runes/auction/create_modify_price

Authorizations

Body

auctionIdstringrequired

initPricestringrequired

unitPricestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "initPrice": "text",
    "unitPrice": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm the order for price adjustment.

post

/v3/market/runes/auction/confirm_modify_price

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

Create batch listing order.

post

/v3/market/runes/auction/create_batch_put_on

Authorizations

Body

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

nftTypestring

btcAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive address

utxosobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_batch_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "unitPrice": "text",
    "pubkey": "text",
    "nftType": "text",
    "btcAddress": "text",
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "batchAuctionId": "text",
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm batch listing order.

post

/v3/market/runes/auction/confirm_batch_put_on

Authorizations

Body

batchAuctionIdstringrequired

psbtstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_batch_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "batchAuctionId": "text",
    "psbt": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

Return params before creating purchase order.

post

/v3/market/runes/auction/create_batch_bid_prepare

Authorizations

Body

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

auctionIdsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_batch_bid_prepare' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "pubkey": "text",
    "auctionIds": [
      "text"
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "serverFee": 1,
    "serverReal": 1,
    "serverFeeRate": 1,
    "txSize": 1,
    "feeRate": 1,
    "availableBalance": 1,
    "validAuctionIds": [
      "text"
    ],
    "invalidAuctionIds": [
      "text"
    ]
  }
}

Default Response

Create purchase order.

post

/v3/market/runes/auction/create_batch_bid

Authorizations

Body

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address

auctionIdsstring[]required

bidPricesnumber[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/create_batch_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "pubkey": "text",
    "feeRate": 1,
    "nftAddress": "text",
    "auctionIds": [
      "text"
    ],
    "bidPrices": [
      1
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "bidId": "text",
    "psbtBid": "text",
    "serverFee": 1,
    "networkFee": 1,
    "feeRate": 1,
    "bidSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm purchase order.

post

/v3/market/runes/auction/confirm_batch_bid

Authorizations

Body

bidIdstringrequired

psbtBidstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/runes/auction/confirm_batch_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "bidId": "text",
    "psbtBid": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response