Structures

The data returned by API functions: tickers, depth, trades, K-lines, market information, orders, conditional orders, accounts, assets, positions and funding rates, plus function options and returned objects (Other Structures).

The Info field of a structure holds the raw data from the exchange API (absent in backtests); read it when a standard field is missing. Functions that return a structure return a null value on failure, see Failures and Null Values.

In this sectionRead the whole section

Name	Description
Ticker	Market data returned by exchange.GetTicker(): high, low, best ask, best bid, last price, open, volume and open interest.
Depth	Market depth returned by exchange.GetDepth(): the asks Asks and bids Bids (OrderBook arrays) and a timestamp.
OrderBook	One price level of the asks or bids in market depth (Depth): price and amount.
Trade	Market trade records returned by exchange.GetTrades(), including the trade Id, time, price, amount and side.
Record	Data structure for candlestick bars in standard OHLC format, used for charting candlesticks and calculating technical indicators.
Market	Returned by exchange.GetMarkets(): an instrument's base and quote assets, price and amount steps and precisions, order quantity and notional limits, and contrac…
Order	Returned by exchange.GetOrder(), exchange.GetOrders() and similar: order ID, price, amount, filled amount, average price, status, type, offset, contract code an…
Condition	Conditional order settings: the conditional order type and the take-profit and stop-loss trigger and order prices, used to set the trigger conditions and execut…
Account	Returned by exchange.GetAccount(): the available and frozen amounts of the quote and base currencies, plus equity and unrealized profit and loss on futures.
Asset	One item of the array returned by exchange.GetAssets(): the available and frozen amounts of one currency.
Position	Returned by exchange.GetPositions(): instrument, leverage, amount and frozen amount, average price, unrealized profit, direction, contract code and margin.
Funding	Returned by exchange.GetFundings(): instrument, settlement interval, time and funding rate; only cryptocurrency perpetual contracts have funding rates.
Other Structures (16)	Option objects of functions, and objects or structures they return (connection, chart and concurrent objects, status bar components and button structures, etc.)…