Trades

Retrieving your executed trades, one record per trade.

One endpoint returns your executed trades:

POST /api/3/trades

One record per trade, whichever way it was executed — agreed with the brokerage desk or taken from a streamed price. The debits and credits behind it are transactions, and share the trade's tradeRef.

Both sides of a trade are on the record: tradedAmount is what you bought or sold, settlementAmount is what moves the other way.

Request

Every filter is optional. Sending none returns your most recent trades.

Field	Type	Required	Notes
`nonce`	string	Optional	A counter that must increase with each request. An alternative to `tonce`; send one or the other
`tonce`	string	Optional	The current Unix time in microseconds. Send this or `nonce` — a request with neither is rejected, and each value must be higher than the last one used by the key
`userUuid`	string	Optional	The user the credentials act for. Set automatically from the API key; sending it has no effect
`tradeRef`	string	Optional	Returns a single trade by its reference
`clientRef`	string	Optional	Returns trades carrying your own reference
`tradeState`	TradeState	Optional	Restricts the result to one state
`tradeClass`	TradeClass	Optional	Restricts the result to trades executed one way
`tradeSide`	TradeSide	Optional	Restricts the result to buys or to sells
`accountGroupUuid`	string	Optional	Restricts the result to one account group. Omitting it returns every trade your credentials can see
`from`	timestamp	Optional	Start of the period, as an ISO-8601 instant
`to`	timestamp	Optional	End of the period, as an ISO-8601 instant
`sortDirection`	SortDirection	Optional	Order of the result by execution time. Defaults to newest first
`max`	integer	Optional	How many records to return. Defaults to 50 — min 1, max 200
`offset`	integer	Optional	Index to start from, for paging

SortDirection

Value	Meaning
`ASC`	Oldest first
`DESC`	Newest first

Response

The response is a page of trades and the number available.

Field	Type	Notes
`data`	Trade[]	The matching trades
`total`	integer	How many trades match the filter in total, for paging

Trade

Field	Type	Notes
`uuid`	string	Identifier for the trade
`tradeRef`	string	Reference shared with the transactions this trade produced
`clientRef`	string	Your own reference, as supplied when the trade was made
`tradeSide`	TradeSide	Whether you bought or sold the traded amount
`tradeState`	TradeState	Where the trade has reached
`tradeClass`	TradeClass	How the trade was executed
`settlementAmount`	Money	What moves the other way — the contra-currency amount
`tradedAmount`	Money	What you bought or sold
`user`	string	The user that executed the trade
`accountGroup`	AccountGroup	The account group the trade belongs to
`settlementDate`	date	The date the trade settles
`quoteId`	string	The quote the trade was executed against
`beneficiary`	ParticipantRef	The party receiving on settlement, when the trade names one
`sender`	ParticipantRef	The party delivering, when the trade names one
`networkId`	string	The network settlement is expected over, for a digital asset
`executedPrice`	string	Price the trade executed at, as a string because it names both currencies
`executorLogin`	string	Who executed the trade
`paymentReason`	string	Reason recorded against the settlement
`createdAt`	timestamp	When the trade was created
`updatedAt`	timestamp	When the trade was last changed

Money

Field	Type	Notes
`amount`	decimal	The amount
`currency`	string	The currency it is denominated in

AccountGroup

Field	Type	Notes
`uuid`	string	Identifier for the account group
`name`	string	Name of the account group

ParticipantRef

A reference to a settlement party. The full record — bank accounts, wallets and verification state — is on settlement parties.

Field	Type	Notes
`uuid`	string	Identifier for the party
`name`	string	Name of the party

TradeSide

Stated from your side of the trade.

Value	Meaning
`BUY`	You bought the traded amount
`SELL`	You sold the traded amount

TradeState

Value	Meaning
`CANCELLED`	Cancelled, and nothing settles
`PROCESSED`	Settled
`PENDING_SETTLEMENT`	Executed, not yet settled

TradeClass

Value	Meaning
`OTC`	Agreed with the brokerage desk
`RFS`	Executed against a streamed price