## delta{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchTime](#fetchtime) * [fetchStatus](#fetchstatus) * [fetchCurrencies](#fetchcurrencies) * [fetchMarkets](#fetchmarkets) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [fetchOrderBook](#fetchorderbook) * [fetchTrades](#fetchtrades) * [fetchOHLCV](#fetchohlcv) * [fetchBalance](#fetchbalance) * [fetchPosition](#fetchposition) * [fetchPositions](#fetchpositions) * [createOrder](#createorder) * [editOrder](#editorder) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [fetchOpenOrders](#fetchopenorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchMyTrades](#fetchmytrades) * [fetchLedger](#fetchledger) * [fetchDepositAddress](#fetchdepositaddress) * [fetchFundingRate](#fetchfundingrate) * [fetchFundingRates](#fetchfundingrates) * [addMargin](#addmargin) * [reduceMargin](#reducemargin) * [fetchOpenInterest](#fetchopeninterest) * [fetchLeverage](#fetchleverage) * [setLeverage](#setleverage) * [fetchSettlementHistory](#fetchsettlementhistory) * [fetchGreeks](#fetchgreeks) * [closeAllPositions](#closeallpositions) * [fetchMarginMode](#fetchmarginmode) * [fetchOption](#fetchoption) ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [delta](#delta) **Returns**: int - the current integer timestamp in milliseconds from the exchange server | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchTime ([params]) ``` ### fetchStatus{docsify-ignore} the latest known information on the availability of the exchange API **Kind**: instance method of [delta](#delta) **Returns**: object - a [status structure](https://docs.ccxt.com/#/?id=exchange-status-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchStatus ([params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [delta](#delta) **Returns**: object - an associative dictionary of currencies **See**: https://docs.delta.exchange/#get-list-of-all-assets | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchCurrencies ([params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for delta **Kind**: instance method of [delta](#delta) **Returns**: Array<object> - an array of objects representing market data **See**: https://docs.delta.exchange/#get-list-of-products | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.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 [delta](#delta) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.delta.exchange/#get-ticker-for-a-product-by-symbol | 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 | ```javascript delta.fetchTicker (symbol[, params]) ``` ### fetchTickers{docsify-ignore} fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market **Kind**: instance method of [delta](#delta) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.delta.exchange/#get-tickers-for-products | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | 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 | ```javascript delta.fetchTickers (symbols[, params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [delta](#delta) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://docs.delta.exchange/#get-l2-orderbook | 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 | ```javascript delta.fetchOrderBook (symbol[, limit, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [delta](#delta) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://docs.delta.exchange/#get-public-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 | ```javascript delta.fetchTrades (symbol[, since, limit, 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 [delta](#delta) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.delta.exchange/#get-ohlc-candles | 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 | ```javascript delta.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [delta](#delta) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://docs.delta.exchange/#get-wallet-balances | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchBalance ([params]) ``` ### fetchPosition{docsify-ignore} fetch data on a single open contract trade position **Kind**: instance method of [delta](#delta) **Returns**: object - a [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.delta.exchange/#get-position | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market the position is held in, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchPosition (symbol[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [delta](#delta) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.delta.exchange/#get-margined-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 | ```javascript delta.fetchPositions (symbols[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [delta](#delta) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#place-order | 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 fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.reduceOnly | bool | No | *contract only* indicates if this order is to reduce the size of a position | ```javascript delta.createOrder (symbol, type, side, amount[, price, params]) ``` ### editOrder{docsify-ignore} edit a trade order **Kind**: instance method of [delta](#delta) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#edit-order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | 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 the currency you want to trade in units of the 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 | ```javascript delta.editOrder (id, symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [delta](#delta) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#cancel-order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | 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 | ```javascript delta.cancelOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders in a market **Kind**: instance method of [delta](#delta) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#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 | ```javascript delta.cancelAllOrders (symbol[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [delta](#delta) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#get-active-orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch open 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 | ```javascript delta.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [delta](#delta) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.delta.exchange/#get-order-history-cancelled-and-closed | 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 | ```javascript delta.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [delta](#delta) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://docs.delta.exchange/#get-user-fills-by-filters | Param | Type | Required | Description | | --- | --- | --- | --- | | 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 structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchLedger{docsify-ignore} fetch the history of changes, actions done by the user or operations that altered balance of the user **Kind**: instance method of [delta](#delta) **Returns**: object - a [ledger structure](https://docs.ccxt.com/#/?id=ledger-structure) **See**: https://docs.delta.exchange/#get-wallet-transactions | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code, default is undefined | | since | int | No | timestamp in ms of the earliest ledger entry, default is undefined | | limit | int | No | max number of ledger entrys to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchLedger (code[, since, limit, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [delta](#delta) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | | params.network | string | No | unified network code | ```javascript delta.fetchDepositAddress (code[, params]) ``` ### fetchFundingRate{docsify-ignore} fetch the current funding rate **Kind**: instance method of [delta](#delta) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://docs.delta.exchange/#get-ticker-for-a-product-by-symbol | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchFundingRate (symbol[, params]) ``` ### fetchFundingRates{docsify-ignore} fetch the funding rate for multiple markets **Kind**: instance method of [delta](#delta) **Returns**: object - a dictionary of [funding rates structures](https://docs.ccxt.com/#/?id=funding-rates-structure), indexe by market symbols **See**: https://docs.delta.exchange/#get-tickers-for-products | 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 | ```javascript delta.fetchFundingRates (symbols[, params]) ``` ### addMargin{docsify-ignore} add margin **Kind**: instance method of [delta](#delta) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure) **See**: https://docs.delta.exchange/#add-remove-position-margin | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | amount of margin to add | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.addMargin (symbol, amount[, params]) ``` ### reduceMargin{docsify-ignore} remove margin from a position **Kind**: instance method of [delta](#delta) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=reduce-margin-structure) **See**: https://docs.delta.exchange/#add-remove-position-margin | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | the amount of margin to remove | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.reduceMargin (symbol, amount[, params]) ``` ### fetchOpenInterest{docsify-ignore} retrieves the open interest of a derivative market **Kind**: instance method of [delta](#delta) **Returns**: object - an open interest structure[https://docs.ccxt.com/#/?id=open-interest-structure](https://docs.ccxt.com/#/?id=open-interest-structure) **See**: https://docs.delta.exchange/#get-ticker-for-a-product-by-symbol | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | exchange specific parameters | ```javascript delta.fetchOpenInterest (symbol[, params]) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [delta](#delta) **Returns**: object - a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure) **See**: https://docs.delta.exchange/#get-order-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchLeverage (symbol[, params]) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [delta](#delta) **Returns**: object - response from the exchange **See**: https://docs.delta.exchange/#change-order-leverage | 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 | ```javascript delta.setLeverage (leverage, symbol[, params]) ``` ### fetchSettlementHistory{docsify-ignore} fetches historical settlement records **Kind**: instance method of [delta](#delta) **Returns**: Array<object> - a list of [settlement history objects](https://docs.ccxt.com/#/?id=settlement-history-structure) **See**: https://docs.delta.exchange/#get-product-settlement-prices | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the settlement history | | since | int | No | timestamp in ms | | limit | int | No | number of records | | params | object | No | exchange specific params | ```javascript delta.fetchSettlementHistory (symbol[, since, limit, params]) ``` ### fetchGreeks{docsify-ignore} fetches an option contracts greeks, financial metrics used to measure the factors that affect the price of an options contract **Kind**: instance method of [delta](#delta) **Returns**: object - a [greeks structure](https://docs.ccxt.com/#/?id=greeks-structure) **See**: https://docs.delta.exchange/#get-ticker-for-a-product-by-symbol | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch greeks for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchGreeks (symbol[, params]) ``` ### closeAllPositions{docsify-ignore} closes all open positions for a market type **Kind**: instance method of [delta](#delta) **Returns**: Array<object> - A list of [position structures](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.delta.exchange/#close-all-positions | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | | params.user_id | int | No | the users id | ```javascript delta.closeAllPositions ([params]) ``` ### fetchMarginMode{docsify-ignore} fetches the margin mode of a trading pair **Kind**: instance method of [delta](#delta) **Returns**: object - a [margin mode structure](https://docs.ccxt.com/#/?id=margin-mode-structure) **See**: https://docs.delta.exchange/#get-user | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the margin mode for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchMarginMode (symbol[, params]) ``` ### fetchOption{docsify-ignore} fetches option data that is commonly found in an option chain **Kind**: instance method of [delta](#delta) **Returns**: object - an [option chain structure](https://docs.ccxt.com/#/?id=option-chain-structure) **See**: https://docs.delta.exchange/#get-ticker-for-a-product-by-symbol | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript delta.fetchOption (symbol[, params]) ```