Wallet Information

Balance

Total balance specifications of a specific currency. Available, locked and total balance. Does not work yet in backtests and for simulated accounts.

Syntax: Balance([ accountId ], [ coin ], [ market ])

Returns a result object with the available, locked and total balance.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
accountId	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid
coin	String	False	Text
market	String	False	InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

BalanceAmount

Total balance value of a specific currency. Including order and position margin. Does not work yet in backtests and for simulated accounts.

Syntax: BalanceAmount([ accountId ], [ coin ], [ market ])

Returns the total balance value.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
accountId	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid
coin	String	False	Text
market	String	False	InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

MaxExitLongAmount

Calculates the maximum amount which can be used to place an exit long order based on wallet data. Assets reserved in open orders are excluded by default.

Syntax: MaxExitLongAmount([ market ])

Returns the maximum exit long amount.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
market	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid

MaxExitShortAmount

Calculates the maximum amount which can be used to place an exit short order based on wallet data. Assets reserved in open orders are excluded by default.

Syntax: MaxExitShortAmount([ market ])

Returns the maximum exit short amount.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
market	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid

MaxLongAmount

Calculates the maximum amount which can be used to place a long order based on wallet data.

Syntax: MaxLongAmount([ market ])

Returns the maximum long amount.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
market	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid

MaxShortAmount

Calculates the maximum amount which can be used to place a short order based on wallet data.

Syntax: MaxShortAmount([ market ])

Returns the maximum long amount.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
market	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid

UserPositionContainer

Gets all the information from the open user position.

Syntax: UserPositionContainer([ accountId ], [ market ], [ leverage ], [ direction ])

Returns an array with position information.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
accountId	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid
market	String	False	InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
leverage	Number	False	Input,Number,Leverage
direction	Enum	False	PositionLong,PositionShort,NoPosition

WalletAmount

Get the available amount in the wallet.

Syntax: WalletAmount([ accountId ], [ coin ], [ market ])

Returns the available amount.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
accountId	String	False	InputAccount,InputAccountMarket,InputMarket,AccountGuid
coin	String	False	Text
market	String	False	InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

WalletCheck

Checks if the wallet has enough of the funds.

Syntax: WalletCheck(accountId, coin, amount)

Returns true if the wallet has enough funds.

Return type: Boolean

Parameter Name	Parameter Type	Required	Suggestions
accountId	String	True	InputAccount,InputAccountMarket,InputMarket,AccountGuid
coin	String	True	Text
amount	Number	True	MathMultiply,MathDivide