BRC20 Marketplace

Get tick k line.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/brc20_kline

Body

application/json

tick*string

timeStart*number

Start time range

timeEnd*number

End time range

timeStep*number

Time granularity, such as milliseconds for a 5-minute interval

Response

200

Default Response

Body

application/json

code*number

msg*string

data*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api-fractal.unisat.io/v3/market/brc20/auction/brc20_kline', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tick": "text",
      "timeStart": 0,
      "timeEnd": 0,
      "timeStep": 0
    }),
});
const data = await response.json();

Response

200

{
  "code": 0,
  "msg": "text",
  "data": [
    {
      "price": 0,
      "timestamp": 0
    }
  ]
}

Parameter Description

• tick: BRC-20 tick

• timeStart: The starting timestamp, measured in milliseconds.

• timeEnd: The ending timestamp, measured in milliseconds.

• timeStep: Represents the interval between each data point, measured in milliseconds.

Additionally, there are the following limitations on the requested parameters.

(timeEnd-timeStart)/timeStep <= 2016

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

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/brc20_types

Body

application/json

tickLenenum

Example: 4

45

timeTypeenum

Optional: day1, day7, day30

day1day7day30

ticksarray of string

Specify a list of ticks

startnumber

limitnumber

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api-fractal.unisat.io/v3/market/brc20/auction/brc20_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"
      }
    ],
    "deploy": [
      {
        "tick": "text",
        "curPrice": 0,
        "changePrice": 0,
        "btcVolume": 0,
        "amountVolume": 0,
        "cap": "text"
      }
    ],
    "cap": [
      {
        "tick": "text",
        "curPrice": 0,
        "changePrice": 0,
        "btcVolume": 0,
        "amountVolume": 0,
        "cap": "text"
      }
    ]
  }
}

The optional values for timeType are day1, day7, day30.

ticks can be used to filter the "list," allowing it to return only the ticks that are needed.If the ticks field is not provided, all BRC20 data will be returned.

In the returned fields of this interface, only the "list" field needs attention. The "deploy" and "cap" fields are included solely for display purposes on certain pages of UniSat Marketplace. Filtering the fields will not affect "deploy" and "cap"; they will always be returned.

Use start and limit

Use ticks

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

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/brc20_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-fractal.unisat.io/v3/market/brc20/auction/brc20_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",
    "curPrice": 0,
    "changePrice": 0,
    "btcVolume": 0,
    "amountVolume": 0
  }
}

The optional values for timeType are day1, day7, day30

Bind btcAddress and nftAddress.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/bind

Body

application/json

btcAddress*string

nftAddress*string

sign*string

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

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

Response

200

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

By default, a user's address A is used for both payment and receiving inscriptions. However, for some wallets, such as the xverse and hiro wallets, different addresses are used to store BTC and inscriptions. This method allows the wallet to use address A for payments and address B for receiving inscriptions.

import {signMessage} from "sats-connect"

const paymentAddress = "";
const ordinalsAddress = "";

const toSignStr = `Please confirm that\nPayment Address: ${paymentAddress}\nOrdinals Address: ${ordinalsAddress}`

// for xverse
signMessage({
    payload:{
        address: ordinalsAddress,
        message: toSignStr,
        network:{
            type: "Mainnet"
        }
    },
    onFinish:(signature)=>{
        axios.post('/v3/market/brc20/auction/bind', {
            btcAddress: paymentAddress,
            nftAddress: ordinalsAddress,
            sign:signature
        })

    }
}

Retrieve the list information of the market.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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
  }
}

Retrieve inscription information, including brc20, names, collection. It is necessary to first determine the inscription type before calling the relevant services.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/inscription_info

Body

application/json

inscriptionId*string

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

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

Response

200

{
  "code": 0,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "inscriptionId": "text",
    "inscriptionNumber": 0,
    "marketType": "fixedPrice",
    "address": "text",
    "price": 0,
    "notSupport": false,
    "verification": false,
    "nftType": "text",
    "tick": "text",
    "limit": 0,
    "amount": 0,
    "unitPrice": 0,
    "collectionId": "text",
    "contentType": "text",
    "contentBody": "text",
    "collectionItemName": "text",
    "collectionHighResImgUrl": "text",
    "collectionName": "text",
    "notOnSale": false,
    "domain": "text",
    "domainHex": "text",
    "domainType": "sats",
    "utxo": {}
  }
}

Get the basic listing information of the specified inscription list

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/auction/inscription_info_list

Body

application/json

addressstring

inscriptionIdsarray of string

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api-fractal.unisat.io/v3/market/brc20/auction/inscription_info_list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
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",
        "status": "text"
      }
    ]
  }
}

Create listing order.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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
    ]
  }
}

• btcAddress: (Optional) Only for multi-address wallet, such as Xverse, hiro. To specifies the BTC receive address

Confirm listing order.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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
  }
}

• serverFee: Service Fee

• serverReal: The service fee after deducting various discounts.

• serverFeeRate: Service fee rate

• txSzie: The virtual size of this transaction.

• nftValue: Satoshis in the inscription

• feeRate: The current accepted minimum network fee rate.

• availableBalance：BTC balance available for constructing transactions."

Create purchase order.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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
    ]
  }
}

Create the order for price adjustment.

POSThttps://open-api-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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-fractal.unisat.io/v3/market/brc20/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": {}
}