Collection Marketplace

Return a summary of collection.

post
/v3/market/collection/auction/collection_statistic
Authorizations
Body
collectionIdstringRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/collection_statistic
POST /v3/market/collection/auction/collection_statistic HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "collectionId": "text"
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "collectionId": "text",
    "name": "text",
    "desc": "text",
    "icon": "text",
    "iconContentType": "text",
    "btcValue": 1,
    "floorPrice": 1,
    "pricePercent": 1,
    "listed": 1,
    "total": 1,
    "supply": 1,
    "twitter": "text",
    "discord": "text",
    "website": "text",
    "verification": true
  }
}

Return a summary of collection.

post
/v3/market/collection/auction/collection_statistic_list
Authorizations
Body
startnumberRequired
limitnumber · max: 21Required
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/collection_statistic_list
POST /v3/market/collection/auction/collection_statistic_list HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "filter": {
    "timeType": "text",
    "name": "text",
    "collections": [
      "text"
    ]
  },
  "start": 1,
  "limit": 1
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "name": "text",
        "desc": "text",
        "icon": "text",
        "iconContentType": "text",
        "btcValue": 1,
        "floorPrice": 1,
        "pricePercent": 1,
        "listed": 1,
        "total": 1,
        "supply": 1,
        "twitter": "text",
        "discord": "text",
        "website": "text",
        "verification": true
      }
    ],
    "total": 1
  }
}

  • timeType : enum day1, day7, day30

  • name (optional): Used for searching by a given name.

  • collections (optional): Array of collectionId

Get the collection statistics information at a certain address

post
/v3/market/collection/auction/collection_summary
Authorizations
Body
firstCollectionIdstringOptional
addressstringRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/collection_summary
POST /v3/market/collection/auction/collection_summary HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "firstCollectionId": "text",
  "address": "text"
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "icon": "text",
        "iconContentType": "text",
        "name": "text",
        "total": 1
      }
    ]
  }
}

Get the list details of a certain collection at a certain address

post
/v3/market/collection/auction/collection_inscriptions
Authorizations
Body
collectionIdstringRequired
addressstringRequired
startnumberRequired
limitnumberRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/collection_inscriptions
POST /v3/market/collection/auction/collection_inscriptions HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "collectionId": "text",
  "address": "text",
  "start": 1,
  "limit": 1
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "collectionName": "text",
        "collectionItemName": "text",
        "collectionHighResImgUrl": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "contentType": "text",
        "listed": true
      }
    ],
    "total": 1
  }
}

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

post
/v3/market/collection/auction/inscription_info
Authorizations
Body
inscriptionIdstringRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/inscription_info
POST /v3/market/collection/auction/inscription_info HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "inscriptionId": "text"
}
200

Default Response

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

Get the basic listing information of the specified inscription list

post
/v3/market/collection/auction/inscription_info_list
Authorizations
Body
addressstringOptional
inscriptionIdsstring[]Optional
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/inscription_info_list
POST /v3/market/collection/auction/inscription_info_list HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "address": "text",
  "inscriptionIds": [
    "text"
  ]
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "nftType": "text",
        "status": "text"
      }
    ]
  }
}

Retrieve the list information of the market.

post
/v3/market/collection/auction/list
Authorizations
Body
startnumberRequired

The data is looked up from start

limitnumber · max: 100Required

Limit the amount of data

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/list
POST /v3/market/collection/auction/list HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "tick": "text",
    "minPrice": 1,
    "maxPrice": 1,
    "nftConfirm": true,
    "isEnd": true,
    "domainType": "sats",
    "domainMinLength": 1,
    "domainMaxLength": 1,
    "domainCategory": "text",
    "domainFuzzy": "text",
    "collectionId": "text",
    "collectionFuzzy": "text",
    "all": true
  },
  "sort": {
    "unitPrice": 1,
    "onSaleTime": 1,
    "initPrice": 1,
    "inscriptionNumber": 1
  },
  "start": 1,
  "limit": 1
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "notSupport": true,
        "verification": true,
        "nftType": "text",
        "tick": "text",
        "limit": 1,
        "amount": 1,
        "unitPrice": 1,
        "collectionId": "text",
        "contentType": "text",
        "contentBody": "text",
        "collectionItemName": "text",
        "collectionHighResImgUrl": "text",
        "collectionName": "text",
        "notOnSale": true,
        "domain": "text",
        "domainHex": "text",
        "domainType": "sats"
      }
    ],
    "total": 1,
    "timestamp": 1
  }
}

Get information on listings, delistings, and sales.

post
/v3/market/collection/auction/actions
Authorizations
Body
startnumberRequired
limitnumber · max: 100Required
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/actions
POST /v3/market/collection/auction/actions HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "inscriptionId": "text",
    "event": "Cancel",
    "tick": "text",
    "domainType": "text",
    "collectionId": "text"
  },
  "start": 1,
  "limit": 1
}
200

Default Response

{
  "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
  }
}

Create listing order.

post
/v3/market/collection/auction/create_put_on
Authorizations
Body
nftTypestringOptional
inscriptionIdstringRequired
initPricestringRequired

Set the initial total price

unitPricestringRequired

Unit Price (for tick)

pubkeystringRequired

User public key

marketTypestring · enumRequiredExample: fixedPricePossible values:
btcAddressstringOptional

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

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/create_put_on
POST /v3/market/collection/auction/create_put_on HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "nftType": "text",
  "inscriptionId": "text",
  "initPrice": "text",
  "unitPrice": "text",
  "pubkey": "text",
  "marketType": "fixedPrice",
  "btcAddress": "text"
}
200

Default Response

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

Confirm listing order.

post
/v3/market/collection/auction/confirm_put_on
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/confirm_put_on
POST /v3/market/collection/auction/confirm_put_on HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true
}
200

Default Response

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

Return params before creating purchase order.

post
/v3/market/collection/auction/create_bid_prepare
Authorizations
Body
auctionIdstringRequired
bidPricenumberRequired
addressstringRequired

Bidder address

pubkeystringRequired

Bidder pubkey

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/create_bid_prepare
POST /v3/market/collection/auction/create_bid_prepare HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "auctionId": "text",
  "bidPrice": 1,
  "address": "text",
  "pubkey": "text"
}
200

Default Response

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

Create purchase order.

post
/v3/market/collection/auction/create_bid
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

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/create_bid
POST /v3/market/collection/auction/create_bid HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "auctionId": "text",
  "bidPrice": 1,
  "address": "text",
  "pubkey": "text",
  "feeRate": 1,
  "nftAddress": "text",
  "utxos": [
    {
      "txid": "text",
      "index": 1
    }
  ]
}
200

Default Response

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

Confirm purchase order.

post
/v3/market/collection/auction/confirm_bid
Authorizations
Body
auctionIdstringRequired
bidIdstringRequired
psbtBidstringRequired
psbtBid2stringOptional

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

psbtSettlestringOptional

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

fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/confirm_bid
POST /v3/market/collection/auction/confirm_bid HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "auctionId": "text",
  "bidId": "text",
  "psbtBid": "text",
  "psbtBid2": "text",
  "psbtSettle": "text",
  "fromBase64": true
}
200

Default Response

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

Create delisting order.

post
/v3/market/collection/auction/create_put_off
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.

rbfbooleanOptional
offChainbooleanOptional
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/create_put_off
POST /v3/market/collection/auction/create_put_off HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "auctionId": "text",
  "nftAddress": "text",
  "btcPubkey": "text",
  "utxos": [
    {
      "txid": "text",
      "index": 1
    }
  ],
  "rbf": true,
  "offChain": true
}
200

Default Response

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

Confirm listing order.

post
/v3/market/collection/auction/confirm_put_on
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/collection/auction/confirm_put_on
POST /v3/market/collection/auction/confirm_put_on HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true
}
200

Default Response

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

Confirm delisting order.

post
/v3/market/collection/auction/confirm_put_off
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

offChainbooleanOptional
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/confirm_put_off
POST /v3/market/collection/auction/confirm_put_off HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true,
  "offChain": true
}
200

Default Response

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

Create the order for price adjustment.

post
/v3/market/collection/auction/create_modify_price
Authorizations
Body
auctionIdstringRequired
initPricestringRequired
unitPricestringRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/create_modify_price
POST /v3/market/collection/auction/create_modify_price HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "auctionId": "text",
  "initPrice": "text",
  "unitPrice": "text"
}
200

Default Response

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

Confirm the order for price adjustment.

post
/v3/market/collection/auction/confirm_modify_price
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanRequired
Responses
200

Default Response

application/json
post
/v3/market/collection/auction/confirm_modify_price
POST /v3/market/collection/auction/confirm_modify_price HTTP/1.1
Host: open-api-fractal.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true
}
200

Default Response

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

Last updated