Skip to content

Get All Orders

Endpoint

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

Parameters

Path Parameters

Field Type Description

b_id
Required

String Business line ID

Query Parameters

FieldTypeDescription
start_time
Optional
IntegerStart filter timestamp
end_time
Optional
IntegerEnd filter timestamp
keyword
Optional
StringKeyword (order ID, account ID, wallet name, Wallet ID, order description, from address and to address)
limit
Optional
Integer10 by default
offset
Optional
Integer0 by default
sort_by_time
Optional
StringSort by time sequence (DESC by default)
applicant
Optional
String[]Maker
coin_name
Optional
String[]Coin name
Allowed Value: Refer to Coin Name (API) column in Supported Token
chain_name
Optional
String[]Cactus chain name
Allowed Value: Refer to Network Symbol column in Supported Token
status
Optional
String[]Order status
wallet_name
Optional
String[]Wallet name

Response

Response Body

Field Type Description
code Integer Response code (0 = success)
message String Response message
successful Boolean Whether the request was successful
data Object Order data (see data object details below)

data (object)

Field Type Description
offset Integer Offset
limit Integer Limit
total Integer Total number of records
list Object[] Order list (see list object details below)

list (object)

FieldTypeDescription
domain_idStringEnterprise ID
bidStringBusiness line ID
exchange_rateDecimalOrder exchange rate
exchange_rate_strStringOrder exchange rate in string format
main_wallet_codeStringMain wallet ID
typeStringOrder submission type
Allowed values: API, API_ETH_COLD_CONTRACT_WITHDRAW, API_TRON_COLD_CONTRACT_WITHDRAW, API_PRIME_NFT_TRANSFER
time_stampLongOrder creation timestamp
order_noStringOrder ID
serial_noStringOrder serial number
applicantStringOrder maker
business_nameStringBusiness line name
coin_nameStringAsset name
full_nameStringAsset full name (e.g. Tether USD)
storage_typeStringStorage type
Allowed values: PRIME_HOT, PRIME_COLD, ENTERPRISE_HOT, ENTERPRISE_COLD
wallet_typeStringWallet type
Allowed values: MIXED_ADDRESS, SEGREGATED_ADDRESS, DAPP_ADDRESS, DAPP_CUSTOM_ADDRESS
connect_typeStringDeFi chain used (applicable for DeFi orders)
wallet_nameStringWallet name
wallet_codeStringWallet ID
amountDecimalWithdrawal amount
amount_strStringWithdrawal amount in string format
original_amountDecimalOriginal withdrawal amount
original_amount_strStringOriginal withdrawal amount in string format
miner_feeDecimalMiner fee
miner_fee_strStringMiner fee in string format
miner_fee_rateDecimalMiner fee rate
miner_fee_rate_strStringMiner fee rate in string format
descriptionStringOrder description
from_addressStringFrom address
gas_priceDecimalGas price (ETH Series)
gas_price_strStringGas price in string format (ETH Series)
max_fee_per_gasDecimalMax fee
max_fee_per_gas_strStringMax fee in string format
max_priority_fee_per_gasDecimalPriority fee
max_priority_fee_per_gas_strStringPriority fee in string format
gas_limitDecimalGas limit (ETH series)
gas_limit_strStringGas limit in string format (ETH series)
order_dest_address_info_vo_listObject[]Order list (see order_dest_address_info_vo_list object for details below)
chainStringChain name
main_coinStringMain chain asset (e.g. TRX, ETH)
statusStringOrder status
Allowed values: PROCESSING, PARTIALLY_FAILED, FAILED, ORDER_SEND_OUT, FINISHED, CANCELED
inner_statusStringOrder inner status

order_dest_address_info_vo_list (object)

FieldTypeDescription
canceledBooleanWhether the order item is canceled
item_statusStringStatus of this particular order item (per destination address)
dest_addressStringRecipient address
origin_balanceDecimalOrigin withdrawal amount
origin_balance_strStringOrigin withdrawal amount in string format
balanceDecimalActual withdrawal amount
balance_strStringActual withdrawal amount in string format
remarkStringRemark
memo_typeStringMemo type
Allowed values: MEMO_NONE, MEMO_TEXT, MEMO_HASH
memoStringMemo
commentStringComment

Response Example

{
    "code": 0,
    "message": "",
    "data": {
        "offset": 0,
        "limit": 10,
        "list": [
            {
                "domain_id": "1e2fa188f5d44faca64c45485062e867",
                "exchange_rate": 1.001,
                "exchange_rate_str": "1.00100000",
                "main_wallet_code": "CHTRON5526471567",
                "type": "API",
                "time_stamp": 1760339667000,
                "order_no": "TESTAPP_003",
                "serial_no": "GVB1TESTAPP_003",
                "applicant": "test@abc.com",
                "business_name": "FOR API TEST",
                "coin_name": "USDTTRC",
                "full_name": "Tether USD",
                "storage_type": "PRIME_HOT",
                "wallet_type": "MIXED_ADDRESS",
                "connect_type": null,
                "wallet_name": "",
                "wallet_code": "CHTRON5526471577",
                "amount": 11000000,
                "amount_str": "11000000",
                "original_amount": 11000000,
                "original_amount_str": "11000000",
                "miner_fee": 1805200,
                "miner_fee_str": "1805200",
                "miner_fee_rate": null,
                "miner_fee_rate_str": null,
                "description": "",
                "from_address": "",
                "gas_price": 100,
                "gas_price_str": "100",
                "max_fee_per_gas": null,
                "max_fee_per_gas_str": null,
                "max_priority_fee_per_gas": null,
                "max_priority_fee_per_gas_str": null,
                "gas_limit": null,
                "gas_limit_str": null,
                "order_dest_address_info_vo_list": [
                    {
                        "canceled": false,
                        "item_status": "SUCCEEDED",
                        "dest_address": "TLBGbH11Ei8xo7rnJCRT9GeukrDeACkumD",
                        "origin_balance": 11000000,
                        "origin_balance_str": "11000000",
                        "balance": 11000000,
                        "balance_str": "11000000",
                        "remark": "test order item",
                        "memo_type": "",
                        "memo": "",
                        "comment": ""
                    }
                ],
                "chain": "TRON",
                "main_coin": "TRX",
                "status": "FINISHED",
                "inner_status": "FINISHED",
                "bid": "b4a25892d06542ba8fedb40e99d0c659"
            },
            {
                "domain_id": "1e2fa188f5d44faca64c45485062e867",
                "exchange_rate": 1.001,
                "exchange_rate_str": "1.00100000",
                "main_wallet_code": "CHTRON5526471567",
                "type": "API",
                "time_stamp": 1760339449000,
                "order_no": "TESTAPP_002",
                "serial_no": "LREXTESTAPP_002",
                "applicant": "test@abc.com",
                "business_name": "FOR API TEST",
                "coin_name": "USDTTRC",
                "full_name": "Tether USD",
                "storage_type": "PRIME_HOT",
                "wallet_type": "MIXED_ADDRESS",
                "connect_type": null,
                "wallet_name": "",
                "wallet_code": "CHTRON5526471577",
                "amount": 11,
                "amount_str": "11",
                "original_amount": 11,
                "original_amount_str": "11",
                "miner_fee": 2960200,
                "miner_fee_str": "2960200",
                "miner_fee_rate": null,
                "miner_fee_rate_str": null,
                "description": "",
                "from_address": "",
                "gas_price": 100,
                "gas_price_str": "100",
                "max_fee_per_gas": null,
                "max_fee_per_gas_str": null,
                "max_priority_fee_per_gas": null,
                "max_priority_fee_per_gas_str": null,
                "gas_limit": null,
                "gas_limit_str": null,
                "order_dest_address_info_vo_list": [
                    {
                        "canceled": false,
                        "item_status": "SUCCEEDED",
                        "dest_address": "TLBGbH11Ei8xo7rnJCRT9GeukrDeACkumD",
                        "origin_balance": 11,
                        "origin_balance_str": "11",
                        "balance": 11,
                        "balance_str": "11",
                        "remark": "test order item",
                        "memo_type": "",
                        "memo": "",
                        "comment": ""
                    }
                ],
                "chain": "TRON",
                "main_coin": "TRX",
                "status": "FINISHED",
                "inner_status": "FINISHED",
                "bid": "b4a25892d06542ba8fedb40e99d0c667"
            }
        ],
        "total": 2
    },
    "successful": true
}