Accounts Objects

Accounts API Response Objects

UserBalancesObject

ParameterType 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

ParameterType Description

usdTotal

number

Account's total aggregated balance in USD

APIKeysObject

ParameterType 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

ParameterType Description

items

obj

Return an itemsObject

usagePlanId

string

Usage plan API key belongs to

itemsObject

Contains all API keys account currently holds

ParameterType 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

ParameterType 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

ipWhitelist

array

Account's whitelisted IP addresses.

isOnboard

bool

If user has been onboarded

networkFee

obj

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

ParameterType Description

0EPd7p1h

obj

An example of a whitelisted fiat address. Returns a FiatInfoObject

FiatInfoObject

ParameterType 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.

ParameterType Description

USD

obj

An example of a NetworkFeeObject. Returns a NetworkFeeSymbolObject

NetworkFeeSymbolObject

ParameterType Description

fee

number

Network fee

feeType

string

Network fee type

free

bool

variable

string

Variable rate

WhitelistObject

ParameterType Description

0x4714P0830219084c99c42a96616gA8711a97F8ec

obj

An example of a crypto address. Returns a CryptoInfoObject.

CoinListObject

ParameterType Description

USD

array

An example of a crypto address. Returns an array of CryptoInfoObject or FiatInfoObject depending on symbol.

CryptoInfoObject

ParameterType 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.

CollateralBalanceObject

ParameterType Description

unutilizedCreditUSD

number

Represents the unused portion of an account's credit limit, expressed in US dollars (USD)

accountId

string

A unique identifier for the user's account within the platform

updatedAt

string

Time in epoch milliseconds when this order was last updated.

createdAt

number

Time in epoch milliseconds when this order was created.

username

string

The parent username that the account was created under.

creditLimitUsd

number

Denotes the upper limit of an account's potential negative balance in US dollar (USD) equivalent.

CompanyProfileObject

ParameterType Description

isOnboard

boolean

If user has been onboarded

companyProfileName

string

Username of company account

legalName

string

Legal name of company account

ipWhitelist

array

Account's whitelisted IP addresses.

profileType

string

Type of account either legacyProfile or companyProfile

companyProfileEmail

string

Email of account

availableOrderType

array

List of trading strategies allowed to use

fiatWithdrawalList

object

Returns a CoinListObject

cryptoWithdrawalList

object

Returns a CoinListObject

emailNotificationList

object

withdrawWhitelistingEnablement

boolean

CompanyProfileAccountsObject

ParameterType Description

accountName

string

Name of account

accountId

string

A unique identifier for the user's account within the platform

legalName

string

Legal name of company account

ipWhitelist

array

Account's whitelisted IP addresses.

allowBalanceTransfers

boolean

creditLimitUsd

number

Denotes the upper limit of an account's potential negative balance in US dollar (USD) equivalent.

enableCryptoSourceAddressWhitelist

boolean

cryptoSourceAddressWhitelist

object

Returns a CoinListObject

emailNotificationList

object

withdrawWhitelistingEnablement

boolean

postTradeSettlements

object

CompanyProfileUsersObject

ParameterType Description

username

string

Account's username

email

string

Account's email

canApprove

boolean

Indication if account can approve transactions or not.

canEditSettings

boolean

Indication if account can edit users settings or not.

withdrawalAccess

string

Either "directAccess" or "approvalRequired"

canTrade

boolean

Indication if account can make trades or not.

status

string

Status of account

Last updated