Runes Marketplace

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

POSThttps://open-api.unisat.io/v3/market/runes/auction/runes_types

Body

application/json

timeTypeenum

Optional: day1, day7, day30

day1day7day30

startnumber

limitnumber

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/runes_types', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "code": 0,
  "msg": "text",
  "data": {
    "BTCPrice": 0,
    "list": [
      {
        "tick": "text",
        "curPrice": 0,
        "changePrice": 0,
        "btcVolume": 0,
        "amountVolume": 0,
        "cap": "text",
        "warning": false
      }
    ]
  }
}

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

POSThttps://open-api.unisat.io/v3/market/runes/auction/runes_types_specified

Body

application/json

timeTypeenum

day1day7day30

tickstring

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/runes_types_specified', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "code": 0,
  "msg": "text",
  "data": {
    "tick": "text",
    "symbol": "text",
    "curPrice": 0,
    "changePrice": 0,
    "btcVolume": 0,
    "amountVolume": 0,
    "cap": "text",
    "capUSD": "text",
    "warning": false
  }
}

Retrieve the list information of the market.

POSThttps://open-api.unisat.io/v3/market/runes/auction/list

Body

application/json

filter*object

sort*object

start*number

The data is looked up from start

limit*number

Limit the amount of data

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "nftType": "brc20"
      },
      "sort": {},
      "start": 0,
      "limit": 0
    }),
});
const data = await response.json();

Response

200

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

Get information on listings, delistings, and sales.

POSThttps://open-api.unisat.io/v3/market/runes/auction/actions

Body

application/json

filter*object

start*number

limit*number

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {},
      "start": 0,
      "limit": 0
    }),
});
const data = await response.json();

Response

200

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

Create listing order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_put_on

Body

application/json

nftTypestring

inscriptionId*string

initPrice*string

Set the initial total price

unitPrice*string

Unit Price (for tick)

pubkey*string

User public key

marketType*enum

Example: "fixedPrice"

auctionfixedPrice

btcAddressstring

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

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inscriptionId": "text",
      "initPrice": "text",
      "unitPrice": "text",
      "pubkey": "text",
      "marketType": "fixedPrice"
    }),
});
const data = await response.json();

Response

200

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

Confirm listing order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_put_on

Body

application/json

auctionId*string

psbt*string

fromBase64boolean

Is Base64 format, the default is hex format

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "psbt": "text"
    }),
});
const data = await response.json();

Response

200

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

Return params before creating purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_bid_prepare

Body

application/json

auctionId*string

bidPrice*number

address*string

Bidder address

pubkey*string

Bidder pubkey

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_bid_prepare', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidPrice": 0,
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

200

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

Create purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_bid

Body

application/json

auctionId*string

bidPrice*number

address*string

Bidder address

pubkey*string

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

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

utxosarray of object

Custom utxo

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidPrice": 0,
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

200

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

Confirm purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_bid

Body

application/json

auctionId*string

bidId*string

psbtBid*string

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

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidId": "text",
      "psbtBid": "text"
    }),
});
const data = await response.json();

Response

200

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

Create delisting order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_put_off

Body

application/json

auctionId*string

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.

utxosarray of object

Custom utxo

rbfboolean

offChainboolean

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_put_off', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text"
    }),
});
const data = await response.json();

Response

200

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

Confirm delisting order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_put_off

Body

application/json

auctionId*string

psbt*string

fromBase64boolean

Is Base64 format, the default is hex format

offChainboolean

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_put_off', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "psbt": "text"
    }),
});
const data = await response.json();

Response

200

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

Create the order for price adjustment.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_modify_price

Body

application/json

auctionId*string

initPrice*string

unitPrice*string

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_modify_price', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "initPrice": "text",
      "unitPrice": "text"
    }),
});
const data = await response.json();

Response

200

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

Confirm the order for price adjustment.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_modify_price

Body

application/json

auctionId*string

psbt*string

fromBase64*boolean

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_modify_price', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "psbt": "text",
      "fromBase64": false
    }),
});
const data = await response.json();

Response

200

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

Create batch listing order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_batch_put_on

Body

application/json

unitPrice*string

Unit Price (for tick)

pubkey*string

User public key

nftTypestring

btcAddressstring

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

utxosarray of object

Custom utxo

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_batch_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "unitPrice": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

200

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

Confirm batch listing order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_batch_put_on

Body

application/json

batchAuctionId*string

psbt*string

fromBase64boolean

Is Base64 format, the default is hex format

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_batch_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "batchAuctionId": "text",
      "psbt": "text"
    }),
});
const data = await response.json();

Response

200

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

Return params before creating purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_batch_bid_prepare

Body

application/json

auctionIds*array of string

address*string

Bidder address

pubkey*string

Bidder pubkey

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_batch_bid_prepare', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionIds": [
        "text"
      ],
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

200

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

Create purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/create_batch_bid

Body

application/json

auctionIds*array of string

bidPrices*array of number

address*string

Bidder address

pubkey*string

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

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

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/create_batch_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionIds": [
        "text"
      ],
      "bidPrices": [
        0
      ],
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

200

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

Confirm purchase order.

POSThttps://open-api.unisat.io/v3/market/runes/auction/confirm_batch_bid

Body

application/json

bidId*string

psbtBid*string

fromBase64boolean

Is Base64 format, the default is hex format

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v3/market/runes/auction/confirm_batch_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "bidId": "text",
      "psbtBid": "text"
    }),
});
const data = await response.json();

Response

200

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