Deals

Deal object

Field	Meaning
id	Deal id.
dealDateUtc	Execution time, UTC.
currencyPairCode	e.g. BTC_USDT.
volume	Filled quantity, in base currency.
price	Execution price.
isBuy	In /api/user/deals, whether you were the buyer.
isUserBuyer	Same, and null in the public /api/deals feed.
orderId	Your order in this deal.
clientOrderId	The client order id of your order, if it had one.
commissionAmount	Fee charged to you for this deal. Only in /api/user/deals.
commissionCurrencyCode	Currency of that fee.

About the fee

commissionAmount is the fee actually charged, not a rate applied to the volume. It cannot be derived from the commission tables: the two sides of a deal are priced independently — each by the fee mode stamped on its own order and by whether that side was maker or taker — so the buyer and the seller of one deal routinely pay different amounts in different currencies.

The fields are null while a deal is still being settled, and on the public /api/deals feed, which is not attributed to any account. null is not 0: 0 means no fee was charged.

Version: v1

/api/deals

GET

Summary:

Get history of trades for CurrencyPair (100)

Parameters

Name	Located in	Description	Required	Schema
currencyPairCode	query	currency pair code	No	string
sinceDate	query	Optional. Example: "2021-02-05T14:00:00"	No	dateTime
endDate	query	Optional. Example: "2021-02-05T15:00:00"	No	dateTime
pageNumber	query		No	integer
pageSize	query		No	integer

Responses

Json example:

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dealDateUtc": "2024-08-14T08:44:14.969Z",
    "currencyPairCode": "string",
    "volume": 0,
    "price": 0,
    "isBuy": true,
    "isUserBuyer": true,
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientOrderId": "mm1-BTC_USDT-0001",
    "commissionAmount": 0,
    "commissionCurrencyCode": "USDT"
  }
]

Code	Description
200	Success

/api/user/deals

GET

Summary:

Get history of trades for user per CurrencyPair (100)

Json example:

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dealDateUtc": "2024-08-14T08:44:14.969Z",
    "currencyPairCode": "string",
    "volume": 0,
    "price": 0,
    "isBuy": true,
    "isUserBuyer": true,
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientOrderId": "mm1-BTC_USDT-0001",
    "commissionAmount": 0,
    "commissionCurrencyCode": "USDT"
  }
]

Parameters

Name	Located in	Description	Required	Schema
currencyPairCode	query	currency pair code	No	string
sinceDate	query	Optional. Example: "2021-02-05T14:00:00"	No	dateTime
endDate	query	Optional. Example: "2021-02-05T15:00:00"	No	dateTime
pageNumber	query		No	integer
pageSize	query		No	integer
API-PublicKey	header		No
API-Signature	header		No

Responses

Code	Description
200	Success