delta

delta{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchTime
• fetchStatus
• fetchCurrencies
• fetchMarkets
• fetchTicker
• fetchTickers
• fetchOrderBook
• fetchTrades
• fetchOHLCV
• fetchBalance
• fetchPosition
• fetchPositions
• createOrder
• editOrder
• cancelOrder
• cancelAllOrders
• fetchOrder
• fetchOpenOrders
• fetchClosedOrders
• fetchMyTrades
• fetchLedger
• fetchDepositAddress
• fetchFundingRate
• fetchFundingRates
• addMargin
• reduceMargin
• fetchOpenInterest
• fetchLeverage
• setLeverage
• fetchSettlementHistory
• fetchGreeks
• closeAllPositions
• fetchMarginMode
• fetchOption
• fetchPositionsADLRank

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of 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

delta.fetchTime (params?)

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of delta
Returns: object - a status structure

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

delta.fetchStatus (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of 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

delta.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for delta

Kind: instance method of 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

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
Returns: object - a 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

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
Returns: object - a dictionary of ticker structures

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

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
Returns: object - A dictionary of order book structures 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

delta.fetchOrderBook (symbol, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of delta
Returns: Array<Trade> - a list of trade structures

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

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
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.delta.exchange/#delta-exchange-api-v2-historical-ohlc-candles-sparklines

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	string	No	timestamp in ms of the latest candle to fetch

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
Returns: object - a 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

delta.fetchBalance (params?)

fetchPosition{docsify-ignore}

fetch data on a single open contract trade position

Kind: instance method of delta
Returns: object - a 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

delta.fetchPosition (symbol, params?)

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of delta
Returns: Array<object> - a list of 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

delta.fetchPositions (symbols, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of delta
Returns: object - an 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

delta.createOrder (symbol, type, side, amount, price?, params?)

editOrder{docsify-ignore}

edit a trade order

Kind: instance method of delta
Returns: object - an 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

delta.editOrder (id, symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of delta
Returns: object - An 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

delta.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of delta
Returns: Array<object> - a list of order structures

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

delta.cancelAllOrders (symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of delta
Returns: object - an order structure

See

• https://docs.delta.exchange/#get-order-by-id
• https://docs.delta.exchange/#get-order-by-client-oid

Param	Type	Required	Description
id	string	Yes	the order id
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	client order id of the order

delta.fetchOrder (id, symbol?, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of delta
Returns: Array<Order> - a list of order structures

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

delta.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of delta
Returns: Array<Order> - a list of order structures

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

delta.fetchClosedOrders (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of delta
Returns: Array<Trade> - a list of trade structures

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

delta.fetchMyTrades (symbol, since?, limit?, params?)

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of delta
Returns: object - a ledger structure

See: https://docs.delta.exchange/#get-wallet-transactions

Param	Type	Required	Description
code	string	No	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 entries to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

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
Returns: object - an 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

delta.fetchDepositAddress (code, params?)

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of delta
Returns: object - a 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

delta.fetchFundingRate (symbol, params?)

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

Kind: instance method of delta
Returns: Array<object> - a list of funding rate structures, indexed 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

delta.fetchFundingRates (symbols, params?)

addMargin{docsify-ignore}

add margin

Kind: instance method of delta
Returns: object - a 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

delta.addMargin (symbol, amount, params?)

reduceMargin{docsify-ignore}

remove margin from a position

Kind: instance method of delta
Returns: object - a 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

delta.reduceMargin (symbol, amount, params?)

fetchOpenInterest{docsify-ignore}

retrieves the open interest of a derivative market

Kind: instance method of delta
Returns: object - an open interest structurehttps://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

delta.fetchOpenInterest (symbol, params?)

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of delta
Returns: object - a 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

delta.fetchLeverage (symbol, params?)

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of 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

delta.setLeverage (leverage, symbol, params?)

fetchSettlementHistory{docsify-ignore}

fetches historical settlement records

Kind: instance method of delta
Returns: Array<object> - a list of settlement history objects

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

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
Returns: object - a 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

delta.fetchGreeks (symbol, params?)

closeAllPositions{docsify-ignore}

closes all open positions for a market type

Kind: instance method of delta
Returns: Array<object> - A list of position structures

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

delta.closeAllPositions (params?)

fetchMarginMode{docsify-ignore}

fetches the margin mode of a trading pair

Kind: instance method of delta
Returns: object - a 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

delta.fetchMarginMode (symbol, params?)

fetchOption{docsify-ignore}

fetches option data that is commonly found in an option chain

Kind: instance method of delta
Returns: object - an 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

delta.fetchOption (symbol, params?)

fetchPositionsADLRank{docsify-ignore}

fetches the auto deleveraging rank and risk percentage for a list of symbols

Kind: instance method of delta
Returns: Array<object> - an array of auto de leverage structures

See: https://docs.delta.exchange/#get-margined-positions

Param	Type	Required	Description
symbols	Array<string>	No	a list of unified market symbols
params	object	No	extra parameters specific to the exchange API endpoint

delta.fetchPositionsADLRank (symbols?, params?)