extended
extended cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
extended
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchMyTrades
- fetchFundingHistory
- fetchOHLCV
- fetchFundingRateHistory
- fetchOpenInterestHistory
- fetchBalance
- fetchAccount
- fetchAccounts
- fetchLedger
- fetchTransactions
- fetchDeposits
- fetchWithdrawals
- withdraw
- fetchTransfers
- transfer
- fetchTradingFee
- fetchTradingFees
- fetchLeverage
- setLeverage
- fetchPositions
- fetchPosition
- fetchPositionsHistory
- createOrder
- editOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- cancelAllOrdersAfter
- fetchOrder
- fetchOpenOrders
- fetchOrders
- fetchClosedOrders
- fetchCanceledOrders
- watchOrderBook
- watchOrders
- watchBalance
- watchMyTrades
- watchPositions
- watchFundingRate
- watchMarkPrice
- watchTrades
- watchOHLCV
fetchMarkets
retrieves data on all markets for extended
Kind: instance method of extended
Returns: Array<object> - an array of objects representing market data
See: https://api.docs.extended.exchange/#get-markets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of extended
Returns: object - an associative dictionary of currencies
See: https://api.docs.extended.exchange/#get-assets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchCurrencies (params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of extended
Returns: object - a ticker structure
See: https://api.docs.extended.exchange/#get-market-statistics
| 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 |
extended.fetchTicker (symbol, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for all markets
Kind: instance method of extended
Returns: object - a dictionary of ticker structures
See: https://api.docs.extended.exchange/#get-markets
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchTickers (symbols?, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of extended
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api.docs.extended.exchange/#get-market-order-book
| 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 |
extended.fetchOrderBook (symbol, limit?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of extended
Returns: Array<Trade> - a list of trade structures
See: https://api.docs.extended.exchange/#get-market-last-trades
| 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 |
extended.fetchTrades (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of extended
Returns: Array<Trade> - a list of trade structures
See: https://api.docs.extended.exchange/#get-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the trades |
| 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 |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchMyTrades (symbol?, since?, limit?, params?)fetchFundingHistory
fetch the funding payments history
Kind: instance method of extended
Returns: Array<FundingHistory> - a list of funding history structures
See: https://api.docs.extended.exchange/#get-funding-payments
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| since | int | No | the earliest time in ms to fetch funding history for |
| limit | int | No | the maximum number of funding history structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchFundingHistory (symbol?, since?, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of extended
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api.docs.extended.exchange/#get-candles-history
| 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, default 100 |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.candleType | string | No | candle type: 'trades' (default), 'mark-prices', or 'index-prices' |
| params.price | string | No | ignored if params.candleType is set 'mark' or 'index' for mark price and index price candles |
| params.until | int | No | end timestamp in ms for the requested period |
extended.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of extended
Returns: Array<object> - a list of funding rate structures
See: https://api.docs.extended.exchange/#get-funding-rates-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch funding rate history for |
| since | int | No | timestamp in ms of the earliest funding rate to fetch |
| limit | int | No | the maximum amount of entries 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 to fetch |
| params.endTime | int | No | exchange-specific end timestamp in ms of the latest funding rate to fetch |
| params.cursor | int | No | offset of the result set |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchOpenInterestHistory
Retrieves the open interest history of a currency
Kind: instance method of extended
Returns: Array<object> - an array of open interest structures
See: https://api.docs.extended.exchange/#get-open-interest-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified CCXT market symbol |
| timeframe | string | Yes | '1h' or '1d' |
| since | int | No | the time(ms) of the earliest record to retrieve as a unix timestamp |
| limit | int | No | the maximum amount of open interest structures to retrieve |
| params | object | No | exchange specific parameters |
| params.until | int | No | timestamp in ms of the latest open interest record to fetch |
extended.fetchOpenInterestHistory (symbol, timeframe, since?, limit?, params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of extended
Returns: object - a balance structure
See: https://api.docs.extended.exchange/#get-spot-balances
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchBalance (params?)fetchAccount
fetch the current authenticated sub-account
Kind: instance method of extended
Returns: object - an account structure
See: https://api.docs.extended.exchange/#get-account-details
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchAccount (params?)fetchAccounts
fetch the current authenticated sub-account, extended private endpoints only return records for the authenticated sub-account
Kind: instance method of extended
Returns: Array<object> - a list of account structures
See: https://api.docs.extended.exchange/#get-sub-accounts
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchAccounts (params?)fetchLedger
fetch the history of changes, actions done by the user or operations that altered the balance of the user
Kind: instance method of extended
Returns: Array<object> - a list of ledger structures
See: https://api.docs.extended.exchange/#get-deposits-withdrawals-transfers-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | timestamp in ms of the earliest ledger entry |
| limit | int | No | max number of ledger entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchLedger (code?, since?, limit?, params?)fetchTransactions
fetch history of deposits, withdrawals, and transfers
Kind: instance method of extended
Returns: Array<Transaction> - a list of transaction structures
See: https://api.docs.extended.exchange/#get-deposits-withdrawals-transfers-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | the earliest time in ms to fetch transactions for |
| limit | int | No | the maximum number of transaction structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchTransactions (code?, since?, limit?, params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of extended
Returns: Array<Transaction> - a list of transaction structures
See: https://api.docs.extended.exchange/#get-deposits-withdrawals-transfers-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | the earliest time in ms to fetch deposits for |
| limit | int | No | the maximum number of deposit structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchDeposits (code?, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of extended
Returns: Array<Transaction> - a list of transaction structures
See: https://api.docs.extended.exchange/#get-deposits-withdrawals-transfers-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | the earliest time in ms to fetch withdrawals for |
| limit | int | No | the maximum number of withdrawal structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchWithdrawals (code?, since?, limit?, params?)withdraw
make a Starknet withdrawal
Kind: instance method of extended
Returns: object - a transaction structure
See: https://api.docs.extended.exchange/#withdrawals
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | the amount to withdraw |
| address | string | Yes | the Starknet address to withdraw to |
| tag | string | Yes | unused |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.chainId | string | No | only STRK is supported |
| params.settlementExpiration | int | No | settlement expiration timestamp in seconds, defaults to now + 14 days + 60 seconds |
extended.withdraw (code, amount, address, tag, params?)fetchTransfers
fetch a history of internal transfers made on an account
Kind: instance method of extended
Returns: Array<TransferEntry> - a list of transfer structures
See: https://api.docs.extended.exchange/#get-deposits-withdrawals-transfers-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | the earliest time in ms to fetch transfers for |
| limit | int | No | the maximum number of transfer structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchTransfers (code?, since?, limit?, params?)transfer
transfer collateral between sub-accounts associated with the same wallet
Kind: instance method of extended
Returns: object - a transfer structure
See: https://api.docs.extended.exchange/#create-transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | the amount to transfer |
| fromAccount | string | Yes | source account id, defaults to the authenticated account id |
| toAccount | string | Yes | destination account id |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.toVault | string | Yes | destination account L2 vault |
| params.toL2Key | string | Yes | destination account L2 public key |
| params.settlementExpiration | int | No | settlement expiration timestamp in seconds, defaults to now + 21 days |
extended.transfer (code, amount, fromAccount, toAccount, params?)fetchTradingFee
fetch the trading fees for a market
Kind: instance method of extended
Returns: object - a fee structure
See: https://api.docs.extended.exchange/#get-fees
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.builderId | string | No | builder client id |
extended.fetchTradingFee (symbol, params?)fetchTradingFees
fetch the trading fees for multiple markets
Kind: instance method of extended
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://api.docs.extended.exchange/#get-fees
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.market | string | No | exchange market id |
| params.builderId | string | No | builder client id |
extended.fetchTradingFees (params?)fetchLeverage
fetch the set leverage for a market
Kind: instance method of extended
Returns: object - a leverage structure
See: https://api.docs.extended.exchange/#get-leverage
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchLeverage (symbol, params?)setLeverage
set the level of leverage for a market
Kind: instance method of extended
Returns: object - response from the exchange
See: https://api.docs.extended.exchange/#update-leverage
| Param | Type | Required | Description |
|---|---|---|---|
| leverage | int | Yes | the rate of leverage |
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.setLeverage (leverage, symbol, params?)fetchPositions
fetch all open positions
Kind: instance method of extended
Returns: Array<Position> - a list of position structures
See: https://api.docs.extended.exchange/#get-positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchPositions (symbols, params?)fetchPosition
fetch data on an open position
Kind: instance method of extended
Returns: object - a position structure
See: https://api.docs.extended.exchange/#get-positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market the position is held in |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchPosition (symbol, params?)fetchPositionsHistory
fetch historical positions
Kind: instance method of extended
Returns: Array<Position> - a list of position structures
See: https://api.docs.extended.exchange/#get-positions-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | list of unified market symbols |
| since | int | No | the earliest time in ms to fetch positions for |
| limit | int | No | the maximum number of position structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchPositionsHistory (symbols, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of extended
Returns: object - an order structure
See: https://api.docs.extended.exchange/#create-or-edit-order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | 'limit' or 'market' |
| 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 fulfilled, in units of the quote currency, required for all order types |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string | No | client order id, sent as the exchange order id |
| params.cancelId | string | No | previous external order id to replace |
| params.timeInForce | string | No | 'GTT' or 'IOC' |
| params.postOnly | boolean | No | true if the order should only make liquidity |
| params.reduceOnly | boolean | No | true if the order should only reduce a position |
| params.fee | string | No | max fee rate for the order, default is 0.0005 |
| params.expiryEpochMillis | int | No | order expiration timestamp in milliseconds, default is now + 1 hour |
| params.triggerPrice | float | No | swap only The price at which a trigger order is triggered at |
| params.stopLossPrice | float | No | swap only The price at which a stop loss order is triggered at |
| params.takeProfitPrice | float | No | swap only The price at which a take profit order is triggered at |
| params.takeProfit | object | No | takeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only) |
| params.takeProfit.triggerPrice | float | No | swap only take profit trigger price |
| params.takeProfit.price | float | No | swap only the execution price for a take profit attached to a trigger order |
| params.takeProfit.type | string | No | swap only the type for a take profit attached to a trigger order, 'LAST', 'MARK' or 'INDEX', default is '' |
| params.stopLoss | object | No | stopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only) |
| params.stopLoss.triggerPrice | float | No | swap only stop loss trigger price |
| params.stopLoss.price | float | No | swap only the execution price for a stop loss attached to a trigger order |
| params.stopLoss.type | string | No | swap only the type for a stop loss attached to a trigger order, 'LAST', 'MARK' or 'INDEX', default is '' |
extended.createOrder (symbol, type, side, amount, price?, params?)editOrder
edit a trade order
Kind: instance method of extended
Returns: object - an order structure
See: https://api.docs.extended.exchange/#create-or-edit-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id assigned by Extended |
| symbol | string | Yes | unified symbol of the market to edit an order in |
| type | string | Yes | 'limit' or 'market' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | No | 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 fulfilled, in units of the quote currency |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.editOrder (id, symbol, type, side, amount?, price?, params?)cancelOrder
cancels an open order
Kind: instance method of extended
Returns: object - An order structure
See
- https://api.docs.extended.exchange/#cancel-order-by-id
- https://api.docs.extended.exchange/#cancel-order-by-external-id
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id assigned by Extended |
| symbol | string | No | 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 | user-defined order id, cancels by external id |
extended.cancelOrder (id, symbol?, params?)cancelOrders
cancel multiple orders by order ids or client order ids
Kind: instance method of extended
Returns: Array<object> - a list of order structures
See: https://api.docs.extended.exchange/#mass-cancel
| Param | Type | Required | Description |
|---|---|---|---|
| ids | Array<string> | Yes | order ids |
| symbol | string | No | unified market symbol, only used to populate the returned orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderIds | Array<string> | No | client order ids |
| params.clientOrderId | string | No | single client order id |
extended.cancelOrders (ids, symbol?, params?)cancelAllOrders
cancels all open orders, optionally filtered by symbol
Kind: instance method of extended
Returns: Array<object> - a list of order structures
See: https://api.docs.extended.exchange/#mass-cancel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the market to cancel orders in |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.cancelAllOrders (symbol?, params?)cancelAllOrdersAfter
dead man's switch, cancel all orders after the given timeout
Kind: instance method of extended
Returns: object - the api result
See: https://api.docs.extended.exchange/#mass-auto-cancel-dead-man-39-s-switch
| Param | Type | Required | Description |
|---|---|---|---|
| timeout | number | Yes | time in milliseconds, 0 represents cancel the timer |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.cancelAllOrdersAfter (timeout, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of extended
Returns: object - An order structure
See
- https://api.docs.extended.exchange/#get-order-by-id
- https://api.docs.extended.exchange/#get-orders-by-external-id
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id assigned by Extended |
| symbol | string | No | 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 | user-defined order id, fetches by external id |
extended.fetchOrder (id, symbol?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of extended
Returns: Array<Order> - a list of order structures
See: https://api.docs.extended.exchange/#get-open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the orders |
| since | int | No | the earliest time in ms to fetch orders for |
| limit | int | No | the maximum number of open order structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.fetchOpenOrders (symbol?, since?, limit?, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of extended
Returns: Array<Order> - a list of order structures
See: https://api.docs.extended.exchange/#get-orders-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the orders |
| 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.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchOrders (symbol?, since?, limit?, params?)fetchClosedOrders
fetches information on multiple closed orders made by the user
Kind: instance method of extended
Returns: Array<Order> - a list of order structures
See: https://api.docs.extended.exchange/#get-orders-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the orders |
| 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.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchClosedOrders (symbol?, since?, limit?, params?)fetchCanceledOrders
fetches information on multiple canceled orders made by the user
Kind: instance method of extended
Returns: Array<Order> - a list of order structures
See: https://api.docs.extended.exchange/#get-orders-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the orders |
| 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.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
extended.fetchCanceledOrders (symbol?, since?, limit?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of extended
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api.docs.extended.exchange/#order-book-stream
| 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 |
| params.depth | string | No | set to '1' to receive best bid and ask snapshots only |
extended.watchOrderBook (symbol, limit?, params?)watchOrders
watches information on multiple orders made by the user
Kind: instance method of extended
Returns: Array<object> - a list of order structures
See: https://api.docs.extended.exchange/#account-updates-stream
| 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 |
extended.watchOrders (symbol, since?, limit?, params?)watchBalance
watches balance updates
Kind: instance method of extended
Returns: object - a balance structure
See: https://api.docs.extended.exchange/#account-updates-stream
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.watchBalance (params?)watchMyTrades
watches information on multiple trades made by the user
Kind: instance method of extended
Returns: Array<object> - a list of trade structures
See: https://api.docs.extended.exchange/#account-updates-stream
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the trades |
| 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 |
extended.watchMyTrades (symbol?, since?, limit?, params?)watchPositions
watches information on multiple positions
Kind: instance method of extended
Returns: Array<object> - a list of position structures
See: https://api.docs.extended.exchange/#account-updates-stream
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| since | int | No | the earliest time in ms to fetch positions for |
| limit | int | No | the maximum number of position structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.watchPositions (symbols?, since?, limit?, params?)watchFundingRate
watch the current funding rate
Kind: instance method of extended
Returns: object - a funding rate structure
See: https://api.docs.extended.exchange/#funding-rates-stream
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
extended.watchFundingRate (symbol, params?)watchMarkPrice
watches a mark price for a specific market
Kind: instance method of extended
Returns: object - a ticker structure
See: https://api.docs.extended.exchange/#mark-price-stream
| 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 |
extended.watchMarkPrice (symbol, params?)watchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of extended
Returns: Array<object> - a list of trade structures
See: https://api.docs.extended.exchange/#trades-stream
| 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 |
extended.watchTrades (symbol, since?, limit?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of extended
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api.docs.extended.exchange/#candles-stream
| 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.candleType | string | No | candle type: 'trades' (default), 'mark-prices', or 'index-prices' |
| params.price | string | No | ignored if params.candleType is set 'mark' or 'index' for mark price and index price candles |
extended.watchOHLCV (symbol, timeframe, since?, limit?, params?)