24 KiB
krakenfutures{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchOrderBook
- fetchTickers
- fetchOHLCV
- fetchTrades
- createOrder
- createOrders
- editOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- cancelAllOrdersAfter
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchMyTrades
- fetchBalance
- fetchFundingRates
- fetchFundingRateHistory
- fetchPositions
- fetchLeverageTiers
- transferOut
- transfer
- setLeverage
- fetchLeverages
- fetchLeverage
fetchMarkets{docsify-ignore}
Fetches the available trading markets from the exchange, Multi-collateral markets are returned as linear markets, but can be settled in multiple currencies
Kind: instance method of krakenfutures
Returns: An array of market structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-instruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | exchange specific params |
krakenfutures.fetchMarkets ([params])
fetchOrderBook{docsify-ignore}
Fetches a list of open orders in a market
Kind: instance method of krakenfutures
Returns: An order book structure
See: https://docs.kraken.com/api/docs/futures-api/trading/get-orderbook
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | Unified market symbol |
| limit | int |
No | Not used by krakenfutures |
| params | object |
No | exchange specific params |
krakenfutures.fetchOrderBook (symbol[, limit, 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 krakenfutures
Returns: object - an array of ticker structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
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 |
krakenfutures.fetchTickers (symbols[, 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 krakenfutures
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.kraken.com/api/docs/futures-api/charts/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 |
| 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 |
krakenfutures.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchTrades{docsify-ignore}
Fetch a history of filled trades that this account has made
Kind: instance method of krakenfutures
Returns: An array of trade structures
See
- https://docs.kraken.com/api/docs/futures-api/trading/get-history
- https://docs.kraken.com/api/docs/futures-api/history/get-public-execution-events
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | Unified CCXT market symbol |
| since | int |
No | Timestamp in ms of earliest trade. Not used by krakenfutures except in combination with params.until |
| limit | int |
No | Total number of trades, cannot exceed 100 |
| params | object |
No | Exchange specific params |
| params.until | int |
No | Timestamp in ms of latest trade |
| 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 |
| params.method | string |
No | The method to use to fetch trades. Can be 'historyGetMarketSymbolExecutions' or 'publicGetHistory' default is 'historyGetMarketSymbolExecutions' |
krakenfutures.fetchTrades (symbol[, since, limit, params])
createOrder{docsify-ignore}
Create an order on the exchange
Kind: instance method of krakenfutures
Returns: object - an order structure
See: https://docs.kraken.com/api/docs/futures-api/trading/send-order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| type | string |
Yes | 'limit' or 'market' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | number of contracts |
| price | float |
No | limit order price |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.reduceOnly | bool |
No | set as true if you wish the order to only reduce an existing position, any order which increases an existing position will be rejected, default is false |
| params.postOnly | bool |
No | set as true if you wish to make a postOnly order, default is false |
| params.clientOrderId | string |
No | UUID The order identity that is specified from the user, It must be globally unique |
| params.triggerPrice | float |
No | the price that a stop order is triggered at |
| params.stopLossPrice | float |
No | the price that a stop loss order is triggered at |
| params.takeProfitPrice | float |
No | the price that a take profit order is triggered at |
| params.triggerSignal | string |
No | for triggerPrice, stopLossPrice and takeProfitPrice orders, the trigger price type, 'last', 'mark' or 'index', default is 'last' |
krakenfutures.createOrder (symbol, type, side, amount[, price, params])
createOrders{docsify-ignore}
create a list of trade orders
Kind: instance method of krakenfutures
Returns: object - an order structure
See: https://docs.kraken.com/api/docs/futures-api/trading/send-batch-order
| Param | Type | Required | Description |
|---|---|---|---|
| orders | Array |
Yes | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params |
| params | object |
No | extra parameters specific to the exchange API endpoint |
krakenfutures.createOrders (orders[, params])
editOrder{docsify-ignore}
Edit an open order on the exchange
Kind: instance method of krakenfutures
Returns: An order structure
See: https://docs.kraken.com/api/docs/futures-api/trading/edit-order-spring
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | Not used by Krakenfutures |
| type | string |
Yes | Not used by Krakenfutures |
| side | string |
Yes | Not used by Krakenfutures |
| amount | float |
Yes | Order size |
| price | float |
No | Price to fill order at |
| params | object |
No | Exchange specific params |
krakenfutures.editOrder (id, symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
Cancel an open order on the exchange
Kind: instance method of krakenfutures
Returns: An order structure
See: https://docs.kraken.com/api/docs/futures-api/trading/cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | Order id |
| symbol | string |
Yes | Not used by Krakenfutures |
| params | object |
No | Exchange specific params |
krakenfutures.cancelOrder (id, symbol[, params])
cancelOrders{docsify-ignore}
cancel multiple orders
Kind: instance method of krakenfutures
Returns: object - an list of order structures
See: https://docs.kraken.com/api/docs/futures-api/trading/send-batch-order
| Param | Type | Required | Description |
|---|---|---|---|
| ids | Array<string> |
Yes | order ids |
| symbol | string |
No | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS |
| params.clientOrderIds | Array<string> |
No | max length 10 e.g. ["my_id_1","my_id_2"] |
krakenfutures.cancelOrders (ids[, symbol, params])
cancelAllOrders{docsify-ignore}
Cancels all orders on the exchange, including trigger orders
Kind: instance method of krakenfutures
Returns: Response from exchange api
See: https://docs.kraken.com/api/docs/futures-api/trading/cancel-all-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | str |
Yes | Unified market symbol |
| params | dict |
No | Exchange specific params |
krakenfutures.cancelAllOrders (symbol[, params])
cancelAllOrdersAfter{docsify-ignore}
dead man's switch, cancel all orders after the given timeout
Kind: instance method of krakenfutures
Returns: object - the api result
See: https://docs.kraken.com/api/docs/futures-api/trading/cancel-all-orders-after
| 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 |
krakenfutures.cancelAllOrdersAfter (timeout[, params])
fetchOpenOrders{docsify-ignore}
Gets all open orders, including trigger orders, for an account from the exchange api
Kind: instance method of krakenfutures
Returns: An array of order structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | Unified market symbol |
| since | int |
No | Timestamp (ms) of earliest order. (Not used by kraken api but filtered internally by CCXT) |
| limit | int |
No | How many orders to return. (Not used by kraken api but filtered internally by CCXT) |
| params | object |
No | Exchange specific parameters |
krakenfutures.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
Gets all closed orders, including trigger orders, for an account from the exchange api
Kind: instance method of krakenfutures
Returns: An array of order structures
See: https://docs.futures.kraken.com/#http-api-history-account-history-get-order-events
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | Unified market symbol |
| since | int |
No | Timestamp (ms) of earliest order. |
| limit | int |
No | How many orders to return. |
| params | object |
No | Exchange specific parameters |
krakenfutures.fetchClosedOrders (symbol[, since, limit, params])
fetchCanceledOrders{docsify-ignore}
Gets all canceled orders, including trigger orders, for an account from the exchange api
Kind: instance method of krakenfutures
Returns: An array of order structures
See: https://docs.kraken.com/api/docs/futures-api/history/get-order-events
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | Unified market symbol |
| since | int |
No | Timestamp (ms) of earliest order. |
| limit | int |
No | How many orders to return. |
| params | object |
No | Exchange specific parameters |
krakenfutures.fetchCanceledOrders (symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of krakenfutures
Returns: Array<Trade> - a list of trade structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-fills
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | not used by the api 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.until | int |
No | the latest time in ms to fetch entries for |
krakenfutures.fetchMyTrades (symbol[, since, limit, params])
fetchBalance{docsify-ignore}
Fetch the balance for a sub-account, all sub-account balances are inside 'info' in the response
Kind: instance method of krakenfutures
Returns: A balance structure
See: https://docs.kraken.com/api/docs/futures-api/trading/get-accounts
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | Exchange specific parameters |
| params.type | string |
No | The sub-account type to query the balance of, possible values include 'flex', 'cash'/'main'/'funding', or a market symbol * defaults to 'flex' * |
| params.symbol | string |
No | A unified market symbol, when assigned the balance for a trading market that matches the symbol is returned |
krakenfutures.fetchBalance ([params])
fetchFundingRates{docsify-ignore}
fetch the current funding rates for multiple markets
Kind: instance method of krakenfutures
Returns: Array<Order> - an array of funding rate structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified market symbols |
| params | object |
No | extra parameters specific to the exchange API endpoint |
krakenfutures.fetchFundingRates (symbols[, params])
fetchFundingRateHistory{docsify-ignore}
fetches historical funding rate prices
Kind: instance method of krakenfutures
Returns: Array<object> - a list of funding rate structures
See: https://docs.kraken.com/api/docs/futures-api/trading/historical-funding-rates
| 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 api endpoint |
krakenfutures.fetchFundingRateHistory (symbol[, since, limit, params])
fetchPositions{docsify-ignore}
Fetches current contract trading positions
Kind: instance method of krakenfutures
Returns: Parsed exchange response for positions
See: https://docs.kraken.com/api/docs/futures-api/trading/get-open-positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | List of unified symbols |
| params | object |
No | Not used by krakenfutures |
krakenfutures.fetchPositions (symbols[, params])
fetchLeverageTiers{docsify-ignore}
retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
Kind: instance method of krakenfutures
Returns: object - a dictionary of leverage tiers structures, indexed by market symbols
See: https://docs.kraken.com/api/docs/futures-api/trading/get-instruments
| 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 |
krakenfutures.fetchLeverageTiers (symbols[, params])
transferOut{docsify-ignore}
transfer from futures wallet to spot wallet
Kind: instance method of krakenfutures
Returns: a transfer structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | str |
Yes | Unified currency code |
| amount | float |
Yes | Size of the transfer |
| params | dict |
No | Exchange specific parameters |
krakenfutures.transferOut (code, amount[, params])
transfer{docsify-ignore}
transfers currencies between sub-accounts
Kind: instance method of krakenfutures
Returns: a transfer structure
See
- https://docs.kraken.com/api/docs/futures-api/trading/transfer
- https://docs.kraken.com/api/docs/futures-api/trading/sub-account-transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | Unified currency code |
| amount | float |
Yes | Size of the transfer |
| fromAccount | string |
Yes | 'main'/'funding'/'future', 'flex', or a unified market symbol |
| toAccount | string |
Yes | 'main'/'funding', 'flex', 'spot' or a unified market symbol |
| params | object |
No | Exchange specific parameters |
krakenfutures.transfer (code, amount, fromAccount, toAccount[, params])
setLeverage{docsify-ignore}
set the level of leverage for a market
Kind: instance method of krakenfutures
Returns: object - response from the exchange
See: https://docs.kraken.com/api/docs/futures-api/trading/set-leverage-setting
| 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 |
krakenfutures.setLeverage (leverage, symbol[, params])
fetchLeverages{docsify-ignore}
fetch the set leverage for all contract and margin markets
Kind: instance method of krakenfutures
Returns: object - a list of leverage structures
See: https://docs.kraken.com/api/docs/futures-api/trading/get-leverage-setting
| 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 |
krakenfutures.fetchLeverages ([symbols, params])
fetchLeverage{docsify-ignore}
fetch the set leverage for a market
Kind: instance method of krakenfutures
Returns: object - a leverage structure
See: https://docs.kraken.com/api/docs/futures-api/trading/get-leverage-setting
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
krakenfutures.fetchLeverage (symbol[, params])