Accounts Objects

Accounts API Response Objects

UserBalancesObject
      Parameter
Type
                            Description
available
number
totalBalance - pending - creditBalance
availableBalance
number
Account's available balance
creditBalance
number
Account's credit balance
depositAddress
string
Account's deposit address
pending
number
Pending amount
pendingTransfer
number
sum of all transactions with PROCESSING or CREATED status
symbol
string
Currency symbol
totalBalance
number
availableBalance + pendingTransfer + sum of all AWAITING status for LIMIT/GTC/GTD orders
updatedAt
number
Time in epoch milliseconds when this order was last updated.
​
EstimateBalanceUSDObject
      Parameter
Type
                            Description
usdTotal
number
Account's total aggregated balance in USD
​
APIKeysObject
      Parameter
Type
                            Description
createdAt
number
Time in epoch milliseconds when this order was created.
key
string
API key
keyId
string
API Key ID
type
string
API type, always "regular"
username
string
Account's username
​
APIKeyUsageObject
      Parameter
Type
                            Description
items
obj
Return an itemsObject​
usagePlanId
string
 Usage plan API key belongs to
​
itemsObject
Contains all API keys account currently holds
        Parameter
Type
                            Description
8vtfqoxbcj
array
An example of an API key ID
In the example, total number of API requests sent for the period is 0 and the total limit on the API key is 100000.
​
UserSettingsObject
      Parameter
Type
                            Description
commission
number
Amount Aquanow charges (in quote symbol) IF the execution is fee-based. It is in basis points (i.e., 20 would mean 0.002).
createdAt
number
Time in epoch milliseconds when this order was created.
enableGTC
bool
If GTC order strategy has been enabled.
enableGTD
bool
If GTD order strategy has been enabled.
enableLIMIT
bool
If LIMIT order strategy has been enabled.
enableMARKET
bool
If MARKET order strategy has been enabled.
enableRFQ
bool
If RFQ order strategy has been enabled.
enableSOR
bool
If SOR order strategy has been enabled.
enableTWAP
bool
If TWAP order strategy has been enabled.
favoriteTickers
array
Favorite tickers set by user.
fiatWhitelist
obj
Returns a FiatWhitelistObject​
ipWhitelist
array
Account's whitelisted IP addresses.
isOnboard
bool
If user has been onboarded
networkFee
obj
Returns a NetworkFeeObject​
rfqPeriod
number
RFQ period
updatedAt
number
Time in epoch milliseconds when this order was last updated.
username
string
Account's username
whitelist
obj
Account's whitelisted crypto addresses.
Returns a WhitelistObject​
​
FiatWhitelistObject
            Parameter
Type
              Description
0EPd7p1h
obj
An example of a whitelisted fiat address.
Returns a FiatInfoObject​
​
FiatInfoObject
              Parameter
Type
                       Description
accountNumber
string
Fiat bank account number
bankAddress
string
Bank address
bankName
string
Bank name
beneficiaryAddress
string
Recipient of transaction's address
beneficiaryName
string
Recipient of transaction's name
intermediaryBankAddress
string
Intermediary bank address, if applicable.
intermediarySwftBicCode
string
Intermediary SWIFT/BIC code, if applicable.
label
string
Label set by user
routingAbaNumber
string
Bank's ABA routing number
swiftCode
string
Bank's SWIFT code
symbol
string
Currency symbol
verified
bool
If banking information has been verified by Aquanow.
​
NetworkFeeObject
Some symbols such as USDT and USDC use multiple networks.
     Parameter
Type
                              Description
USD
obj
An example of a NetworkFeeObject.
Returns a NetworkFeeSymbolObject​
​
NetworkFeeSymbolObject
            Parameter
Type
             Description
fee
number
Network fee
feeType
string
Network fee type
free
bool
​
variable
string
Variable rate
​
WhitelistObject
            Parameter
Type
              Description
0x4714P0830219084c99c42a96616gA8711a97F8ec
obj
An example of a crypto address.
Returns a CryptoInfoObject.
​
CryptoInfoObject
          Parameter
Type
                            Description
currencyTag
string
Currency tag
label
string
Label set by user
symbol
string
Currency symbol
verified
bool
If banking information has been verified by Aquanow.
​

Parameter	Type	Description
`available`	number	totalBalance - pending - creditBalance
`availableBalance`	number	Account's available balance
`creditBalance`	number	Account's credit balance
`depositAddress`	string	Account's deposit address
`pending`	number	Pending amount
`pendingTransfer`	number	sum of all transactions with `PROCESSING` or `CREATED` status
`symbol`	string	Currency symbol
`totalBalance`	number	availableBalance + pendingTransfer + sum of all `AWAITING` status for LIMIT/GTC/GTD orders
`updatedAt`	number	Time in epoch milliseconds when this order was last updated.

Parameter	Type	Description
`usdTotal`	number	Account's total aggregated balance in USD

Parameter	Type	Description
`createdAt`	number	Time in epoch milliseconds when this order was created.
`key`	string	API key
`keyId`	string	API Key ID
`type`	string	API type, always `"regular"`
`username`	string	Account's username

Parameter	Type	Description
`items`	obj	Return an itemsObject
`usagePlanId`	string	Usage plan API key belongs to

Parameter	Type	Description
`8vtfqoxbcj`	array	An example of an API key ID In the example, total number of API requests sent for the period is 0 and the total limit on the API key is 100000.

Parameter	Type	Description
`commission`	number	Amount Aquanow charges (in quote symbol) IF the execution is fee-based. It is in basis points (i.e., 20 would mean 0.002).
`createdAt`	number	Time in epoch milliseconds when this order was created.
`enableGTC`	bool	If GTC order strategy has been enabled.
`enableGTD`	bool	If GTD order strategy has been enabled.
`enableLIMIT`	bool	If LIMIT order strategy has been enabled.
`enableMARKET`	bool	If MARKET order strategy has been enabled.
`enableRFQ`	bool	If RFQ order strategy has been enabled.
`enableSOR`	bool	If SOR order strategy has been enabled.
`enableTWAP`	bool	If TWAP order strategy has been enabled.
`favoriteTickers`	array	Favorite tickers set by user.
`fiatWhitelist`	obj	Returns a FiatWhitelistObject
`ipWhitelist`	array	Account's whitelisted IP addresses.
`isOnboard`	bool	If user has been onboarded
`networkFee`	obj	Returns a NetworkFeeObject
`rfqPeriod`	number	RFQ period
`updatedAt`	number	Time in epoch milliseconds when this order was last updated.
`username`	string	Account's username
`whitelist`	obj	Account's whitelisted crypto addresses. Returns a WhitelistObject

Parameter	Type	Description
`0EPd7p1h`	obj	An example of a whitelisted fiat address. Returns a FiatInfoObject

Parameter	Type	Description
`accountNumber`	string	Fiat bank account number
`bankAddress`	string	Bank address
`bankName`	string	Bank name
`beneficiaryAddress`	string	Recipient of transaction's address
`beneficiaryName`	string	Recipient of transaction's name
`intermediaryBankAddress`	string	Intermediary bank address, if applicable.
`intermediarySwftBicCode`	string	Intermediary SWIFT/BIC code, if applicable.
`label`	string	Label set by user
`routingAbaNumber`	string	Bank's ABA routing number
`swiftCode`	string	Bank's SWIFT code
`symbol`	string	Currency symbol
`verified`	bool	If banking information has been verified by Aquanow.

Parameter	Type	Description
`USD`	obj	An example of a NetworkFeeObject. Returns a NetworkFeeSymbolObject

Parameter	Type	Description
`fee`	number	Network fee
`feeType`	string	Network fee type
`free`	bool
`variable`	string	Variable rate

Parameter	Type	Description
`0x4714P0830219084c99c42a96616gA8711a97F8ec`	obj	An example of a crypto address. Returns a CryptoInfoObject.

Parameter	Type	Description
currencyTag	string	Currency tag
label	string	Label set by user
symbol	string	Currency symbol
verified	bool	If banking information has been verified by Aquanow.

Approval Objects

Next - Data Objects & Statuses

Executions Objects

Last modified 7mo ago