32 KiB
apex{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchTime
- fetchBalance
- fetchAccount
- fetchCurrencies
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchOHLCV
- fetchOrderBook
- fetchTrades
- fetchOpenInterest
- fetchFundingRateHistory
- createOrder
- transfer
- cancelAllOrders
- cancelOrder
- fetchOrder
- fetchOpenOrders
- fetchOrders
- fetchOrderTrades
- fetchMyTrades
- fetchFundingHistory
- setLeverage
- fetchPositions
- watchTrades
- watchTradesForSymbols
- watchOrderBook
- watchOrderBookForSymbols
- watchTicker
- watchTickers
- watchOHLCV
- watchOHLCVForSymbols
- watchMyTrades
- watchPositions
- watchOrders
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of apex
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-system-time-v3
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchTime ([params])
fetchBalance{docsify-ignore}
query for account info
Kind: instance method of apex
Returns: object - a balance structure
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-retrieve-user-account-balance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchBalance ([params])
fetchAccount{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of apex
Returns: object - a balance structure
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-retrieve-user-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchAccount ([params])
fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
Kind: instance method of apex
Returns: object - an associative dictionary of currencies
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-all-config-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchCurrencies ([params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for apex
Kind: instance method of apex
Returns: Array<object> - an array of objects representing market data
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-all-config-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchMarkets ([params])
fetchTicker{docsify-ignore}
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of apex
Returns: object - a ticker structure
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-ticker-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchTicker (symbol[, params])
fetchTickers{docsify-ignore}
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of apex
Returns: object - a ticker structure
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-ticker-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchTickers (symbols[, params])
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of apex
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-candlestick-chart-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | timestamp in ms of the latest candle to fetch |
apex.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of apex
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-market-depth-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchOrderBook (symbol[, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of apex
Returns: Array<Trade> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-newest-trading-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | the latest time in ms to fetch trades for |
| params.paginate | boolean |
No | default false, when true will automatically paginate by calling this endpoint multiple times |
apex.fetchTrades (symbol[, since, limit, params])
fetchOpenInterest{docsify-ignore}
retrieves the open interest of a contract trading pair
Kind: instance method of apex
Returns: object - an open interest structurehttps://docs.ccxt.com/#/?id=open-interest-structure
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-ticker-data-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified CCXT market symbol |
| params | object |
No | exchange specific parameters |
apex.fetchOpenInterest (symbol[, params])
fetchFundingRateHistory{docsify-ignore}
fetches historical funding rate prices
Kind: instance method of apex
Returns: Array<object> - a list of funding rate structures
See: https://api-docs.pro.apex.exchange/#publicapi-v3-for-omni-get-funding-rate-history-v3
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the funding rate history for |
| since | int |
No | timestamp in ms of the earliest funding rate to fetch |
| limit | int |
No | the maximum amount of funding rate structures to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | timestamp in ms of the latest funding rate |
| params.paginate | boolean |
No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters |
apex.fetchFundingRateHistory (symbol[, since, limit, params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of apex
Returns: object - an order structure
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-post-creating-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market' or 'limit' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much of currency you want to trade in units of base currency |
| price | float |
No | the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.triggerPrice | float |
No | The price a trigger order is triggered at |
| params.timeInForce | string |
No | "GTC", "IOC", or "POST_ONLY" |
| params.postOnly | bool |
No | true or false |
| params.reduceOnly | bool |
No | Ensures that the executed order does not flip the opened position. |
| params.clientOrderId | string |
No | a unique id for the order |
apex.createOrder (symbol, type, side, amount[, price, params])
transfer{docsify-ignore}
transfer currency internally between wallets on the same account
Kind: instance method of apex
Returns: object - a transfer structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | amount to transfer |
| fromAccount | string |
Yes | account to transfer from |
| toAccount | string |
Yes | account to transfer to |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.transferId | string |
No | UUID, which is unique across the platform |
apex.transfer (code, amount, fromAccount, toAccount[, params])
cancelAllOrders{docsify-ignore}
cancel all open orders in a market
Kind: instance method of apex
Returns: Array<object> - a list of order structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-post-cancel-all-open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market to cancel orders in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.cancelAllOrders (symbol[, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of apex
Returns: object - An order structure
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-post-cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | Yes | ||
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.cancelOrder (id, symbol[, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of apex
Returns: object - An order structure
See
- https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-order-id
- https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-order-by-clientorderid
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the order id |
| symbol | string |
Yes | unified symbol of the market the order was made in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string |
No | a unique id for the order |
apex.fetchOrder (id, symbol[, params])
fetchOpenOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of apex
Returns: Array<Order> - a list of order structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchOpenOrders (symbol[, since, limit, params])
fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user classic accounts only
Kind: instance method of apex
Returns: Array<Order> - a list of order structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-all-order-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve, default 100 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | object |
No | end time, ms |
| params.status | boolean |
No | "PENDING", "OPEN", "FILLED", "CANCELED", "EXPIRED", "UNTRIGGERED" |
| params.side | boolean |
No | BUY or SELL |
| params.type | string |
No | "LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT","TAKE_PROFIT_MARKET" |
| params.orderType | string |
No | "ACTIVE","CONDITION","HISTORY" |
| params.page | boolean |
No | Page numbers start from 0 |
apex.fetchOrders (symbol[, since, limit, params])
fetchOrderTrades{docsify-ignore}
fetch all the trades made from a single order
Kind: instance method of apex
Returns: Array<object> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-trade-history
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trades to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchOrderTrades (id, symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
fetches information on multiple orders made by the user classic accounts only
Kind: instance method of apex
Returns: Array<Trade> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-trade-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve, default 100 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | object |
No | end time |
| params.side | boolean |
No | BUY or SELL |
| params.orderType | string |
No | "LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT","TAKE_PROFIT_MARKET" |
| params.page | boolean |
No | Page numbers start from 0 |
apex.fetchMyTrades (symbol[, since, limit, params])
fetchFundingHistory{docsify-ignore}
fetches information on multiple orders made by the user classic accounts only
Kind: instance method of apex
Returns: Array<Trade> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-funding-rate
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve, default 100 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | object |
No | end time, ms |
| params.side | boolean |
No | BUY or SELL |
| params.page | boolean |
No | Page numbers start from 0 |
apex.fetchFundingHistory (symbol[, since, limit, params])
setLeverage{docsify-ignore}
set the level of leverage for a market
Kind: instance method of apex
Returns: object - response from the exchange
| Param | Type | Required | Description |
|---|---|---|---|
| leverage | float |
Yes | the rate of leverage |
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.setLeverage (leverage, symbol[, params])
fetchPositions{docsify-ignore}
fetch all open positions
Kind: instance method of apex
Returns: Array<object> - a list of position structure
See: https://api-docs.pro.apex.exchange/#privateapi-v3-for-omni-get-retrieve-user-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
No | list of unified market symbols |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.fetchPositions ([symbols, params])
watchTrades{docsify-ignore}
watches information on multiple trades made in a market
Kind: instance method of apex
Returns: Array<object> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market trades were made in |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trade structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchTrades (symbol[, since, limit, params])
watchTradesForSymbols{docsify-ignore}
get the list of most recent trades for a list of symbols
Kind: instance method of apex
Returns: Array<object> - a list of trade structures
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchTradesForSymbols (symbols[, since, limit, params])
watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of apex
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return. |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchOrderBook (symbol[, limit, params])
watchOrderBookForSymbols{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of apex
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified array of symbols |
| limit | int |
No | the maximum amount of order book entries to return. |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchOrderBookForSymbols (symbols[, limit, params])
watchTicker{docsify-ignore}
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of apex
Returns: object - a ticker structure
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchTicker (symbol[, params])
watchTickers{docsify-ignore}
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
Kind: instance method of apex
Returns: object - a ticker structure
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchTickers (symbols[, params])
watchOHLCV{docsify-ignore}
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of apex
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchOHLCV (symbol, timeframe[, since, limit, params])
watchOHLCVForSymbols{docsify-ignore}
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of apex
Returns: object - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.pro.apex.exchange/#websocket-v3-for-omni-websocket-endpoint
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> |
Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example 'BTC/USDT', '1m'], ['LTC/USDT', '5m' |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchOHLCVForSymbols (symbolsAndTimeframes[, since, limit, params])
watchMyTrades{docsify-ignore}
watches information on multiple trades made by the user
Kind: instance method of apex
Returns: Array<object> - a list of order structures
See: https://api-docs.pro.apex.exchange/#private-websocket
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.unifiedMargin | boolean |
No | use unified margin account |
apex.watchMyTrades (symbol[, since, limit, params])
watchPositions{docsify-ignore}
watch all open positions
Kind: instance method of apex
Returns: Array<object> - a list of position structure
See: https://api-docs.pro.apex.exchange/#private-websocket
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
No | list of unified market symbols |
| since | int |
No | the earliest time in ms to fetch positions for |
| limit | int |
No | the maximum number of positions to retrieve |
| params | object |
Yes | extra parameters specific to the exchange API endpoint |
apex.watchPositions ([symbols, since, limit, params])
watchOrders{docsify-ignore}
watches information on multiple orders made by the user
Kind: instance method of apex
Returns: Array<object> - a list of order structures
See: https://api-docs.pro.apex.exchange/#private-websocket
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
apex.watchOrders (symbol[, since, limit, params])