Get Order List

Get the orders associated with your API-KEY

get
/v2/inscribe/order/list

Get order list of current apikey

Authorizations
Query parameters
cursorintegerRequired

Start offset

Example: 0
sizeintegerRequired

Number of items returned

Example: 16
sortstring · enumOptional

Sort by (asc/desc)

Example: ascPossible values:
statusstring · enumOptional

Status of order

Possible values:
receiveAddressstringOptional

ReceiveAddress of order

clientIdstringOptional

ClientId of order

Responses
200

Successful operation

application/json
get
/v2/inscribe/order/list
GET /v2/inscribe/order/list?cursor=1&size=1 HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 0,
  "msg": "OK",
  "data": {
    "detail": [
      {
        "orderId": "",
        "status": "pending",
        "payAddress": "",
        "receiveAddress": "",
        "amount": 3000,
        "paidAmount": 1,
        "outputValue": 1,
        "feeRate": 1,
        "minerFee": 1,
        "serviceFee": 1,
        "devFee": 1,
        "files": [
          {
            "filename": "10000.sats",
            "inscriptionId": "",
            "status": "pending"
          }
        ],
        "count": 1,
        "pendingCount": 1,
        "unconfirmedCount": 0,
        "confirmedCount": 0,
        "createTime": 1693439128100,
        "refundTxid": "",
        "refundAmount": 1,
        "refundFeeRate": 1
      }
    ],
    "start": 1,
    "total": 1
  }
}

  • status (Optional) : pending/inscribing/minted/closed/refunded

  • receiveAddress (Optional): Filter by receive address

  • clientId (Optional): The clientId passed when creating an order is useful for filtering a certain user's orders.

https://open-api.unisat.io/swagger.html

Last updated