ContextQMD
Back to Ccxt

Dydx

wiki/exchanges/dydx.md

4.5.5229.0 KB
Original Source

<a name="dydx" id="dydx"></a>

dydx{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>dydx</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See: https://docs.dydx.xyz/indexer-client/http#get-time

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchTime ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for hyperliquid

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - an array of objects representing market data

See: https://docs.dydx.xyz/indexer-client/http#get-perpetual-markets

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchMarkets ([params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>dydx</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://developer.woox.io/api-reference/endpoint/public_data/marketTrades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchTrades (symbol[, since, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

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

See: https://docs.dydx.xyz/indexer-client/http#get-candles

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch entries for
javascript
dydx.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchFundingRateHistory" id="fetchfundingratehistory"></a>

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of funding rate structures

See: https://docs.dydx.xyz/indexer-client/http#get-historical-funding

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
since<code>int</code>Notimestamp in ms of the earliest funding rate to fetch
limit<code>int</code>Nothe maximum amount of funding rate structures to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest funding rate
javascript
dydx.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - An order structure

See: https://docs.dydx.xyz/indexer-client/http#get-order

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchOrder (id, symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>dydx</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://docs.dydx.xyz/indexer-client/http#list-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchOrders (symbol[, since, limit, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>dydx</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://docs.dydx.xyz/indexer-client/http#list-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>dydx</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://docs.dydx.xyz/indexer-client/http#list-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchClosedOrders (symbol[, since, limit, params])

<a name="fetchPosition" id="fetchposition"></a>

fetchPosition{docsify-ignore}

fetch data on an open position

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a position structure

See: https://docs.dydx.xyz/indexer-client/http#list-positions

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the position is held in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchPosition (symbol[, params])

<a name="fetchPositions" id="fetchpositions"></a>

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://docs.dydx.xyz/indexer-client/http#list-positions

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchPositions ([symbols, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - an order structure

See: https://docs.dydx.xyz/interaction/trading#place-an-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.timeInForce<code>string</code>No"GTT", "IOC", or "PO"
params.triggerPrice<code>float</code>NoThe price a trigger order is triggered at
params.stopLossPrice<code>float</code>Noprice for a stoploss order
params.takeProfitPrice<code>float</code>Noprice for a takeprofit order
params.clientOrderId<code>string</code>Noa unique id for the order
params.postOnly<code>bool</code>Notrue or false whether the order is post-only
params.reduceOnly<code>bool</code>Notrue or false whether the order is reduce-only
params.goodTillBlock<code>float</code>Noexpired block number for the order, required for market order and non limit GTT order, default value is latestBlockHeight + 20
params.goodTillBlockTimeInSeconds<code>float</code>Noexpired time elapsed for the order, required for limit GTT order and conditional, default value is 30 days
javascript
dydx.createOrder (symbol, type, side, amount[, price, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - An order structure

See: https://docs.dydx.xyz/interaction/trading/#cancel-an-order

ParamTypeRequiredDescription
id<code>string</code>Yesit should be the clientOrderId in this case
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderId<code>string</code>Noclient order id used when creating the order
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
params.orderFlags<code>float</code>Nodefault is 64, orderFlags for the order, market order and non limit GTT order is 0, limit GTT order is 64 and conditional order is 32
params.goodTillBlock<code>float</code>Noexpired block number for the order, required for market order and non limit GTT order (orderFlags = 0), default value is latestBlockHeight + 20
params.goodTillBlockTimeInSeconds<code>float</code>Noexpired time elapsed for the order, required for limit GTT order and conditional (orderFlagss > 0), default value is 30 days
params.subAccountId<code>int</code>Nosub account id, default is 0
javascript
dydx.cancelOrder (id, symbol[, params])

<a name="cancelOrders" id="cancelorders"></a>

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - an list of order structures

ParamTypeRequiredDescription
ids<code>Array<string></code>Yesorder ids
symbol<code>string</code>Nounified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderIds<code>Array<string></code>Nomax length 10 e.g. ["my_id_1","my_id_2"], encode the double quotes. No space after comma
params.subAccountId<code>int</code>Nosub account id, default is 0
javascript
dydx.cancelOrders (ids[, symbol, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://docs.dydx.xyz/indexer-client/http#get-perpetual-market-orderbook

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchOrderBook (symbol[, limit, params])

<a name="fetchLedger" id="fetchledger"></a>

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 <code>dydx</code>
Returns: <code>object</code> - a ledger structure

See: https://docs.dydx.xyz/indexer-client/http#get-transfers

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code, default is undefined
since<code>int</code>Notimestamp in ms of the earliest ledger entry, default is undefined
limit<code>int</code>Nomax number of ledger entries to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchLedger ([code, since, limit, params])

<a name="transfer" id="transfer"></a>

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a transfer structure

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesamount to transfer
fromAccount<code>string</code>Yesaccount to transfer from main, subaccount
toAccount<code>string</code>Yesaccount to transfer to subaccount, address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.vaultAddress<code>string</code>Nothe vault address for order
javascript
dydx.transfer (code, amount, fromAccount, toAccount[, params])

<a name="fetchTransfers" id="fetchtransfers"></a>

fetchTransfers{docsify-ignore}

fetch a history of internal transfers made on an account

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of transfer structures

See: https://docs.dydx.xyz/indexer-client/http#get-transfers

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency transferred
since<code>int</code>Nothe earliest time in ms to fetch transfers for
limit<code>int</code>Nothe maximum number of transfers structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchTransfers (code[, since, limit, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a transaction structure

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.withdraw (code, amount, address, tag[, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://docs.dydx.xyz/indexer-client/http#get-transfers

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchWithdrawals (code[, since, limit, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://docs.dydx.xyz/indexer-client/http#get-transfers

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchDeposits (code[, since, limit, params])

<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a list of transaction structure

See: https://docs.dydx.xyz/indexer-client/http#get-transfers

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code for the currency of the deposit/withdrawals, default is undefined
since<code>int</code>Notimestamp in ms of the earliest deposit/withdrawal, default is undefined
limit<code>int</code>Nomax number of deposit/withdrawals to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
params.subAccountNumber<code>string</code>Nosub account number
javascript
dydx.fetchDepositsWithdrawals ([code, since, limit, params])

<a name="fetchAccounts" id="fetchaccounts"></a>

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a dictionary of account structures indexed by the account type

See: https://docs.dydx.xyz/indexer-client/http#get-subaccounts

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.address<code>string</code>Nowallet address that made trades
javascript
dydx.fetchAccounts ([params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - a balance structure

See: https://docs.dydx.xyz/indexer-client/http#get-subaccount

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.fetchBalance ([params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://docs.dydx.xyz/indexer-client/websockets#trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.watchTrades (symbol[, since, limit, params])

<a name="unWatchTrades" id="unwatchtrades"></a>

unWatchTrades{docsify-ignore}

unsubscribes from the trades channel

Kind: instance method of <code>dydx</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://docs.dydx.xyz/indexer-client/websockets#trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.unWatchTrades (symbol[, params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://docs.dydx.xyz/indexer-client/websockets#orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.watchOrderBook (symbol[, limit, params])

<a name="unWatchOrderBook" id="unwatchorderbook"></a>

unWatchOrderBook{docsify-ignore}

unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>dydx</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://docs.dydx.xyz/indexer-client/websockets#orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified array of symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.unWatchOrderBook (symbol[, params])

<a name="watchOHLCV" id="watchohlcv"></a>

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

See: https://docs.dydx.xyz/indexer-client/websockets#candles

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
dydx.watchOHLCV (symbol, timeframe[, since, limit, params])

<a name="unWatchOHLCV" id="unwatchohlcv"></a>

unWatchOHLCV{docsify-ignore}

unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of <code>dydx</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.dydx.xyz/indexer-client/websockets#candles

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.timezone<code>object</code>Noif provided, kline intervals are interpreted in that timezone instead of UTC, example '+08:00'
javascript
dydx.unWatchOHLCV (symbol, timeframe[, params])