Wallet

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.

  • MaxExitLongAmount([ market ])

Returns the maximum exit long amount.

Return Type: Number

Parameter Name

Parameter Type

Required

Suggested

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.

  • MaxExitShortAmount([ market ])

Returns the maximum exit short amount.

Return Type: Number

Parameter Name

Parameter Type

Required

Suggested

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.

  • MaxLongAmount([ market ])

Returns the maximum long amount.

Return Type: Number

Parameter Name

Parameter Type

Required

Suggested

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.

  • MaxShortAmount([ market ])

Returns the maximum long amount.

Return Type: Number

Parameter Name

Parameter Type

Required

Suggested

market

String

False

InputAccount, InputAccountMarket, InputMarket, AccountGuid

UserPositionContainer

Gets all the information from the open user position.

  • UserPositionContainer([ accountId ], [ market ], [ leverage ], [ direction ])

Returns an array with position information.

Return Type: Dynamic

Parameter Name

Parameter Type

Required

Suggested

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.

  • WalletAmount(accountId, coin)

Returns the available amount.

Return Type: Number

Parameter Name

Parameter Type

Required

Suggested

accountId

String

True

InputAccount, InputAccountMarket, InputMarket, AccountGuid

coin

String

True

Text

WalletCheck

Checks if the wallet has enough of the funds.

  • WalletCheck(accountId, coin, amount)

Returns true if the wallet has enough funds.

Return Type: Boolean

Parameter Name

Parameter Type

Required

Suggested

accountId

String

True

InputAccount, InputAccountMarket, InputMarket, AccountGuid

coin

String

True

Text

amount

Number

True

Mul, Div