Executions Objects

Response Objects

OrdersObject

ParameterType Description

baseSymbol

string

Base symbol

commissionRate

number

Aquanow's fee (in quote symbol) IF the execution is fee-based. It is in basis points (so 20 would mean 0.002)

createdAt

number

Time in epoch milliseconds when this record was created.

exchange

string

Exchange Aquanow routed to

expirationTime

number

Expiration time of order in milliseconds

fillFeeQuoteAqua

number

Fee applied by Aquanow IF this is fee-based execution

fillPct

number

Percentage of order traded

fillQtyBase

number

How much of the order was filled in base symbol

fillQtyQuote

number

How much of the order was filled in quote symbol

finalizeReturnedQtyBase

number

Amount returned

orderId

string

Order ID

orderIdParent

string

Users can query child orders using this via orderIdParent GSI

orderType

string

Type of order

priceArrival

number

Pre-trade market price

priceLimit

number

Price limit set by user. For executed orders, the quote Aquanow has provided.

priceMarket

number

Market price, similar to priceArrival

quoteSymbol

string

Symbol of quote

remainingQtyBase

number

Amount of the execution remaining in base symbol

remainingQtyQuote

number

Amount of the execution remaining in quote symbol

strategy

string

Strategy (i.e. TWAP, RFQ, LIMIT or Market)

symbol

string

Ticker

tradeDuration

number

Duration of trade in seconds. Applicable to active orders like TWAP and LIMIT

tradePriceAvg

number

The average price the trade was executed at. Will be "-" if the trade was not executed.

tradeSide

string

Trade side, buy or sell.

tradeSize

number

Size of trade in crypto terms. (i.e. in USDT-USD, it will be in USDT) For FIAT trades like USD-CAD, it will be in USD.

tradeStatus

string

Status of trade (i.e. "CREATE", "AWAITING", "COMPLETE", "ERROR" or "EXPIRED") View Execution Statuses for more information.

updatedAt

number

Time in epoch milliseconds when this record was updated.

username

string

Username associated with account

OrdersV2Object

ParameterType Description

data

array

Returns an array of OrdersObject

pagination

object

PaginationDataObject

ParameterType Description

startsAfter

string

Pagination token that can be used to query more data

limit

object

Number of results shown

Trade Status

Active Status

The table below contains statuses that are undergoing changes, and thus can change to a different status at any time.

Status Description

CREATE

Trade is being created. CREATE is the first status to be seen and will remain unchanged until a possible execution is found.

AWAITING

Trade is undergoing execution or being finalized.

CANCEL_PENDING

Trade is undergoing cancellation. Status should change to CANCELLED after a few seconds.

NOTE: you can only cancel LIMIT and TWAP orders.

Resolved Status

The table below contains statuses that are in final form, and will no longer undergo any changes.

Status Description

COMPLETE

Trade has successfully been executed and finalized.

PARTIAL_COMPLETE

Trade has been partially executed and finalized. This could be due to several reasons, commonly caused by not having enough bids below or above the limit price provided to fill the order.

NOTE: only TWAP orders can be partially filled. If a TWAP order that was previously partially filled is being cancelled, the status will remain as CANCELLED.

EXPIRED

Trade has failed to execute. This could be due to several reasons, commonly caused by having no bids or asks, below or above the limit price provided to fill the order.

CANCELLED

Trade has been cancelled upon user's request. A cancelled order could have been partially filled before cancellation.

NOTE: only TWAP, LIMIT and SNIPER (Orders V2) orders can be cancelled.

ERROR

Trade has encountered an error. Please check the message parameter for more information. Contact support@aquanow.io for additional support if required.

Last updated