Orders

Version: v1

/api/orderbook

GET

Summary:

Get orderbook (40 bids + 40 asks)

Parameters

Name	Located in	Description	Required	Schema
currencyPairCode	query	currency pair code	No	string

Responses

Json example:

[
    {
    "isBid": true,
    "price": 0,
    "amount": 0,
    "quoteAmount": 0
    }
]

Code	Description
200	Success

/api/orders/{orderId}/deals

GET

Summary:

Get user order info with deals

Parameters

Name	Located in	Description	Required	Schema
orderId	path	order GUID	Yes	string (uuid)
API-PublicKey	header		No
API-Signature	header		No

Responses

Json example:

{
"deals": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dealDateUtc": "2024-08-14T08:04:24.005Z",
    "currencyPairCode": "string",
    "volume": 0,
    "price": 0,
    "isBuy": true,
    "isUserBuyer": true,
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
],
"id": "string",
"isBid": true,
"price": 0,
"initialAmount": 0,
"amount": 0,
"amountExecuted": 0,
"quoteAmount": 0,
"date": "2024-08-14T08:04:24.005Z",
"userId": "string",
"isCanceled": true,
"status": "string",
"currencyPairCode": "string"
}

Code	Description
200	Success

Order amount fields

• initialAmount — original order amount at creation time. Never changes.
• amountExecuted — amount that has been filled by matching deals.
• amount — legacy field kept for backwards compatibility. Holds amountExecuted for active orders and the unfilled remainder for canceled orders. Prefer amountExecuted and initialAmount - amountExecuted for the unfilled remainder.

/api/user/orders

GET

Summary:

Get orders of user

Parameters

Name	Located in	Description	Required	Schema
currencyPairCode	query	currency pair code	No	string
status	query	"all" / "active" / "canceled"	No	string
API-PublicKey	header		No
API-Signature	header		No

Responses

Json example:

[
  {
    "id": "string",
    "isBid": true,
    "price": 0,
    "initialAmount": 0,
    "amount": 0,
    "amountExecuted": 0,
    "quoteAmount": 0,
    "date": "2024-08-14T08:20:24.024Z",
    "userId": "string",
    "isCanceled": true,
    "status": "string",
    "currencyPairCode": "string"
  }
]

Code	Description
200	Success

/api/orders

POST

Summary:

Create Buy or Sell limit order

Parameters

Name	Located in	Description	Required	Schema
API-PublicKey	header		No
API-Signature	header		No

Body

{
"side": "buy",
"currencyPairCode": "BTC_USDT",
"amount": 0.001,
"price": 45000
}

Responses

Response example:

 "e2cd407c-28c8-4768-bd73-cd7357fbccde"

Code	Description
200	Success

DELETE

Summary:

Cancel all user orders.

Parameters

Name	Located in	Description	Required	Schema
currencyPairCode	query	currency pair code	No	string
API-PublicKey	header		No
API-Signature	header		No

Responses

Code	Description
200	Success

/api/orders/{orderId}

DELETE

Summary:

Delete selected order

Parameters

Name	Located in	Description	Required	Schema
orderId	path	order id	Yes	string (uuid)
API-PublicKey	header		No
API-Signature	header		No

Responses

Code	Description
200	Success