Trade Market Information
Last updated
Last updated
Gets the amount label. For reflection, in case the market is Bitstamp BTC/USDit will return 'BTC'. When we are on BitMEX XBT/USD (XBTUSD), it will return 'contract(s)'.
Syntax: AmountCurrency([ market ])
Returns the amount label as string.
Return type: String
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
Returns a number of how many decimals is allowed for order amounts.
Syntax: AmountDecimals([ market ], [ amount ])
Returns the allowed decimal count.
Return type: Number
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
Gets the amount label. For reflection, in case the market is Bitstamp BTC/USDit will return 'BTC'. When we are on BitMEX XBT/USD (XBTUSD), it will return 'contract(s)'.
Syntax: AmountLabel([ market ])
Returns the amount label as string.
Return type: String
Returns the minimum allowed trade amount step for market.
Syntax: AmountStep([ market ])
Returns the trade amount step size.
Return type: Number
Returns the base currency of the market. For reflection, in case we are on Bitstamp BTC/USD it will return 'BTC'.
Syntax: BaseCurrency([ market ])
Returns the base currency as string.
Return type: String
Gets the contract name of the market.
Syntax: ContractName([ market ])
Returns the contract name of the market.
Return type: String
Gets the value of a single contract, defined in their denomination.
Syntax: ContractValue([ market ])
Returns the value of a single contract, defined in their denomination.
Return type: Number
Gets whether or not the trade amount is high enough for exchange limits.
Syntax: IsTradeAmountEnough(market, price, amount, [ logWarning ])
Returns whether or not the trade amount is high enough for exchange limits.
Return type: Boolean
Gets makers fee of the market.
Syntax: MakersFee([ market ])
Returns makers fee of the market.
Return type: Number
Gets the market type enumeration of the market.
Syntax: MarketType([ market ])
Returns SpotTrading, MarginTrading or LeverageTrading.
Return type: Enum
Calculates the minimum trade amount on a certain price while keeping exchange specifications in consideration.
Syntax: MinimumTradeAmount([ market ], [ price ])
Returns the minimum trade amount taking the decimal count, minimum amount and volume into account.
Return type: Number
Parses the trade amount to exchange specifications.
Syntax: ParseTradeAmount(market, price, amount)
Returns the trade amount adjusted for exchange specifications.
Return type: Number
Parses the trade price to exchange specifications.
Syntax: ParseTradePrice(market, price)
Returns the trade price adjusted for exchange specifications.
Return type: Number
Returns a number of how many decimals is allowed for order prices.
Syntax: PriceDecimals([ market ], [ price ])
Returns the allowed decimal count.
Return type: Number
Returns the minimum allowed price step for market.
Syntax: PriceStep([ market ])
Returns the price step size.
Return type: Number
Returns the profit label. For reflection, in case the market is Bitstamp BTC/USD it will return 'USD'. When we are on BitMEX XBT/USD (XBTUSD), it will return 'XBT'.
Syntax: ProfitCurrency([ market ])
Returns the profit label as string.
Return type: String
Returns the profit label. For reflection, in case the market is Bitstamp BTC/USD it will return 'USD'. When we are on BitMEX XBT/USD (XBTUSD), it will return 'XBT'.
Syntax: ProfitLabel([ market ])
Returns the profit label as string.
Return type: String
Returns the quote currency of the market. For reflection, in case we are on Bitstamp BTC/USD it will return 'USD'.
Syntax: QuoteCurrency([ market ])
Returns the quote currency as string.
Return type: String
Returns a number of how many decimals is allowed for order prices.
Syntax: QuoteDecimals([ market ], [ price ])
Returns the allowed decimal count.
Return type: Number
Returns the minimum allowed price step for market.
Syntax: QuoteStep([ market ])
Returns the price step size.
Return type: Number
Saves a custom fee percentage which is used in back tests and returned by Fee().
Syntax: SetFee(percentage, [ market ])
Return type: Void
Gets takers fee of the market.
Syntax: TakersFee([ market ])
Returns takers fee of the market.
Return type: Number
Retrieves all the information on the trade market.
Syntax: TradeMarketContainer([ market ])
Returns the market information on an array.
Return type: Dynamic
Returns the underlying assets of the market. For reflection, in case we are on Bitstamp BTC/USD it will return 'BTC'. When we are on BitMEX XBT/USD (XBTUSD), it will return 'XBT'.
Syntax: UnderlyingAsset([ market ])
Returns the underlying assets as string.
Return type: String
Calculates the used margin for a specific position.
Syntax: UsedMargin(market, price, amount, leverage)
Returns the amount in the underlying currency value.
Return type: Number
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
amount
Number
False
Input,Number,SessionGet
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
True
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
True
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
amount
Number
True
logWarning
Boolean
False
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
False
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
market
String
True
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
True
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
amount
Number
True
market
String
True
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
True
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
False
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
False
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
percentage
Number
True
Input,Number,SessionGet
market
String
False
InputAccount,InputAccountMarket,InputMarket,AccountGuid
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
False
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
market
String
True
InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
price
Number
True
GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices
amount
Number
True
leverage
Number
True
Input,Number,Leverage