Executions API

Aquanow provides execution services to end users by leveraging our aggregated market data, liquidity, and execution algorithms.

Get or query orders

GET https://api.aquanow.io/trades/v1/order

To view example requests for this endpoint, visit Aquanow's Postman documentation.

NOTE: The limit for this endpoint is a maximum payload of 5 mb. For larger payloads, use the v2 endpoint or change the time range parameters to query for less results.

Query Parameters

Name
Type
Description

-

-

Query all orders if no query parameters are provided.

orderId

String

Query by order ID.

accountId

String

Query orders by account.

startTime/endTime

Number

Query by time range, requires both startTime and endTime.

expirationStartTime/expirationEndTime

Number

Query by expiration time range, requires both expirationStartTime and expirationEndTime.

openOrders=true

Bool

Query for open orders

startsAfter

String

Pagination token used to fetch extra data

usernameRef

String

Query by usernameRef

Headers

Name
Type
Description

x-api-key*

String

{{x-api-key}}

API Auth Key

x-signature*

String

32c92660f65cbb78d0eaf9a4361fb6b0a2cb8bb4c40f531e9974a0afc12d9a328b5ff621w544d242ee9ba1dfa799c85a

Signature created using your API secret

x-nonce*

String

1657731573930

Timestamp in millisecond

Returns an OrdersObject.

{
    "orderId": "905910d8-ad90-42f6-91af-910defeae2ad",
    "remainingQtyBase": 0,
    "tradeSize": 0.1,
    "exchangeOrderId": "-",
    "tradePriceAvg": 71874.9,
    "fillPct": 100,
    "finalizeReturnedQtyBase": 0,
    "tradeSide": "buy",
    "exchangeClientOrderId": "-",
    "tradeTime": 1712618352305,
    "childOrderCount": 0,
    "itemDateTime": 1712618353772,
    "baseSymbol": "USD",
    "strategy": "RFQ",
    "fillQtyQuote": 0.1,
    "usernameRef": "-",
    "fillQtyBase": 7187.49,
    "accountId": "CA1000101R",
    "exchangePair": "aquax-BTC-USD",
    "symbol": "BTC-USD",
    "tradeStatus": "COMPLETE",
    "commissionRate": 0,
    "createdAt": 1712618352379,
    "message": "-",
    "priceLimit": 71874.9,
    "quoteSymbol": "BTC",
    "remainingQtyQuote": 0,
    "orderIdParent": "905910d8-ad90-42f6-91af-910defeae2ad",
    "orderType": "parentOrder",
    "updatedAt": 1712618353772,
    "exchange": "aquax",
    "tradeDuration": 30,
    "username": "helloWorld",
    "fillFeeQuoteAqua": 0
}

Endpoint to initiate an LIMIT/GTC/GTD request to Aquanow.

POST https://api.aquanow.io/trades/v1/order

NOTE: Either deliverQuantity or receiveQuantity must be specified. If both are specified, receiveQuantity will be considered for sell orders, and deliverQuantity will be considered for buy orders.

If order is not filled, the request will return a 200 response with receiveQuantity and deliverQuantity set to 0.

To view example requests for this endpoint, visit Aquanow's Postman documentation.

Headers

Name
Type
Description

x-api-key*

String

{{x-api-key}}

API Auth Key

x-signature*

String

49c6260c194f4d7ed5cb917dc70b9821673246b2abc1cf28f05df6a75fd24181e00f8e57b321d15ae45db58b3bffe27a

Signature created using your API secret

x-nonce*

Number

1618307861949

Timestamp in millisecond

Content-Type*

String

application/json

Request Body

Name
Type
Description

strategy*

String

"LIMIT", "GTC" or "GTD"

accountId*

String

Identifier for account the order will be applied to.

ticker*

String

e.g., BTC-CAD

Currency pair

tradeSide*

String

"buy" or "sell"

priceLimit*

Number

Limit price of a ticker symbol, determined by tradeSide and deliverQuantity/receiveQuantity

deliverQuantity*

Number

NOTE: specify either deliverQuantity or receiveQuantity.

Quantity of currency delivered by user based on the ticker and tradeSide.

For example, if ticker is BTC-USD and tradeSide is buy, then the delivered currency is USD. If tradeSide is sell, the delivered currency is BTC.

receiveQuantity*

Number

NOTE: specify either deliverQuantity or receiveQuantity.

Quantity of currency received by user based on the ticker and tradeSide.

For example, if ticker is BTC-USD and tradeSide is buy, then the received currency is BTC. If tradeSide is sell, the received currency is USD.

expirationTime*

Number

NOTE: only required for GTD orders.

e.g., 1669972404350

Expiration time in milliseconds of when the pre-existing order will expire. Expiration time must be within 90 days of order creation.

usernameRef*

String

A new reference string for sub-accounts. Must be less than 64 characters, cannot contain special characters.

Returns an ExecutionsObject.

{
    "type": "limitOrderAck",
    "payload": {
        "accountId": "CA1000051R",
        "quoteId": "7a9f51df-f81c-442f-b8e9-68527c23f826",
        "quoteTime": 1712769019504,
        "expireTime": 1712855419504,
        "ticker": "USDT-USD",
        "tradeSide": "buy",
        "receiveCurrency": "USDT",
        "receiveQuantity": 10,
        "deliverCurrency": "USD",
        "deliverQuantity": 10.0005,
        "price": 1.048179
    }
}

PreviousGet Withdrawal Fee EstimateNextGET or Query Orders

Last updated