GET or Query Orders

Orders

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

accountId

String

Identifier for the account

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
}

V2

There are several differences with V2 endpoints. Firstly, the data is encapsulated in a data payload. Secondly, there now exists a pagination object that, if applicable, will hold a startsAfter token. You can use the startsAfter token as a query parameter to query successive data, until startsAfter is null, signifying that you have reached the end of the pagination.

if startsAfter is a string while there is no data in the payload, it means there is more data to be fetched, even if it seems to be returning an empty array. Do not stop calling until the startsAfter token has an empty string (""). Do not rely on the data received to determine if you should keep fetching.

Get or query V2 orders

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

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

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

tradeStatus

String

Query by tradeStatus

accountId

String

Identifier for the account

Headers

Name
Type
Description

x-api-key*

String

{{x-api-key}}

API Auth Key

x-signature*

String

32c92460f65cpb78d0eaf9a4361fb6b0a2bb7bb4c40f531e9974a0afc12d9a328b0uj621a544d242ee9ba1dfa799c85a

Signature created using your API secret

x-nonce*

Number

1657731573930

Timestamp in millisecond

Returns an OrdersV2Object.

{
    "data": {
        "orderId": "1f10399a-f945-4fe9-a98d-9cf507234ea2",
        "remainingQtyBase": 0.1,
        "tradeSize": 0.1,
        "activeTradeStatus": "AWAITING",
        "tradePriceAvg": 70780,
        "fillPct": 0,
        "tradeSide": "sell",
        "tradeTime": 1712848177949,
        "baseSymbol": "BTC",
        "strategy": "LIMIT",
        "fillQtyQuote": 0,
        "usernameRef": "-",
        "fillQtyBase": 0,
        "accountId": "CA1000051R",
        "symbol": "BTC-USD",
        "tradeStatus": "AWAITING",
        "commissionRate": 0,
        "createdAt": 1712848177953,
        "message": "-",
        "priceLimit": 70780,
        "quoteSymbol": "USD",
        "remainingQtyQuote": 7078,
        "orderType": "parentOrder",
        "updatedAt": 1712848177953,
        "tradeDuration": 86400,
        "username": "helloWorld",
        "fillFeeQuoteAqua": 0
    }
}

PreviousExecutions APINextTrading Strategies

Last updated