To retrieve buy and sell orders, specify the orderTypes parameter as demonstrated below.
To filter by a specific portfolios or subaccounts, set the porfolioIds parameter.
Comma-separated list of portfolio IDs to filter by
Comma-separated list of currencies to filter by base_currency or quote_currency
Comma-separated list of currencies to filter by base_currency
Comma-separated list of currencies to filter by quote_currency
Comma-separated list of currencies to filter by main_currency (blockchain network)
Comma-separated list of order types to filter by. See details
Available options:
buy,
sell
Comma-separated list of statuses to filter by. See details
Available options:
new,
waiting-funds,
reserved,
working,
waiting-approve,
co-sign-require,
approved,
processing,
executed,
canceled,
rejected,
declining,
declined,
blocked,
action-required,
require-initializer-approve,
waiting-counterparty-approve,
require-counterparty-approve,
ready-for-settlement,
settled,
part-signed-tx-added,
full-signed-tx-added,
rejected-part-signed-tx-added,
rejected-full-signed-tx-added,
awaiting-settlement,
master-password-required,
manual-resolving,
error,
pending-atomic-settlement-confirmation,
atomic-settlement-reservation-completed
Filter by external order ID
Filter by transfer chain ID
Filter by blockchain transaction ID
Filter by updated date since timestamp
Filter by created date since timestamp
Filter by created date since timestamp
Filter by created date to timestamp
Filter by terminated date since timestamp
Filter by terminated date to timestamp
Comma-separated list of portfolio types to filter by. See details
Available options:
custody,
trading-vault,
trading,
external,
clearloop
Comma-separated list of portfolio types to exclude. See details
Available options:
custody,
trading-vault,
trading,
external,
clearloop
Amount of order in baseCurrency
Base currency of the order
The order ID in the external system
Additional order information
The ids of user who can approve an order. If not set, anybody with Approver permission can approve
Snapshot of a wallet available balance at the moment of order termination
Snapshot of a wallet balance at the moment of order termination
Available options:
send,
multi-withdraw,
account-set,
allowance,
smart-call,
multi-smart-call,
activate,
stake-delegation,
stake-nomination,
stake-undelegation,
complete-withdrawal,
stake-complete-deposit,
take-reward,
pool-creation,
edit-pool,
governance-vote,
unjail,
importance-transfer,
transfer-stake,
rebond-stake,
chill,
cross-chain-send
Indicates whether the order is a part of a ClearLoop
Unique client exchange's account identifier used for ClearLoop
The ids of user who has approved an order
The number of required approves for an order
Number of confirmations for a blockchain transaction
Settlement order type only applicable for settle orders. See details
Available options:
free-of-payment,
payment-vs-payment
The id of a deposit order where a withdraw was made to
The id of a deposit target where an order was made to
The description of the order
The estimated fees for an order
The currency in which the fee is denominated
The estimated time in milliseconds for the transaction to be confirmed
The fee per byte of the transaction
The gas limit for the transaction
The fee amount in the reporting currency
The number of bytes in the transaction
Withdraw is requested to be processed by external system. In that case we don't broadcast it to blockchain
Available options:
low,
medium,
high
List of addresses from which the deposit was made. This is an array because, on some blockchains like Bitcoin (BTC), the sending address can include multiple input UTXO addresses
The id of a counterparty where an order was made from
The object of a crypto address where an order was made from. Will be removed in the future. Use fromCryptoAddressId instead
Available options:
externally-owned-account,
internal-account,
smart-contract,
payable-smart-contract
Indicates, if an address is whitelisted
Indicates an address can be used for tokens on the same blockchain network
Available options:
smart-contract,
payable-smart-contract,
mining,
unknown,
self-hosted,
vasp
Extra information for an address
orders.extra.fromCryptoAddress. mainCurrency
Main currency of an address
Address memo (destination tag for XRP)
Portfolio ids, if address set for particular portfolios
Last updated Updated at timestamp
The id of a crypto address where an order was made from
The id of a portfolio where an order was made from
Indicates whether the fee should be included in the withdrawal amount or added on top of it
The id of an invoice where an order was made to
Withdraw memo (destination tag for XRP)
The remain list of next transfer targets
Available options:
external,
portfolio
Serialized data payload for a smart contract
Serialized list of unsigned transactions. For Ethereum only type 0 (legacy) transactions are supported
The snapshot of a base currency rate at the moment of order creation
The snapshot of a quote currency rate at the moment of order creation
For ETH Approve transaction store spender address
The snapshot of a base currency rate at the moment of order termination
The address where the funds should be transferred
The id of a counterparty where an order was made to
The object of a crypto address where an order was made to. Will be removed in the future. Use toCryptoAddressId instead
Available options:
externally-owned-account,
internal-account,
smart-contract,
payable-smart-contract
Indicates, if an address is whitelisted
Indicates an address can be used for tokens on the same blockchain network
Available options:
smart-contract,
payable-smart-contract,
mining,
unknown,
self-hosted,
vasp
Extra information for an address
orders.extra.toCryptoAddress. mainCurrency
Main currency of an address
Address memo (destination tag for XRP)
Portfolio ids, if address set for particular portfolios
Last updated Updated at timestamp
The id of a crypto address where an order was made to
The id of an invoice where an order was made to
The id of a portfolio where an order was made to
The amount of a quote currency in an order
The blockchain transaction id on an order
Data which needs to be passed to Copper Unlimited to sign the transaction
The id to identify orders, created as a part of the same order chain
The amount of fees for the order
The id of a withdraw order where a deposit was made from
Available options:
otc,
rfq
Blockchain network of a baseCurrency
Available options:
sell,
buy,
deposit,
withdraw,
multi-withdraw,
retrieved-deposit,
earn-reward,
cross-chain-deposit,
cross-chain-withdraw
Available options:
custody,
trading-vault,
trading,
external,
clearloop
The quote currency of the order (in case of a settle order)
Blockchain network of a quoteCurrency
Available options:
new,
waiting-funds,
reserved,
working,
waiting-approve,
co-sign-require,
approved,
processing,
executed,
canceled,
rejected,
declining,
declined,
blocked,
action-required,
require-initializer-approve,
waiting-counterparty-approve,
require-counterparty-approve,
ready-for-settlement,
settled,
part-signed-tx-added,
full-signed-tx-added,
rejected-part-signed-tx-added,
rejected-full-signed-tx-added,
awaiting-settlement,
master-password-required,
manual-resolving,
error,
pending-atomic-settlement-confirmation,
atomic-settlement-reservation-completed
Order termination timestamp
