Get Orders Filter by Criteria
Request
GET https://custody-example-url/custody/v1/api/projects/{b_id}/orders
Parameters
Field | Type | Description |
---|---|---|
b_id | String | Business line ID |
start_timeOptional |
Integer | Start filter timestamp |
end_timeOptional |
Integer | End filter timestamp |
keywordOptional |
String | Keyword (order ID, account ID, wallet name. Wallet ID, order description, from address and to address) |
limitOptional |
Integer | 10 by default |
offsetOptional |
Integer | 0 by default |
sort_by_timeOptional |
String | Sort by time sequence (DESC by default) |
applicantOptional |
String[] | Maker |
coin_nameOptional |
String[] | Coin name Allowed Value: Refer to Cactus Symbol (For API) column in Supported Token |
chain_nameOptional |
String[] | Cactus chain name Allowed Value: Refer to Cactus Network Name (For API) column in Supported Token |
statusOptional |
String[] | Order status |
wallet_nameOptional |
String[] | Wallet name |
Response
Field | Type | Description |
---|---|---|
code | Integer | Response code |
message | String | Response message |
successful | Boolean | If the request is successful |
data | Object[] | Order data |
offset | Integer | offset |
list | Object[] | Order list |
domain_id | String | Enterprise ID |
bid | String | Business line ID |
exchange_rate | Decimal | Order exchange rate |
time_stamp | Long | Order creation timestamp |
order_no | String | Order ID |
applicant | String | Order maker |
business_name | String | Business line name |
coin_name | String | Asset name |
storage_type | String | Storage type(PRIME_HOT. PRIME_COLD. ENTERPRISE_HOT. ENTERPRISE_COLD) |
wallet_name | String | Wallet name |
wallet_code | String | Wallet ID |
amount | Decimal | Withdrawal amount |
original_amount | Decimal | Original Withdrawal amount |
miner_fee_rate | Decimal | Miner fee rate |
description | String | Order description |
from_address | String | From address |
gas_price | Decimal | Gas price(ETH Series) |
gas_limit | Decimal | Gas limit (ETH series) |
max_fee_per_gas | Decimal | max fee |
max_priority_fee_per_gas | Decimal | priority fee |
status | String | Order status(PROCESSING, PARTIALLY_FAILED, FAILED, ORDER_SEND_OUT, FINISHED, CANCELED) |
inner_status | String | Order inner status` |
order_dest_address_info_vo_list | Object[] | Order list |
dest_address | String | Recipient address |
-memo_type | String | memo type (MEMO_NONE, MEMO_TEXT, MEMO_HASH) |
-memo | String | memo |
origin_balance | Decimal | Origin Withdrawal amount |
balance | Decimal | Actual Withdrawal amount |
remark | String | Remark |
Response Example
{
"code": 0,
"message": "",
"data": {
"offset": 0,
"limit": 10,
"list": [
{
"domain_id": "a5b3f782c4e24c688eca60946442a75f",
"exchange_rate": 9768.36,
"time_stamp": 1582008785000,
"order_no": "666666000000073",
"applicant": "[email protected]",
"business_name": "BusinessLine001",
"coin_name": "BTC",
"storage_type": "PRIME_HOT",
"wallet_name": "MIX008",
"wallet_code": "CHBTC4813422686",
"amount": 10000,
"original_amount": 10000,
"miner_fee_rate": 1024,
"description": "",
"from_address": "",
"gas_price": null,
"gas_limit": null,
"order_dest_address_info_vo_list": [
{
"dest_address": "mioNv7xz1es2waP77gLQYypXesBbkT8BeX",
"memo_type": "MEMO_TEXT",
"memo": "text",
"origin_balance": 10000,
"balance": 10000,
"remark": ""
}
],
"status": "FINISHED",
"inner_status": "FINISHED",
"bid": "ed70ff75b1fe4994a3bd836befe0e87f"
}
],
"total": 1
},
"successful": true
}