Class: DerivativesClient
REST client for Kraken Derivatives endpoints. See the Derivatives REST reference for the exchange API.
Extends
BaseRestClient
Constructors
Constructor
new DerivativesClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): DerivativesClient;Create an instance of the REST client. Pass API credentials in the object in the first parameter.
Parameters
| Parameter | Type | Description |
|---|---|---|
restClientOptions? | RestClientOptions | options to configure REST API connectivity |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
DerivativesClient
Inherited from
BaseRestClient.constructor
Methods
addAssignmentPreference()
addAssignmentPreference(params: FuturesAddAssignmentPreferenceParams): Promise<DerivativesAPISuccessResponse<FuturesAssignmentProgram>>;Add assignment preference
This endpoint adds an assignment program preference.
Parameters
| Parameter | Type |
|---|---|
params | FuturesAddAssignmentPreferenceParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesAssignmentProgram>>
batchOrderManagement()
batchOrderManagement(params: FuturesBatchOrderParams): Promise<DerivativesAPISuccessResponse<{
batchStatus: FuturesBatchOrderStatus[];
}>>;Batch order management
This endpoint allows sending limit or stop order(s) and/or cancelling open order(s) and/or editing open order(s) for a currently listed Futures contract in batch. When editing an order, if the trailingStopMaxDeviation and trailingStopDeviationUnit parameters are sent unchanged, the system will recalculate a new stop price upon successful order modification.
On an edit instruction, size follows Kraken qtyMode (default RELATIVE): it sets the open (remaining) size, not the total quantity including fills. Pass qtyMode: 'ABSOLUTE' to set the total size including past fills.
Parameters
| Parameter | Type |
|---|---|
params | FuturesBatchOrderParams |
Returns
Promise<DerivativesAPISuccessResponse<{ batchStatus: FuturesBatchOrderStatus[]; }>>
cancelAllOrders()
cancelAllOrders(params?: object): Promise<DerivativesAPISuccessResponse<{
cancelStatus: FuturesCancelAllOrdersStatus;
}>>;Cancel all orders
This endpoint allows cancelling orders which are associated with a future's contract or a margin account. If no arguments are specified all open orders will be cancelled.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<DerivativesAPISuccessResponse<{ cancelStatus: FuturesCancelAllOrdersStatus; }>>
cancelAllOrdersAfter()
cancelAllOrdersAfter(params: object): Promise<DerivativesAPISuccessResponse<{
status: FuturesDeadMansSwitchStatus;
}>>;Dead man's switch
This endpoint provides a Dead Man's Switch mechanism to protect the user from network malfunctions. The user can send a request with a timeout in seconds which will trigger a countdown timer that will cancel all user orders when timeout expires. The user has to keep sending request to push back the timeout expiration or they can deactivate the mechanism by specifying a timeout of zero (0). The recommended mechanism usage is making a call every 15 to 20 seconds and provide a timeout of 60 seconds. This allows the user to keep the orders in place on a brief network failure, while keeping them safe in case of a network breakdown.
Parameters
| Parameter | Type |
|---|---|
params | { timeout: number; } |
params.timeout | number |
Returns
Promise<DerivativesAPISuccessResponse<{ status: FuturesDeadMansSwitchStatus; }>>
cancelOrder()
cancelOrder(params: FuturesCancelOrderParams): Promise<DerivativesAPISuccessResponse<{
cancelStatus: FuturesCancelOrderStatus;
}>>;Cancel order
This endpoint allows cancelling an open order for a Futures contract.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelOrderParams |
Returns
Promise<DerivativesAPISuccessResponse<{ cancelStatus: FuturesCancelOrderStatus; }>>
cancelRFQOffer()
cancelRFQOffer(params: object): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Cancel an offer on an open RFQ.
Parameters
| Parameter | Type |
|---|---|
params | { rfqUid: string; } |
params.rfqUid | string |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
Deprecated
Deprecated SDK method. See Cancel open offer.
checkApiKeyV3()
checkApiKeyV3(): Promise<FuturesApiKeyV3Check>;Check v3 API key
Verify API key access and return the authenticated key's details.
Returns
Promise<FuturesApiKeyV3Check>
deleteAssignmentPreference()
deleteAssignmentPreference(params: object): Promise<DerivativesAPISuccessResponse<FuturesAssignmentProgram>>;Delete assignment preference
This endpoint deletes an assignment program preference.
Parameters
| Parameter | Type |
|---|---|
params | { id: number; } |
params.id | number |
Returns
Promise<DerivativesAPISuccessResponse<FuturesAssignmentProgram>>
deleteRfqAssignmentMaxLeverage()
deleteRfqAssignmentMaxLeverage(): Promise<DerivativesAPISuccessResponse<{
maxLeverage: number | null;
}>>;Clear the off-book max leverage cap
Clears the account-level off-book maximum leverage cap for the authenticated master account.
Returns
Promise<DerivativesAPISuccessResponse<{ maxLeverage: number | null; }>>
editOrder()
editOrder(params: FuturesEditOrderParams): Promise<DerivativesAPISuccessResponse<{
editStatus: FuturesEditOrderStatus;
}>>;Edit order
This endpoint allows editing an existing order for a currently listed Futures contract. When editing an order, if the trailingStopMaxDeviation and trailingStopDeviationUnit parameters are sent unchanged, the system will recalculate a new stop price upon successful order modification.
size follows Kraken qtyMode, which defaults to RELATIVE when omitted. That sets the open (remaining / unfilled) size, not the total quantity including fills. Pass qtyMode: 'ABSOLUTE' to set the total order size, including past fills, to size.
From 29 October 2026 08:00 UTC, Maker Protection holds an edit that would take liquidity. A second edit while that edit is still held returns status editAlreadyHeld (REST v4 EDIT_ALREADY_HELD). The resting order is left unchanged. Send the edit again after the held edit releases. An edit of an order whose placement is still held returns orderForEditNotFound. Wait for the placement response before editing. The same status is returned when the order is no longer resting.
Parameters
| Parameter | Type |
|---|---|
params | FuturesEditOrderParams |
Returns
Promise<DerivativesAPISuccessResponse<{ editStatus: FuturesEditOrderStatus; }>>
See
- https://docs.kraken.com/api-reference/order-management/edit-order
- https://docs.kraken.com/exchange/changelog
generateNewOrderID()
generateNewOrderID(): string;Misc Utility Methods
Returns
string
getAccountLog()
getAccountLog(params?: FuturesGetAccountLogParams): Promise<DerivativesAPISuccessResponse<FuturesAccountLog>>;Get account log
Lists account log entries, paged by timestamp or by ID. To request entries by time range, use the since and before parameters. To request entries by ID range, use the from and to parameters. Any combination of since, before, from and to can be used to restrict the requested range of entries.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetAccountLogParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesAccountLog>>
getAccountLogCsv()
getAccountLogCsv(params?: object): Promise<string>;Account log (CSV)
Lists recent account log entries in CSV format.
Parameters
| Parameter | Type |
|---|---|
params? | { conversion_details?: boolean; } |
params.conversion_details? | boolean |
Returns
Promise<string>
getAccountMarketShare()
getAccountMarketShare(): Promise<FuturesMarketShare>;SDK wrapper for GET /api/stats/v1/rebates/self-market-share. The declared result type is FuturesMarketShare.
Returns
Promise<FuturesMarketShare>
getAccounts()
getAccounts(): Promise<DerivativesAPISuccessResponse<{
accounts: FuturesAccounts;
}>>;Get wallets
This endpoint returns key information relating to all your accounts which may either be cash accounts or margin accounts. This includes digital asset balances, instrument balances, margin requirements, margin trigger estimates and auxiliary information such as available funds, PnL of open positions and portfolio value.
Returns
Promise<DerivativesAPISuccessResponse<{ accounts: FuturesAccounts; }>>
getAssignmentPreferencesHistory()
getAssignmentPreferencesHistory(): Promise<DerivativesAPISuccessResponse<{
participants: FuturesAssignmentProgramHistory[];
}>>;List assignment preferences history
This endpoint returns information on assignment program preferences change history.
Returns
Promise<DerivativesAPISuccessResponse<{ participants: FuturesAssignmentProgramHistory[]; }>>
getAssignmentPrograms()
getAssignmentPrograms(): Promise<DerivativesAPISuccessResponse<{
participants: FuturesAssignmentProgram[];
}>>;List assignment programs
This endpoint returns information on currently active assignment programs.
Returns
Promise<DerivativesAPISuccessResponse<{ participants: FuturesAssignmentProgram[]; }>>
getCandles()
getCandles(params: FuturesGetCandlesParams): Promise<FuturesCandles>;Market Candles
Candles for specified tick type, market, and resolution. List of available tick types can be fetched from the getTickTypes() endpoint. List of available markets can be fetched from the getMarketsForTickType() endpoint. List of available resolutions can be fetched from the getResolutions() endpoint.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCandlesParams |
Returns
Promise<FuturesCandles>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getExecutionEvents()
getExecutionEvents(params?: FuturesHistoryBaseParams): Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryExecutionEvent>>>;Get execution events
Lists executions/trades for authenticated account.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesHistoryBaseParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryExecutionEvent>>>
getFeeSchedules()
getFeeSchedules(): Promise<DerivativesAPISuccessResponse<{
feeSchedules: FuturesFeeSchedule[];
}>>;Retrieve deprecated Futures fee schedule data. Its values no longer reflect the fees charged on Futures trades. Use SpotClient.getTradingVolume() instead.
Returns
Promise<DerivativesAPISuccessResponse<{ feeSchedules: FuturesFeeSchedule[]; }>>
Deprecated
Effective 2026-06-22. Use SpotClient.getTradingVolume() with a Spot API key instead.
getFeeScheduleVolumes()
getFeeScheduleVolumes(): Promise<DerivativesAPISuccessResponse<{
volumesByFeeSchedule: Record<string, number>;
}>>;Retrieve deprecated Futures fee schedule volumes. These volumes and schedule associations no longer determine the fees charged on Futures trades. Use SpotClient.getTradingVolume() instead.
Returns
Promise<DerivativesAPISuccessResponse<{ volumesByFeeSchedule: Record<string, number>; }>>
Deprecated
Effective 2026-06-22. Use SpotClient.getTradingVolume() with a Spot API key instead.
getFills()
getFills(params?: object): Promise<DerivativesAPISuccessResponse<{
fills: FuturesFill[];
}>>;Get your fills
This endpoint returns information on your filled orders for all futures contracts.
Parameters
| Parameter | Type |
|---|---|
params? | { lastFillTime?: string; } |
params.lastFillTime? | string |
Returns
Promise<DerivativesAPISuccessResponse<{ fills: FuturesFill[]; }>>
getHistoricalFundingRates()
getHistoricalFundingRates(params: object): Promise<DerivativesAPISuccessResponse<{
rates: FuturesHistoricalFundingRate[];
}>>;Historical funding rates
Returns list of historical funding rates for given market.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<{ rates: FuturesHistoricalFundingRate[]; }>>
getInstruments()
getInstruments(): Promise<DerivativesAPISuccessResponse<{
instruments: FuturesInstrument[];
}>>;Get instruments
Returns specifications for all currently listed markets and indices.
Returns
Promise<DerivativesAPISuccessResponse<{ instruments: FuturesInstrument[]; }>>
getInstrumentStatus()
getInstrumentStatus(params: object): Promise<DerivativesAPISuccessResponse<FuturesInstrumentStatus>>;Get instrument status
Returns price dislocation and volatility details for given market.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<FuturesInstrumentStatus>>
getInstrumentStatusList()
getInstrumentStatusList(): Promise<DerivativesAPISuccessResponse<{
instrumentStatus: FuturesInstrumentStatus[];
}>>;Get instrument status list
Returns price dislocation and volatility details for all markets.
Returns
Promise<DerivativesAPISuccessResponse<{ instrumentStatus: FuturesInstrumentStatus[]; }>>
getLeverageSettings()
getLeverageSettings(): Promise<DerivativesAPISuccessResponse<{
leveragePreferences: FuturesLeveragePreference[];
}>>;Get leverage settings
Returns list of configured leverage preferences.
Returns
Promise<DerivativesAPISuccessResponse<{ leveragePreferences: FuturesLeveragePreference[]; }>>
getLiquidityPoolStatistic()
getLiquidityPoolStatistic(params: FuturesGetAnalyticsParams): Promise<FuturesAnalyticsResponse>;Get liquidity pool statistic
Get liquidity pool statistic including usd value.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetAnalyticsParams |
Returns
Promise<FuturesAnalyticsResponse>
getMarketAnalytics()
getMarketAnalytics(params: FuturesGetAnalyticsParams): Promise<FuturesAnalyticsResponse>;Market Analytics
Analytics data divided into time buckets.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetAnalyticsParams |
Returns
Promise<FuturesAnalyticsResponse>
getMarketsForTickType()
getMarketsForTickType(params: object): Promise<string[]>;Markets
Markets available for specified tick type. List of available tick types can be fetched from the getTickTypes() endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { tickType: FuturesTickType; } |
params.tickType | FuturesTickType |
Returns
Promise<string[]>
getNotifications()
getNotifications(): Promise<DerivativesAPISuccessResponse<{
notifications: FuturesNotification[];
}>>;Get notifications
This endpoint provides the platform's notifications.
Returns
Promise<DerivativesAPISuccessResponse<{ notifications: FuturesNotification[]; }>>
getOpenOrders()
getOpenOrders(): Promise<DerivativesAPISuccessResponse<{
openOrders: FuturesOpenOrder[];
}>>;Get open orders
This endpoint returns information on all open orders for all Futures contracts.
Returns
Promise<DerivativesAPISuccessResponse<{ openOrders: FuturesOpenOrder[]; }>>
getOpenPositions()
getOpenPositions(): Promise<DerivativesAPISuccessResponse<{
openPositions: FuturesOpenPosition[];
}>>;Get open positions
This endpoint returns the size and average entry price of all open positions in Futures contracts. This includes Futures contracts that have matured but have not yet been settled.
Returns
Promise<DerivativesAPISuccessResponse<{ openPositions: FuturesOpenPosition[]; }>>
getOpenRFQ()
getOpenRFQ(params: object): Promise<DerivativesAPISuccessResponse<{
rfq: FuturesRfq;
}>>;Retrieve an RFQ by its identifier. Kraken may return an open RFQ or a recently closed RFQ still held in its in-memory cache; closed entries can disappear after eviction or restart.
Parameters
| Parameter | Type |
|---|---|
params | { rfqUid: string; } |
params.rfqUid | string |
Returns
Promise<DerivativesAPISuccessResponse<{ rfq: FuturesRfq; }>>
Deprecated
Deprecated SDK method. See Retrieve a single RFQ.
getOpenRFQs()
getOpenRFQs(): Promise<DerivativesAPISuccessResponse<{
rfqs: FuturesRfq[];
}>>;List currently open requests for quotes (RFQs).
Returns
Promise<DerivativesAPISuccessResponse<{ rfqs: FuturesRfq[]; }>>
Deprecated
Deprecated SDK method. See List all open RFQs.
getOrderbook()
getOrderbook(params: object): Promise<DerivativesAPISuccessResponse<{
orderBook: FuturesOrderBook;
}>>;Get orderbook
This endpoint returns the entire non-cumulative order book of currently listed Futures contracts.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<{ orderBook: FuturesOrderBook; }>>
getOrderEvents()
getOrderEvents(params?: FuturesGetOrderEventsParams): Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryOrderEvent>>>;Get order events
Lists order events for authenticated account.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetOrderEventsParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryOrderEvent>>>
getOrderStatus()
getOrderStatus(params?: object): Promise<DerivativesAPISuccessResponse<{
orders: FuturesOrderStatusInfo[];
}>>;Get Specific Orders' Status
Returns information on specified orders which are open or were filled/cancelled in the last 5 seconds.
Parameters
| Parameter | Type |
|---|---|
params? | { cliOrdIds?: string[]; orderIds?: string[]; } |
params.cliOrdIds? | string[] |
params.orderIds? | string[] |
Returns
Promise<DerivativesAPISuccessResponse<{ orders: FuturesOrderStatusInfo[]; }>>
getPnlPreferences()
getPnlPreferences(): Promise<DerivativesAPISuccessResponse<{
preferences: FuturesPnlPreference[];
}>>;Get PNL currency preferences
The PNL currency preference is used to determine which currency to pay out when realizing PNL gains.
Returns
Promise<DerivativesAPISuccessResponse<{ preferences: FuturesPnlPreference[]; }>>
getPortfolioMarginParameters()
getPortfolioMarginParameters(): Promise<DerivativesAPISuccessResponse<FuturesPortfolioMarginParameters>>;Retrieve portfolio margin calculation parameters, including account-specific options limits. Kraken documents this endpoint for its pre-production environments only.
Returns
Promise<DerivativesAPISuccessResponse<FuturesPortfolioMarginParameters>>
Deprecated
Deprecated SDK method. See Portfolio margin parameters.
getPositionEvents()
getPositionEvents(params?: FuturesGetPositionEventsParams): Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesPositionUpdateEvent>>>;Get position update events
Lists position events for authenticated account.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetPositionEventsParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesPositionUpdateEvent>>>
getPositionPercentile()
getPositionPercentile(): Promise<DerivativesAPISuccessResponse<{
queue: FuturesUnwindQueuePosition[];
}>>;Get position percentile of unwind queue
This endpoint returns the percentile of the open position in case of unwinding.
Returns
Promise<DerivativesAPISuccessResponse<{ queue: FuturesUnwindQueuePosition[]; }>>
getPublicExecutionEvents()
getPublicExecutionEvents(params: FuturesMarketHistoryBaseParams): Promise<FuturesMarketHistoryResponse<FuturesPublicExecutionEvent>>;Get public execution events
Lists trades for a market.
Parameters
| Parameter | Type |
|---|---|
params | FuturesMarketHistoryBaseParams |
Returns
Promise<FuturesMarketHistoryResponse<FuturesPublicExecutionEvent>>
getPublicMarkPriceEvents()
getPublicMarkPriceEvents(params: FuturesMarketHistoryBaseParams): Promise<FuturesMarketHistoryResponse<FuturesPublicMarkPriceEvent>>;Get public mark price events
Lists price events for a market.
Parameters
| Parameter | Type |
|---|---|
params | FuturesMarketHistoryBaseParams |
Returns
Promise<FuturesMarketHistoryResponse<FuturesPublicMarkPriceEvent>>
getPublicOrderEvents()
getPublicOrderEvents(params: FuturesMarketHistoryBaseParams): Promise<FuturesMarketHistoryResponse<FuturesPublicOrderEvent>>;Get public order events
Lists order events for a market.
Parameters
| Parameter | Type |
|---|---|
params | FuturesMarketHistoryBaseParams |
Returns
Promise<FuturesMarketHistoryResponse<FuturesPublicOrderEvent>>
getResolutions()
getResolutions(params: object): Promise<FuturesResolution[]>;Resolutions
Candle resolutions available for specified tick type and market. List of available tick types can be fetched from the getTickTypes() endpoint. List of available markets can be fetched from the getMarketsForTickType() endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; tickType: FuturesTickType; } |
params.symbol | string |
params.tickType | FuturesTickType |
Returns
Promise<FuturesResolution[]>
getRfqAssignmentMaxLeverage()
getRfqAssignmentMaxLeverage(): Promise<DerivativesAPISuccessResponse<{
maxLeverage: number | null;
}>>;Get the off-book max leverage cap
Returns the account-level off-book maximum leverage cap, or null when no cap is configured.
Returns
Promise<DerivativesAPISuccessResponse<{ maxLeverage: number | null; }>>
getRFQOpenOffers()
getRFQOpenOffers(): Promise<DerivativesAPISuccessResponse<{
openOffers: FuturesOpenOffer[];
}>>;List the account's open offers on currently open RFQs.
Returns
Promise<DerivativesAPISuccessResponse<{ openOffers: FuturesOpenOffer[]; }>>
Deprecated
Deprecated SDK method. See List open offers.
getSelfTradeStrategy()
getSelfTradeStrategy(): Promise<DerivativesAPISuccessResponse<{
strategy: FuturesSelfTradeStrategy;
}>>;Get self trade strategy
Returns account-wide self-trade matching strategy.
Returns
Promise<DerivativesAPISuccessResponse<{ strategy: FuturesSelfTradeStrategy; }>>
getSubaccounts()
getSubaccounts(): Promise<DerivativesAPISuccessResponse<FuturesSubaccountsInfo>>;Get subaccounts
Return information about subaccounts, including balances and UIDs.
Returns
Promise<DerivativesAPISuccessResponse<FuturesSubaccountsInfo>>
getSubaccountTradingStatus()
getSubaccountTradingStatus(params: object): Promise<DerivativesAPISuccessResponse<{
tradingEnabled: boolean;
}>>;Check subaccount trading status
Returns trading capability info for given subaccount.
Parameters
| Parameter | Type |
|---|---|
params | { subaccountUid: string; } |
params.subaccountUid | string |
Returns
Promise<DerivativesAPISuccessResponse<{ tradingEnabled: boolean; }>>
getTicker()
getTicker(params: object): Promise<DerivativesAPISuccessResponse<{
ticker: FuturesTicker;
}>>;Get ticker by symbol
Get market data for contract or index by symbol.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<{ ticker: FuturesTicker; }>>
getTickers()
getTickers(): Promise<DerivativesAPISuccessResponse<{
tickers: FuturesTicker[];
}>>;Get tickers
This endpoint returns current market data for all currently listed Futures contracts and indices.
Returns
Promise<DerivativesAPISuccessResponse<{ tickers: FuturesTicker[]; }>>
Example
import { DerivativesClient } from '@siebly/kraken-api';
async function main() {
const client = new DerivativesClient();
const response = await client.getTickers();
console.log(response.tickers);
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});See
getTickTypes()
getTickTypes(): Promise<FuturesTickType[]>;Tick Types
Returns all available tick types to use with the getMarketsForTickType() endpoint.
Returns
Promise<FuturesTickType[]>
getTradeHistory()
getTradeHistory(params: object): Promise<DerivativesAPISuccessResponse<{
history: FuturesTradeHistoryItem[];
}>>;Get trade history
This endpoint returns the most recent 100 trades prior to the specified lastTime value up to past 7 days or recent trading engine restart (whichever is sooner). If no lastTime specified, it will return 100 most recent trades.
Parameters
| Parameter | Type |
|---|---|
params | { lastTime?: string; symbol: string; } |
params.lastTime? | string |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<{ history: FuturesTradeHistoryItem[]; }>>
getTradingInstruments()
getTradingInstruments(): Promise<DerivativesAPISuccessResponse<{
instruments: FuturesInstrument[];
}>>;Get trading instruments
Returns specifications for all currently accessible markets and indices.
Returns
Promise<DerivativesAPISuccessResponse<{ instruments: FuturesInstrument[]; }>>
getTriggerEvents()
getTriggerEvents(params?: FuturesGetTriggerEventsParams): Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryTriggerEvent>>>;Get trigger events
Lists trigger events for authenticated account.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetTriggerEventsParams |
Returns
Promise<DerivativesAPISuccessResponse<FuturesHistoryResponse<FuturesHistoryTriggerEvent>>>
hasAccessToken()
hasAccessToken(): boolean;Returns
boolean
Inherited from
BaseRestClient.hasAccessToken
setAccessToken()
setAccessToken(newAccessToken: string): void;Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
setLeverageSettings()
setLeverageSettings(params: object): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Set a contract’s leverage preference. With maxLeverage and no marginMode, Kraken selects isolated margin; omit maxLeverage for plain cross margin.
Parameters
| Parameter | Type |
|---|---|
params | { maxLeverage?: number; symbol: string; } |
params.maxLeverage? | number |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
setPnlPreference()
setPnlPreference(params: object): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Set PNL currency preference
The PNL currency preference is used to determine which currency to pay out when realizing PNL gains. Calling this API can result in the following error codes: 87 (Contract does not exist), 88 (Contract not a multi-collateral futures contract), 89 (Currency does not exist), 90 (Currency is not enabled for multi-collateral futures), 41 (Would cause liquidation).
Parameters
| Parameter | Type |
|---|---|
params | { pnlPreference: string; symbol: string; } |
params.pnlPreference | string |
params.symbol | string |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
setRfqAssignmentMaxLeverage()
setRfqAssignmentMaxLeverage(params: FuturesSetRfqAssignmentMaxLeverageParams): Promise<DerivativesAPISuccessResponse<{
maxLeverage: number | null;
}>>;Set the off-book max leverage cap
Sets the account-level off-book maximum leverage cap for the authenticated master account.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSetRfqAssignmentMaxLeverageParams |
Returns
Promise<DerivativesAPISuccessResponse<{ maxLeverage: number | null; }>>
simulateMarginRequirements()
simulateMarginRequirements(params: object): Promise<DerivativesAPISuccessResponse<FuturesPortfolioSimulation>>;Calculate margin requirements, PnL and option Greeks for a portfolio of balances and positions. Kraken documents this endpoint for its pre-production environments only.
Parameters
| Parameter | Type |
|---|---|
params | { json: any; } |
params.json | any |
Returns
Promise<DerivativesAPISuccessResponse<FuturesPortfolioSimulation>>
Deprecated
Deprecated SDK method. See Portfolio simulation.
submitOrder()
submitOrder(params: FuturesSendOrderParams): Promise<DerivativesAPISuccessResponse<{
sendStatus: FuturesSendOrderStatus;
}>>;Send order
This endpoint allows sending a limit, stop, take profit or immediate-or-cancel order for a currently listed Futures contract.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSendOrderParams |
Returns
Promise<DerivativesAPISuccessResponse<{ sendStatus: FuturesSendOrderStatus; }>>
submitRFQNewOffer()
submitRFQNewOffer(params: object): Promise<DerivativesAPISuccessResponse<{
offerUid: string;
}>>;Submit a new offer on an open RFQ.
Parameters
| Parameter | Type |
|---|---|
params | { ask?: number; bid?: number; rfqUid: string; } |
params.ask? | number |
params.bid? | number |
params.rfqUid | string |
Returns
Promise<DerivativesAPISuccessResponse<{ offerUid: string; }>>
Deprecated
Deprecated SDK method. See Place new offer.
submitSubaccountTransfer()
submitSubaccountTransfer(params: FuturesInitiateSubaccountTransferParams): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Initiate sub account transfer
This endpoint allows you to transfer funds between the current account and a sub account, between two margin accounts with the same collateral currency, or between a margin account and your cash account.
Parameters
| Parameter | Type |
|---|---|
params | FuturesInitiateSubaccountTransferParams |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
submitTransferToSpot()
submitTransferToSpot(params: FuturesSubmitToSpotParams): Promise<DerivativesAPISuccessResponse<{
uid: string;
}>>;Transfer assets from a Futures wallet to Spot through the deprecated withdrawal endpoint. Kraken will remove this endpoint on 30 November 2026. Use submitWalletTransfer() with toAccount set to spot. See the 12 November 2026 API changes.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitToSpotParams |
Returns
Promise<DerivativesAPISuccessResponse<{ uid: string; }>>
submitWalletTransfer()
submitWalletTransfer(params: FuturesInitiateWalletTransferParams): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Transfer funds between Futures wallets or between a Futures wallet and Spot. Set fromAccount or toAccount to spot for a Spot transfer; this requires withdrawal permission and an account linked to Kraken. The transfer settles before the response is returned. See the 12 November 2026 API changes.
Parameters
| Parameter | Type |
|---|---|
params | FuturesInitiateWalletTransferParams |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
updateRFQOpenOffer()
updateRFQOpenOffer(params: object): Promise<DerivativesAPISuccessResponse<Record<string, never>>>;Replace an offer on an open RFQ.
Parameters
| Parameter | Type |
|---|---|
params | { ask?: number; bid?: number; rfqUid: string; } |
params.ask? | number |
params.bid? | number |
params.rfqUid | string |
Returns
Promise<DerivativesAPISuccessResponse<Record<string, never>>>
Deprecated
Deprecated SDK method.
updateSelfTradeStrategy()
updateSelfTradeStrategy(params: FuturesUpdateSelfTradeStrategyParams): Promise<DerivativesAPISuccessResponse<{
strategy: FuturesSelfTradeStrategy;
}>>;Update self trade strategy
Updates account-wide self-trade matching behavior to given strategy.
Parameters
| Parameter | Type |
|---|---|
params | FuturesUpdateSelfTradeStrategyParams |
Returns
Promise<DerivativesAPISuccessResponse<{ strategy: FuturesSelfTradeStrategy; }>>
updateSubaccountTradingStatus()
updateSubaccountTradingStatus(params: object): Promise<DerivativesAPISuccessResponse<{
tradingEnabled: boolean;
}>>;Update subaccount trading status
Updates trading capabilities for given subaccount.
Parameters
| Parameter | Type |
|---|---|
params | { subaccountUid: string; tradingEnabled: boolean; } |
params.subaccountUid | string |
params.tradingEnabled | boolean |
Returns
Promise<DerivativesAPISuccessResponse<{ tradingEnabled: boolean; }>>