Aquanow CAMS v1.0 (Updated)
  • Welcome
  • Security
    • OAuth2.0
    • API Limits
  • Pagination
  • Webhooks
    • Onboarding
    • Settlements
    • Reports
    • Order
    • Execution
    • Document
  • Market Data
    • Websocket
    • Rest API
      • OHLC
  • API reference
    • Customers
      • Docs
      • Configuration
    • Trades
      • RFQ
    • Orders
    • Executions
    • Settlements
    • Transactions
    • Accounts
      • Credit
      • Balances
      • Configuration
      • Performance
    • Instruments
      • Pairs
      • Assets
    • Custody
      • Balances
      • Allocation
    • Files
    • Webhook
  • Change Log
  • Specification
  • User Guide
    • View Customers
      • Customer Onboarding
      • Upload Onboarding Docs
      • View Customer Account Balances
      • Customer Risk Groups
    • View Customer Trade Activity
    • Manage Team Members
Powered by GitBook
On this page
  1. API reference

Orders

PreviousRFQNextExecutions

Last updated 19 days ago

GET Order

get

Retrieve an order by its order ID.

Authorizations
Path parameters
orderIdstringRequired
orderIdstring ยท uuidRequired

The settlementId of the settlement

Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
get
GET /api/v1/orders/{orderId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "orderStatus": "PLACED",
  "side": "BUY",
  "pair": "BTC-USD",
  "strategy": "RFQ",
  "limitPrice": "52100.00",
  "orderPrice": "52100.00",
  "leavesQty": "1.00",
  "orderQuantity": "1.00",
  "fillQuantity": "1.00",
  "cumulativeQty": "1.00",
  "fillPrice": "52100.00",
  "avgPrice": "52100.00",
  "orderType": "MARKET",
  "timeInForce": "DAY",
  "expireTime": "2025-05-31T23:59:59.000Z",
  "clientOrderId": "5f80d325-0f71-4f0a-a346-75c7bb6ac867",
  "fillPercentage": "100",
  "clientFeeRate": "10",
  "providerFeeRate": "10",
  "placedAt": "2025-05-19T22:37:54.571Z",
  "completedAt": null,
  "clientReference": "text",
  "rejectedAt": "2025-05-19T22:37:54.571Z",
  "orderRejectReason": "text",
  "currency": "BTC"
}

GET Orders

get

Retrieve a list of orders with optional filtering and pagination.

Authorizations
Query parameters
clientReferencestringOptional

Filter orders by client provided reference parameter

orderStatusstring ยท enumOptional

Filter orders by order status

Possible values:
placedAtStartstring ยท date-timeOptional

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

placedAtEndstring ยท date-timeOptional

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

completedAtStartstring ยท date-timeOptional

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

completedAtEndstring ยท date-timeOptional

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

accountIdstring ยท uuidOptional

Filter orders by account ID

afterstringOptional

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

limitstring ยท integerOptional

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

sortFieldstring ยท enumOptional

Will sort the returned data using the specified field.

Possible values:
sortDirectionstring ยท enumOptional

Specifies the sort direction for the sortField.

Possible values:
Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
get
GET /api/v1/orders HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "orderStatus": "PLACED",
      "side": "BUY",
      "pair": "BTC-USD",
      "strategy": "RFQ",
      "limitPrice": "52100.00",
      "orderPrice": "52100.00",
      "leavesQty": "1.00",
      "orderQuantity": "1.00",
      "fillQuantity": "1.00",
      "cumulativeQty": "1.00",
      "fillPrice": "52100.00",
      "avgPrice": "52100.00",
      "orderType": "MARKET",
      "timeInForce": "DAY",
      "expireTime": "2025-05-31T23:59:59.000Z",
      "clientOrderId": "5f80d325-0f71-4f0a-a346-75c7bb6ac867",
      "fillPercentage": "100",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "placedAt": "2025-05-19T22:37:54.571Z",
      "completedAt": null,
      "clientReference": "text",
      "rejectedAt": "2025-05-19T22:37:54.571Z",
      "orderRejectReason": "text",
      "currency": "BTC"
    }
  ]
}

Create Order

post

For orders to be accepted, the account must have sufficient buying power. Once placed, an amount equivalent to the maximum potential value of the order will be reserved from the account balance for the duration that the order remains open.

Authorizations
Body
one ofOptional
or
or
Responses
200
Successful response
application/json
Responseone of
or
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
post
POST /api/v1/orders HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "orderType": "PREVIOUSLY_QUOTED",
  "clientReference": "text"
}
{
  "order": {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "orderStatus": "PLACED",
    "side": "BUY",
    "pair": "BTC-USD",
    "strategy": "RFQ",
    "orderPrice": "52100.00",
    "orderQuantity": "1.00",
    "fillQuantity": "1.00",
    "fillPrice": "52100.00",
    "fillPercentage": "100",
    "clientFeeRate": "10",
    "providerFeeRate": "10",
    "placedAt": "2025-05-19T22:37:54.571Z",
    "completedAt": null,
    "clientReference": "text"
  },
  "executions": [
    {
      "executionId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "executedAt": "2025-05-19T22:37:54.571Z",
      "pair": "BTC-USD",
      "side": "BUY",
      "deliverCurrency": "BTC",
      "deliverQuantity": "1.00",
      "receiveCurrency": "USD",
      "receiveQuantity": "52100.00",
      "price": "52100.00",
      "baseQuantity": "0.0016",
      "quoteQuantity": "10.74",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "clientFeeQuantity": "52.10",
      "providerFeeQuantity": "52.10",
      "feeCurrency": "USD",
      "executionStatus": "TRADE_EXECUTED",
      "tradeDate": "2025-05-19",
      "valueDate": "2025-05-19",
      "confirmedAt": "2025-05-19T22:37:54.571Z",
      "clientReference": "text",
      "tradeTaxRate": "5",
      "clientTaxQuantity": "2.61",
      "providerTaxQuantity": "2.61"
    }
  ]
}

Cancel an Order (WIP)

delete

Cancel a LIMIT order in NEW status

Authorizations
Path parameters
orderIdstringRequired
Responses
200
OK
application/json
401
Unauthorized
403
Insufficient Privileges
404
Not Found
application/json
4XX
Client error
5XX
Server error
delete
DELETE /api/v1/orders/{orderId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "orderId": "876818f4-e054-49ec-a2de-313f9fc96b92",
  "orderStatus": "PLACED"
}
  • GETGET Order
  • GETGET Orders
  • POSTExecute a Quote (RFQ)
  • POSTCreate Order
  • DELETECancel an Order (WIP)

Execute a Quote (RFQ)

post

Execute a previously requested quote. Creates an Order and Executes it. Retuns both the order and the execution.

Authorizations
Body
quoteIdstring ยท uuidRequired

The quoteId returned by Request Quote

clientReferencestringOptional
Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
post
POST /api/v1/orders HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "clientReference": "text"
}
{
  "order": {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "orderStatus": "PLACED",
    "side": "BUY",
    "pair": "BTC-USD",
    "strategy": "RFQ",
    "orderPrice": "52100.00",
    "orderQuantity": "1.00",
    "fillQuantity": "1.00",
    "fillPrice": "52100.00",
    "fillPercentage": "100",
    "clientFeeRate": "10",
    "providerFeeRate": "10",
    "placedAt": "2025-05-19T22:37:54.571Z",
    "completedAt": null,
    "clientReference": "text"
  },
  "executions": [
    {
      "executionId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "executedAt": "2025-05-19T22:37:54.571Z",
      "pair": "BTC-USD",
      "side": "BUY",
      "deliverCurrency": "BTC",
      "deliverQuantity": "1.00",
      "receiveCurrency": "USD",
      "receiveQuantity": "52100.00",
      "price": "52100.00",
      "baseQuantity": "0.0016",
      "quoteQuantity": "10.74",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "clientFeeQuantity": "52.10",
      "providerFeeQuantity": "52.10",
      "feeCurrency": "USD",
      "executionStatus": "TRADE_EXECUTED",
      "tradeDate": "2025-05-19",
      "valueDate": "2025-05-19",
      "confirmedAt": "2025-05-19T22:37:54.571Z",
      "clientReference": "text",
      "tradeTaxRate": "5",
      "clientTaxQuantity": "2.61",
      "providerTaxQuantity": "2.61"
    }
  ]
}