Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://api.sandbox1-dev.finhost.io/crypto-exchange/orders \
  --header 'Authorization: Bearer <token>'
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountIdFrom": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountIdTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pair": "<string>",
      "volume": "<string>",
      "settings": {
        "type": "market",
        "desiredPrice": "<string>"
      },
      "state": {
        "status": "initiated"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "charge": {
        "percentage": 1,
        "contractId": "<string>"
      }
    }
  ],
  "pageKey": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
companyId
string<uuid>

Company ID

​
pageSort
enum<string>
default:desc

Page Sort

Available options:
asc,
desc
​
pageLimit
integer
default:10

Page Limit (see minimum/maximum)

Required range: 1 <= x <= 25
​
pageKey
string

Page Key (used for pagination, taken from the previous response)

Response

OK

​
orders
object[]
required
​
pageKey
string | null
required

Page key for pagination. If null, there are no more pages

Example:

null