Accounts

Version: v1

GET /api/futures/account

Summary:

Get list of futures accounts

Response model

[
    {
    "id": 0,
    "userId": "string",
    "name": "string",
    "balance": 0,
    "usedMargin": 0,
    "leverage": 0,
    "equity": 0,
    "unrealizedPnl": 0,
    "freeMargin": 0,
    "marginLevel": 0,
    "liquidationTimestamp": "2024-04-25T06:51:31.020Z",
    "currencyCode": "string"
    }
]

Response codes

Code	Description
200	Success

POST /api/futures/account

Summary:

Create new futures account

Request model

{
  "currencyCode": "string",
  "leverage": 0
}

Response model

{
"id": 0,
"userId": "string",
"name": "string",
"balance": 0,
"usedMargin": 0,
"leverage": 0,
"equity": 0,
"unrealizedPnl": 0,
"freeMargin": 0,
"marginLevel": 0,
"liquidationTimestamp": "2024-04-25T07:00:58.886Z",
"currencyCode": "string"
}

Response codes

Code	Description
200	Success

POST /api/futures/account/transfer

Summary:

Transfer between futures accounts

Request model:

{
"amount": 0,
"fromFuturesAccountId": 0,
"toFuturesAccountId": 0,
"currencyCode": "string"
}

Responses

Code	Description
200	Success

GET /api/futures/account/transaction-history

Summary:

Get transaction history

Parameters

Name	Located in	Description	Required	Schema
futuresAccountId	query	futures account id	No	long
page	query	page number	No	integer
pageSize	query	page size	No	integer
dateFrom	query	start date	No	dateTime
dateTo	query	end date	No	dateTime
type	query	TransferIn = 1,TransferOut = 2,PNL = 3,TradingFee = 4, Funding = 5	No	integer

Response model:

{
  "items": [
    {
      "id": 0,
      "futuresAccountId": 0,
      "tradeId": 0,
      "timestamp": "2024-04-25T07:04:05.447Z",
      "amount": 0,
      "currency": "string",
      "transactionHistoryType": 1 // TransferIn = 1,TransferOut = 2,PNL = 3,TradingFee = 4, Funding = 5
    }
  ],
  "currentPage": 0,
  "pageSize": 0,
  "totalCount": 0,
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true
}

Response code

Code	Description
200	Success