Trades

Get all trades

Get all the trades for a given client ID

get/trades

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/trades
  • Auth: API key in header x-api-key

Query parameters

client_idstring required

The identifier of a client.

trade_typestring[]

The trade type. The list will be filtered to include only trades with a matching trade type. If omitted, trades of every type are returned.

parent_trade_idstring

Parent identifier for drawdown trades

pageinteger

The desired page number for pagination. By default is 1.

page_sizeinteger

The number of items per page for pagination. By default is 50.

external_reference_idstring

Filter by the external reference ID provided during trade creation.

mass_payment_idstring uuid

Filter by related mass payment's uuid.

mass_payment_external_reference_idstring

Filter by related mass payment's external reference.

buy_currencystring

Filter by the buy currency

statusstring[]

Filter trades by comma separated statuses

from_order_datestring date

Filter trades by from_order_date.

to_order_datestring date

Filter trades by to_order_date.

from_maturity_datestring date

Filter trades by from_maturity_date.

to_maturity_datestring date

Filter trades by to_maturity_date.

Headers

Authorizationstring required

The access token.

X-Contact-IDstring

The identifier of a contact.

Response

List of trades

buy_amountnumber float required

Buy amount

buy_balance_for_drawdownnumber float required

Remaining buy-side balance available to draw down against this trade. Zero for trades that cannot be drawn down.

buy_currencystring required

Buy currency code

fee_amountnumber float required

Fee amount

fee_currencystring required

Fee currency

initial_marginnumber float

Only for forwards. Trade's deposit amount.

margin_callnumber float

Only for forwards. Margin call amount.

maturity_datestring date-time required

Limit date and time (UTC) in which funds must be received by Ebury

order_datestring date required

Order date

parent_trade_idstring nullable required

Parent trade ID (not null for drawdown deals)

ratenumber float required

Booked rate

rate_symbolstring required

The symbol of booked rate

referencestring

Additional trade reference. Example: Invoice number.

sell_amountnumber float required

Sell amount

sell_balance_for_drawdownnumber float required

Remaining sell-side balance available to draw down against this trade. Zero for trades that cannot be drawn down.

sell_currencystring required

Sell currency code

start_datestring date nullable required

Date the drawdown window opens. Only set for window forwards; null for every other trade type and for window forwards with no start date.

status'Created' | 'Funds In Partially' | 'Funds In Full' | 'Funds Out Partially Allocated' | 'Funds Out Full Allocated' | 'Closed' | 'Cancelled' required

Status of the trade

syntheticboolean required

Identifies as a synthetic future contracts

trade_idstring required

Trade identifier

trade_receiptstring uri-reference

The URL to get the trade receipt

trade_typestring required

Trade type

external_reference_idstring

The client's external reference ID if provided during trade creation

Changes

No recorded changes to this operation across all 1 revision of this API.