@siebly/kraken-api 0.0.9

package/dist/mjs/types/websockets/ws-api.d.ts

@@ -0,0 +1,71 @@
+import { WS_KEY_MAP, WSOperation } from '../../lib/websocket/websocket-util.js';
+import { WSAPIAddSpotOrderParams, WSAPIAmendSpotOrderParams, WSAPIBatchAddSpotOrdersParams, WSAPIBatchCancelSpotOrdersParams, WSAPICancelAllSpotOrdersAfterParams, WSAPICancelSpotOrderParams, WSAPIEditSpotOrderParams } from '../request/wsapi.types.js';
+import { WSAPIAddSpotOrderResult, WSAPIAmendSpotOrderResult, WSAPIBatchAddSpotOrdersResult, WSAPIBatchCancelSpotOrdersResult, WSAPICancelAllSpotOrdersAfterResult, WSAPICancelAllSpotOrdersResult, WSAPICancelSpotOrderResult, WSAPIEditSpotOrderResult } from '../response/wsapi.types.js';
+export type Exact<T> = {} & {
+    [K in keyof T]: T[K];
+};
+export interface WsRequestOperation<TWSTopic extends string> {
+    id: number;
+    type: WSOperation;
+    topic: TWSTopic;
+    privateChannel: boolean;
+    response: boolean;
+}
+export interface WSAPIAuthenticationRequestFromServer {
+    timestamp: number;
+    sessionId: string;
+}
+export interface WSAPIAuthenticationConfirmedFromServer {
+    pingInterval: number;
+    sessionId: string;
+    pingTimeout: number;
+    data: 'welcome';
+}
+/**
+ * WS API commands (for sending requests via WS)
+ */
+export declare const WS_API_Operations: readonly ["add_order", "amend_order", "cancel_order", "cancel_all", "cancel_all_orders_after", "batch_add", "batch_cancel", "edit_order"];
+export type WSAPIOperation = (typeof WS_API_Operations)[number];
+export interface WSAPIRequestOperationKrakenSpot<TWSOperation extends WSAPIOperation = WSAPIOperation, TWSParams extends object = any> {
+    method: TWSOperation;
+    params?: TWSParams;
+    req_id: number;
+}
+export interface WSAPIWsKeyTopicMap {
+    [WS_KEY_MAP.spotPrivateV2]: WSAPIOperation;
+    [WS_KEY_MAP.spotBetaPrivateV2]: WSAPIOperation;
+}
+export type WSAPIWsKey = keyof WSAPIWsKeyTopicMap;
+export interface WSAPISpotResponse<TResponseData extends object = object, TWSAPIOperation = WSAPIOperation> {
+    wsKey: WSAPIWsKey;
+    error?: string;
+    method: TWSAPIOperation;
+    req_id: number;
+    success: boolean;
+    time_in: string;
+    time_out: string;
+    result: TResponseData;
+    request: any;
+}
+export interface WSAPITopicRequestParamMap {
+    [key: string]: unknown;
+    add_order: WSAPIAddSpotOrderParams;
+    amend_order: WSAPIAmendSpotOrderParams;
+    cancel_order: WSAPICancelSpotOrderParams;
+    cancel_all: never;
+    cancel_all_orders_after: WSAPICancelAllSpotOrdersAfterParams;
+    batch_add: WSAPIBatchAddSpotOrdersParams;
+    batch_cancel: WSAPIBatchCancelSpotOrdersParams;
+    edit_order: WSAPIEditSpotOrderParams;
+}
+export interface WSAPITopicResponseMap {
+    [k: string]: unknown;
+    add_order: WSAPISpotResponse<WSAPIAddSpotOrderResult, 'add_order'>;
+    amend_order: WSAPISpotResponse<WSAPIAmendSpotOrderResult, 'amend_order'>;
+    cancel_order: WSAPISpotResponse<WSAPICancelSpotOrderResult, 'cancel_order'>;
+    cancel_all: WSAPISpotResponse<WSAPICancelAllSpotOrdersResult, 'cancel_all'>;
+    cancel_all_orders_after: WSAPISpotResponse<WSAPICancelAllSpotOrdersAfterResult, 'cancel_all_orders_after'>;
+    batch_add: WSAPISpotResponse<WSAPIBatchAddSpotOrdersResult[], 'batch_add'>;
+    batch_cancel: WSAPISpotResponse<WSAPIBatchCancelSpotOrdersResult, 'batch_cancel'>;
+    edit_order: WSAPISpotResponse<WSAPIEditSpotOrderResult, 'edit_order'>;
+}

package/dist/mjs/types/websockets/ws-api.js

@@ -0,0 +1,15 @@
+import { WS_KEY_MAP } from '../../lib/websocket/websocket-util.js';
+/**
+ * WS API commands (for sending requests via WS)
+ */
+export const WS_API_Operations = [
+    'add_order',
+    'amend_order',
+    'cancel_order',
+    'cancel_all',
+    'cancel_all_orders_after',
+    'batch_add',
+    'batch_cancel',
+    'edit_order',
+];
+//# sourceMappingURL=ws-api.js.map

package/dist/mjs/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAe,MAAM,uCAAuC,CAAC;AAiDhF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW;IACX,aAAa;IACb,cAAc;IACd,YAAY;IACZ,yBAAyB;IACzB,WAAW;IACX,cAAc;IACd,YAAY;CACJ,CAAC"}

package/dist/mjs/types/websockets/ws-events.d.ts

@@ -0,0 +1,11 @@
+export interface WsDataEvent<TData = any, TWSKey = string> {
+    data: TData;
+    table: string;
+    wsKey: TWSKey;
+}
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;

package/dist/mjs/types/websockets/ws-events.js

@@ -0,0 +1,8 @@
+export function isMessageEvent(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    const message = msg;
+    return message['type'] === 'message' && typeof message['data'] === 'string';
+}
+//# sourceMappingURL=ws-events.js.map

package/dist/mjs/types/websockets/ws-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-events.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-events.ts"],"names":[],"mappings":"AAYA,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAuB,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/mjs/types/websockets/ws-general.d.ts

@@ -0,0 +1,67 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions } from '../../lib/requestUtils.js';
+/** General configuration for the WebsocketClient */
+export interface WSClientConfigurableOptions {
+    /** Your API key */
+    apiKey?: string;
+    /** Your API secret */
+    apiSecret?: string;
+    /**
+     * Set to `true` to connect to testnet (Kraken's demo environment). The live environment is used by default.
+     *
+     * Note: as of November 2025, only the derivatives environment supports testnet connections. Kraken refer to this as the "Demo" environment, but it is effectively a testnet.
+     * This is a place to test your API integration. It is not a good place to test strategy performance, as the liquidity and orderbook dynamics are very different to the live environment.
+     *
+     * Refer to the following for more information:
+     * https://github.com/tiagosiebler/awesome-crypto-examples/wiki/CEX-Testnets
+     */
+    testnet?: boolean;
+    /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
+    recvWindow?: number;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    restOptions?: RestClientOptions;
+    requestOptions?: AxiosRequestConfig;
+    wsOptions?: {
+        protocols?: string[];
+        agent?: any;
+    };
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+    /**
+     * If you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason.
+     */
+    reauthWSAPIOnReconnect?: boolean;
+}
+/**
+ * WS configuration that's always defined, regardless of user configuration
+ * (usually comes from defaults if there's no user-provided values)
+ */
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    recvWindow: number;
+    /**
+     * If true, require a "receipt" that the connection is ready for use (e.g. a specific event type)
+     */
+    requireConnectionReadyConfirmation: boolean;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    reauthWSAPIOnReconnect: boolean;
+    /**
+     * Whether to use native WebSocket ping/pong frames for heartbeats
+     */
+    useNativeHeartbeats: boolean;
+}
+export type WsMarket = 'spot' | 'futures';
+export type WsEventInternalSrc = 'event' | 'function' | 'frame';

package/dist/mjs/types/websockets/ws-general.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ws-general.js.map

package/dist/mjs/types/websockets/ws-general.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-general.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-general.ts"],"names":[],"mappings":""}

package/dist/mjs/types/websockets/ws-subscriptions.d.ts

@@ -0,0 +1,11 @@
+export declare const WS_SPOT_PUBLIC_TOPICS: readonly ["ticker", "book", "ohlc", "trade", "instrument"];
+export type WSSpotPublicTopic = (typeof WS_SPOT_PUBLIC_TOPICS)[number];
+export declare const WS_SPOT_PRIVATE_TOPICS: readonly ["executions", "balances", "level3"];
+export type WSSpotPrivateTopic = (typeof WS_SPOT_PRIVATE_TOPICS)[number];
+export type WSSpotTopic = WSSpotPublicTopic | WSSpotPrivateTopic;
+export declare const WS_DERIVATIVES_PUBLIC_TOPICS: readonly ["ticker", "ticker_lite", "book", "trade"];
+export type WSDerivativesPublicTopic = (typeof WS_DERIVATIVES_PUBLIC_TOPICS)[number];
+export declare const WS_DERIVATIVES_PRIVATE_TOPICS: readonly ["open_orders", "open_orders_verbose", "fills", "balances", "open_positions", "account_log", "notifications_auth"];
+export type WSDerivativesPrivateTopic = (typeof WS_DERIVATIVES_PRIVATE_TOPICS)[number];
+export type WSDerivativesTopic = WSDerivativesPublicTopic | WSDerivativesPrivateTopic;
+export type WSTopic = WSSpotTopic | WSDerivativesTopic;

package/dist/mjs/types/websockets/ws-subscriptions.js

@@ -0,0 +1,28 @@
+export const WS_SPOT_PUBLIC_TOPICS = [
+    'ticker',
+    'book',
+    'ohlc',
+    'trade',
+    'instrument',
+]; // Note: Admin topics (Status, Heartbeat & Ping are automatically used internally and can't be subscribed to manually).
+export const WS_SPOT_PRIVATE_TOPICS = [
+    'executions',
+    'balances',
+    'level3',
+];
+export const WS_DERIVATIVES_PUBLIC_TOPICS = [
+    'ticker',
+    'ticker_lite',
+    'book',
+    'trade',
+];
+export const WS_DERIVATIVES_PRIVATE_TOPICS = [
+    'open_orders',
+    'open_orders_verbose',
+    'fills',
+    'balances',
+    'open_positions',
+    'account_log',
+    'notifications_auth',
+];
+//# sourceMappingURL=ws-subscriptions.js.map

package/dist/mjs/types/websockets/ws-subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-subscriptions.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-subscriptions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ;IACR,MAAM;IACN,MAAM;IACN,OAAO;IACP,YAAY;CACJ,CAAC,CAAC,uHAAuH;AAInI,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,YAAY;IACZ,UAAU;IACV,QAAQ;CACA,CAAC;AAMX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,QAAQ;IACR,aAAa;IACb,MAAM;IACN,OAAO;CACC,CAAC;AAKX,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,aAAa;IACb,qBAAqB;IACrB,OAAO;IACP,UAAU;IACV,gBAAgB;IAChB,aAAa;IACb,oBAAoB;CACZ,CAAC"}