Skip to main content

Orders

Version: v1

/api/orderbook

GET

Summary:

Get orderbook (40 bids + 40 asks)

Parameters
NameLocated inDescriptionRequiredSchema
currencyPairCodequerycurrency pair codeNostring
Responses

Json example:

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

/api/orders/{orderId}/deals

GET

Summary:

Get user order info with deals

Parameters
NameLocated inDescriptionRequiredSchema
orderIdpathorder GUIDYesstring (uuid)
API-PublicKeyheaderNo
API-SignatureheaderNo
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,
"quoteAmount": 0,
"date": "2024-08-14T08:04:24.005Z",
"userId": "string",
"isCanceled": true,
"status": "string",
"currencyPairCode": "string"
}
CodeDescription
200Success

/api/user/orders

GET

Summary:

Get orders of user

Parameters
NameLocated inDescriptionRequiredSchema
currencyPairCodequerycurrency pair codeNostring
statusquery"all" / "active" / "canceled"Nostring
API-PublicKeyheaderNo
API-SignatureheaderNo
Responses

Json example:

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

/api/orders

POST

Summary:

Create Buy or Sell limit order

Parameters
NameLocated inDescriptionRequiredSchema
API-PublicKeyheaderNo
API-SignatureheaderNo
Body
{
"side": "buy",
"currencyPairCode": "BTC_USDT",
"amount": 0.001,
"price": 45000
}
Responses

Response example:

 "e2cd407c-28c8-4768-bd73-cd7357fbccde"
CodeDescription
200Success

DELETE

Summary:

Cancel all user orders.

Parameters
NameLocated inDescriptionRequiredSchema
currencyPairCodequerycurrency pair codeNostring
API-PublicKeyheaderNo
API-SignatureheaderNo
Responses
CodeDescription
200Success

/api/orders/{orderId}

DELETE

Summary:

Delete selected order

Parameters
NameLocated inDescriptionRequiredSchema
orderIdpathorder idYesstring (uuid)
API-PublicKeyheaderNo
API-SignatureheaderNo
Responses
CodeDescription
200Success