27 KiB
derive{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchTime
- fetchCurrencies
- fetchMarkets
- fetchTicker
- fetchTrades
- fetchFundingRateHistory
- fetchFundingRate
- createOrder
- editOrder
- cancelOrder
- cancelAllOrders
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchOrderTrades
- fetchMyTrades
- fetchPositions
- fetchFundingHistory
- fetchBalance
- fetchDeposits
- fetchWithdrawals
- watchOrderBook
- watchTicker
- unWatchOrderBook
- unWatchTrades
- watchTrades
- watchOrders
- watchMyTrades
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of derive
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://docs.derive.xyz/reference/post_public-get-time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.fetchTime ([params])
fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
Kind: instance method of derive
Returns: object - an associative dictionary of currencies
See: https://docs.derive.xyz/reference/post_public-get-all-currencies
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.fetchCurrencies ([params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for bybit
Kind: instance method of derive
Returns: Array<object> - an array of objects representing market data
See: https://docs.derive.xyz/reference/post_public-get-all-instruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.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 derive
Returns: object - a ticker structure
See: https://docs.derive.xyz/reference/post_public-get-ticker
| 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 |
derive.fetchTicker (symbol[, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of derive
Returns: Array<Trade> - a list of trade structures
See: https://docs.derive.xyz/reference/post_public-get-trade-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | the latest time in ms to fetch trades for |
derive.fetchTrades (symbol[, since, limit, params])
fetchFundingRateHistory{docsify-ignore}
fetches historical funding rate prices
Kind: instance method of derive
Returns: Array<object> - a list of funding rate structures
See: https://docs.derive.xyz/reference/post_public-get-funding-rate-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the funding rate history for |
| since | int |
No | timestamp in ms of the earliest funding rate to fetch |
| limit | int |
No | the maximum amount of funding rate structures to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.fetchFundingRateHistory (symbol[, since, limit, params])
fetchFundingRate{docsify-ignore}
fetch the current funding rate
Kind: instance method of derive
Returns: object - a funding rate structure
See: https://docs.derive.xyz/reference/post_public-get-funding-rate-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.fetchFundingRate (symbol[, params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of derive
Returns: object - an order structure
See: https://docs.derive.xyz/reference/post_private-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.subaccount_id | string |
No | required the subaccount id |
| params.triggerPrice | float |
No | The price a trigger 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 | take profit trigger price |
| 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 | stop loss trigger price |
| params.max_fee | float |
No | required the maximum fee you are willing to pay for the order |
derive.createOrder (symbol, type, side, amount[, price, params])
editOrder{docsify-ignore}
edit a trade order
Kind: instance method of derive
Returns: object - an order structure
See: https://docs.derive.xyz/reference/post_private-replace
| 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 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.subaccount_id | string |
No | required the subaccount id |
derive.editOrder (id, symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of derive
Returns: object - An order structure
See: https://docs.derive.xyz/reference/post_private-cancel
| 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 |
| params.trigger | boolean |
No | whether the order is a trigger/algo order |
| params.subaccount_id | string |
No | required the subaccount id |
derive.cancelOrder (id, symbol[, params])
cancelAllOrders{docsify-ignore}
cancel all open orders in a market
Kind: instance method of derive
Returns: object - an list of order structures
See
- https://docs.derive.xyz/reference/post_private-cancel-by-instrument
- https://docs.derive.xyz/reference/post_private-cancel-all
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.cancelAllOrders (symbol[, params])
fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of derive
Returns: Array<Order> - a list of order structures
See: https://docs.derive.xyz/reference/post_private-get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean |
No | set to true if you want to fetch orders with pagination |
| params.trigger | boolean |
No | whether the order is a trigger/algo order |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchOrders (symbol[, since, limit, params])
fetchOpenOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of derive
Returns: Array<Order> - a list of order structures
See: https://docs.derive.xyz/reference/post_private-get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean |
No | set to true if you want to fetch orders with pagination |
derive.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of derive
Returns: Array<Order> - a list of order structures
See: https://docs.derive.xyz/reference/post_private-get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean |
No | set to true if you want to fetch orders with pagination |
derive.fetchClosedOrders (symbol[, since, limit, params])
fetchCanceledOrders{docsify-ignore}
fetches information on multiple canceled orders made by the user
Kind: instance method of derive
Returns: Array<object> - a list of order structures
See: https://docs.derive.xyz/reference/post_private-get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market the orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean |
No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
derive.fetchCanceledOrders (symbol[, since, limit, params])
fetchOrderTrades{docsify-ignore}
fetch all the trades made from a single order
Kind: instance method of derive
Returns: Array<object> - a list of trade structures
See: https://docs.derive.xyz/reference/post_private-get-trade-history
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trades to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchOrderTrades (id, symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of derive
Returns: Array<Trade> - a list of trade structures
See: https://docs.derive.xyz/reference/post_private-get-trade-history
| 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 |
| params.paginate | boolean |
No | set to true if you want to fetch trades with pagination |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchMyTrades (symbol[, since, limit, params])
fetchPositions{docsify-ignore}
fetch all open positions
Kind: instance method of derive
Returns: Array<object> - a list of position structure
See: https://docs.derive.xyz/reference/post_private-get-positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
No | not used by kraken fetchPositions () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchPositions ([symbols, params])
fetchFundingHistory{docsify-ignore}
fetch the history of funding payments paid and received on this account
Kind: instance method of derive
Returns: object - a funding history structure
See: https://docs.derive.xyz/reference/post_private-get-funding-history
| 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 availble parameters |
derive.fetchFundingHistory ([symbol, 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 derive
Returns: object - a balance structure
See: https://docs.derive.xyz/reference/post_private-get-all-portfolios
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.fetchBalance ([params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of derive
Returns: Array<object> - a list of transaction structures
See: https://docs.derive.xyz/reference/post_private-get-deposit-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of deposits structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
Kind: instance method of derive
Returns: Array<object> - a list of transaction structures
See: https://docs.derive.xyz/reference/post_private-get-withdrawal-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of withdrawals structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.fetchWithdrawals (code[, since, limit, params])
watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of derive
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.derive.xyz/reference/orderbook-instrument_name-group-depth
| 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 |
derive.watchOrderBook (symbol[, limit, params])
watchTicker{docsify-ignore}
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of derive
Returns: object - a ticker structure
See: https://docs.derive.xyz/reference/ticker-instrument_name-interval
| 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 |
derive.watchTicker (symbol[, params])
unWatchOrderBook{docsify-ignore}
unsubscribe from the orderbook channel
Kind: instance method of derive
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.limit | int |
No | orderbook limit, default is undefined |
derive.unWatchOrderBook (symbol[, params])
unWatchTrades{docsify-ignore}
unsubscribe from the trades channel
Kind: instance method of derive
Returns: any - status of the unwatch request
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to unwatch the trades for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.unWatchTrades (symbol[, params])
watchTrades{docsify-ignore}
watches information on multiple trades made in a market
Kind: instance method of derive
Returns: Array<object> - a list of trade structures
See: https://docs.derive.xyz/reference/trades-instrument_name
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market trades were made in |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trade structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
derive.watchTrades (symbol[, since, limit, params])
watchOrders{docsify-ignore}
watches information on multiple orders made by the user
Kind: instance method of derive
Returns: Array<object> - a list of order structures
See: https://docs.derive.xyz/reference/subaccount_id-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.watchOrders (symbol[, since, limit, params])
watchMyTrades{docsify-ignore}
watches information on multiple trades made by the user
Kind: instance method of derive
Returns: Array<object> - a list of trade structures
See: https://docs.derive.xyz/reference/subaccount_id-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.subaccount_id | string |
No | required the subaccount id |
derive.watchMyTrades (symbol[, since, limit, params])