Orders

GET Order

Retrieve an order by its order ID.

get

/v1/orders/{orderId}

Authorizations

Path parameters

orderIdstring · uuidrequired

The settlementId of the settlement

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/orders/{orderId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

4XX

5XX

200

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "orderStatus": "PLACED",
  "side": "BUY",
  "pair": "BTC-USD",
  "orderPrice": "52100.00",
  "orderQuantity": "1.00",
  "fillQuantity": "1.00",
  "fillPrice": "52100.00",
  "fillPercentage": "100",
  "clientFeeRate": "10",
  "providerFeeRate": "10",
  "placedAt": "2025-03-07T01:26:38.366Z",
  "completedAt": null,
  "clientReference": "text",
  "strategy": "RFQ"
}

Successful response

GET Orders

Retrieve a list of orders with optional filtering and pagination.

get

/v1/orders

Authorizations

Query parameters

clientReferencestring

Filter orders by client provided reference parameter

orderStatusstring · enum

Filter orders by order status

Options: PLACED, FILLED, FAILED, CANCELED

placedAtStartstring · date-time

Filter orders by when the order was placed. Lower bound, exclusive

placedAtEndstring · date-time

Filter orders by when the order was placed. Upper bound, inclusive

completedAtStartstring · date-time

Filter orders by when the order was completely filled. Lower bound, exclusive

completedAtEndstring · date-time

Filter orders by when the order was completely filled. Upper bound, inclusive

accountIdstring · uuid

Filter orders by account ID

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstring · enum

Will sort the returned data using the specified field.

Options: orderStatus, placedAt, completedAt

sortDirectionstring · enum

Specifies the sort direction for the sortField.

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/orders' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

4XX

5XX

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "orderStatus": "PLACED",
      "side": "BUY",
      "pair": "BTC-USD",
      "orderPrice": "52100.00",
      "orderQuantity": "1.00",
      "fillQuantity": "1.00",
      "fillPrice": "52100.00",
      "fillPercentage": "100",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "placedAt": "2025-03-07T01:26:38.366Z",
      "completedAt": null,
      "clientReference": "text",
      "strategy": "RFQ"
    }
  ]
}

Successful response