Skip to content

Get List Of Trade Orders

Endpoint

GET https://api.mycactus.dev/custody/v1/api/projects/{b_id}/integrated/trade/orders
GET https://api.mycactus.com/custody/v1/api/projects/{b_id}/integrated/trade/orders

Parameters

Path Parameters

FieldTypeDescription
b_id
Required
StringBusiness line ID

Query Parameters

FieldTypeDescription
keyword
Optional
StringSearch (Order ID, financial officer)
base_coin
Optional
StringBase currency
quote_coin
Optional
StringQuote currency
side
Optional
StringTrade directions
Allowed values: BUY, SELL
statuses
Optional
String[]Order Status
trade_type
Optional
StringOrder Type
Allowed values: LIMIT (limit order), TOKEN (market order)
create_time_start
Optional
LongOrder creation time start time
create_time_end
Optional
LongOrder creation time end time
limit
Required
IntegerLimit
offset
Required
IntegerOffset

Response

Response Body

FieldTypeDescription
codeIntegerResponse code (0 = success)
messageStringResponse message
successfulBooleanWhether the request was successful
dataObjectOrder list data (see data object details below)

data (object)

FieldTypeDescription
offsetIntegerOffset
limitIntegerLimit
totalIntegerTotal number of records
metadataObjectMetadata
listObject[]Order list (see list object details below)

list (object)

FieldTypeDescription
bidStringBusiness line ID
order_noStringOrder ID
base_coinStringBase currency
quote_coinStringQuote currency
base_amountIntegerBase amount
quote_amountIntegerQuote amount
priceIntegerPrice
filled_priceIntegerTransaction price
filled_qtyIntegerTransaction base amount
filled_amountIntegerTransaction quote amount
statusStringTrade order status
Allowed values: PROCESSING (processing), PENDING (pending settlement), COMPLETE (complete), CANCELING (cancel), CANCEL_PART (partial success)
trade_typeStringTrade order type
Allowed values: LIMIT (limit order), TOKEN (market order)
sideStringTrade order directions
Allowed values: BUY, SELL
reasonStringReason for failure
create_timeLongCreate time
complete_timeLongComplete time

Response Example

{
  "code": 0,
  "data": {
    "limit": 0,
    "list": [
      {
        "bid": "string",
        "order_no": "string",
        "base_coin": "string",
        "quote_coin": "string",
        "base_amount": 0,
        "quote_amount": 0,
        "price": 0,
        "filled_price": 0,
        "filled_qty": 0,
        "filled_amount": 0,
        "status": "string",
        "trade_type": "string",
        "side": "string",
        "reason": "string",
        "complete_time": 1663686589524,
        "create_time": 1663657787000
      }
    ],
    "metadata": {},
    "offset": 0,
    "total": 0
  },
  "message": "string",
  "successful": true
}