Runes Marketplace

Retrieve the list information of the market.

post

Authorizations

Body

filterobjectrequired

sortobjectrequired

startnumberrequired

The data is looked up from start

limitnumber · max: 100required

Limit the amount of data

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Default Response

Get information on listings, delistings, and sales.

post

Authorizations

Body

filterobjectrequired

startnumberrequired

limitnumber · max: 100required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Default Response

Create listing order.

post

Authorizations

Body

nftTypestringoptional

txidstringrequired

The txid of the rune utxo txid

indexstringrequired

The txid of the rune utxo index

initPricestringrequired

Set the initial total price

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

marketTypestring · enumrequired

Example: fixedPrice

Options: fixedPrice

btcAddressstringoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Default Response

Confirm listing order.

post

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

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-fractal.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

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumberoptional

The user sets the rate

nftAddressstringoptional

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

utxosobject[]optional

Custom utxo

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Create delisting order.

post

Authorizations

Body

auctionIdstringrequired

nftAddressstringoptional

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

btcPubkeystringoptional

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

utxosobject[]optional

Custom utxo

rbfbooleanoptional

offChainbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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",
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ],
    "rbf": true,
    "offChain": true
  }'

200

200

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

Default Response

Confirm delisting order.

post

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

offChainbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Authorizations

Body

auctionIdstringrequired

initPricestringrequired

unitPricestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Authorizations

Body

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

nftTypestringoptional

btcAddressstringoptional

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

utxosobject[]optional

Custom utxo

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Authorizations

Body

batchAuctionIdstringrequired

psbtstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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

Authorizations

Body

auctionIdsstring[]required

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

Authorizations

Body

auctionIdsstring[]required

bidPricesnumber[]required

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumberoptional

The user sets the rate

nftAddressstringoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

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

Authorizations

Body

bidIdstringrequired

psbtBidstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api-fractal.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