@lynx-crypto/kraken-api 1.0.0 → 1.1.0

package/dist/index.d.cts

@@ -70,6 +70,110 @@ interface KrakenLogger {
 }
 type KrakenWsTriggerReference = 'index' | 'last';
 type KrakenWsPriceType = 'static' | 'pct' | 'quote';
+type KrakenBulkDataset = 'trades' | 'ohlcvt';
+type KrakenBulkQuarter = `${number}Q${1 | 2 | 3 | 4}`;
+type KrakenBulkSource = {
+    type: 'complete';
+} | {
+    type: 'quarterly';
+    quarter: KrakenBulkQuarter;
+};
+interface KrakenBulkClientOptions {
+    /**
+     * Storage root for bulk data.
+     * Default: ~/.lynx-crypto/bulk
+     *
+     * If relative, resolved against process.cwd().
+     */
+    storageDir?: string;
+    userAgent?: string;
+    logger?: KrakenLogger;
+    /**
+     * Optional Google Drive API key.
+     * If omitted, bulk ZIP downloads require manual placement (no Drive downloading, no scraping).
+     */
+    googleDriveApiKey?: string;
+}
+interface KrakenBulkDownloadResult {
+    dataset: KrakenBulkDataset;
+    source: KrakenBulkSource;
+    zipPath: string;
+    bytes: number;
+    downloaded: boolean;
+    directUrl?: string;
+}
+interface KrakenBulkExtractResult {
+    dataset: KrakenBulkDataset;
+    source: KrakenBulkSource;
+    extractedDir: string;
+    filesExtracted: number;
+    extracted: boolean;
+}
+type KrakenBulkDeleteScope = 'zips' | 'extracted' | 'all';
+interface KrakenBulkDeleteParams {
+    scope: KrakenBulkDeleteScope;
+    source?: KrakenBulkSource;
+}
+interface KrakenBulkHasResult {
+    zip: boolean;
+    extracted: boolean;
+}
+interface KrakenBulkTradeRow {
+    ts: number;
+    price: string;
+    volume: string;
+}
+type KrakenBulkOhlcInterval = 1 | 5 | 15 | 30 | 60 | 240 | 720 | 1440;
+interface KrakenBulkOhlcvtRow {
+    ts: number;
+    open: string;
+    high: string;
+    low: string;
+    close: string;
+    volume: string;
+    trades: number;
+}
+interface KrakenBulkTradesQuery {
+    pair: string;
+    startTs?: number;
+    endTs?: number;
+    source?: KrakenBulkSource;
+}
+interface KrakenBulkOhlcvtQuery {
+    pair: string;
+    interval: KrakenBulkOhlcInterval;
+    startTs?: number;
+    endTs?: number;
+    source?: KrakenBulkSource;
+}
+interface KrakenBulkQueryOptions {
+    limit?: number;
+}
+type KrakenBulkDownloadProgress = {
+    downloadedBytes: number;
+    totalBytes?: number;
+};
+type KrakenBulkDownloadProgressCallback = (p: {
+    downloadedBytes: number;
+    totalBytes?: number;
+}) => void;
+interface KrakenBulkDownloadOptions {
+    onProgress?: KrakenBulkDownloadProgressCallback;
+    /**
+     * If true, re-download even if the ZIP already exists locally.
+     * Requires googleDriveApiKey (or env LYNX_CRYPTO_KRAKEN_API_GOOGLE_DRIVE_API_KEY).
+     */
+    forceRefresh?: boolean;
+}
+type KrakenBulkExtractProgressCallback = (p: {
+    extractedFiles: number;
+    totalFiles?: number;
+    currentFile?: string;
+}) => void;
+type KrakenBulkExtractOptions = {
+    onProgress?: KrakenBulkExtractProgressCallback;
+    concurrency?: number;
+};
 
 /**
  * Low-level REST base for Kraken clients.
@@ -7860,4 +7964,232 @@ declare class KrakenSpotWebsocketV2Client {
     constructor(options?: KrakenSpotWebsocketClientOptions);
 }
 
-export { type KrakenAccountBalanceMap, type KrakenAccountTransferParams, type KrakenAccountTransferResult, type KrakenAddOrderBatchOrderDescription, type KrakenAddOrderBatchOrderParams, type KrakenAddOrderBatchOrderResult, type KrakenAddOrderBatchParams, type KrakenAddOrderBatchResult, type KrakenAddOrderDescription, type KrakenAddOrderParams, type KrakenAddOrderResult, type KrakenAddOrderStpType, type KrakenAddOrderTimeInForce, type KrakenAmendOrderParams, type KrakenAmendOrderResult, type KrakenApiResponse, type KrakenAssetClass, type KrakenAssetInfo, type KrakenAssetInfoMap, type KrakenAssetPair, type KrakenAssetPairInfoType, type KrakenAssetPairMap, type KrakenAssetPairStatus, type KrakenAssetStatus, type KrakenAssetTickerInfo, type KrakenCancelAllOrdersAfterParams, type KrakenCancelAllOrdersAfterResult, type KrakenCancelAllOrdersResult, type KrakenCancelOrderBatchOrderRef, type KrakenCancelOrderBatchParams, type KrakenCancelOrderBatchResult, type KrakenCancelOrderParams, type KrakenCancelOrderResult, type KrakenClientOptions, type KrakenClosedOrder, type KrakenClosedOrdersCloseTime, type KrakenClosedOrdersMap, type KrakenClosedOrdersResult, type KrakenCreateSubaccountParams, type KrakenCreateSubaccountResult, type KrakenCreditLinesAssetEntry, type KrakenCreditLinesAssetMap, type KrakenCreditLinesLimitsMonitor, type KrakenCreditLinesResponse, type KrakenCreditLinesResult, type KrakenDeleteExportReportParams, type KrakenDeleteExportReportResult, type KrakenDeleteExportReportType, type KrakenDepositAddress, type KrakenDepositMethod, type KrakenDepositStatusEntry, type KrakenEarnAllocateFundsParams, type KrakenEarnAllocateFundsResult, type KrakenEarnAllocationItem, type KrakenEarnAllocationStatus, type KrakenEarnAmountBreakdown, type KrakenEarnDeallocateFundsParams, type KrakenEarnDeallocateFundsResult, type KrakenEarnDeallocationStatus, type KrakenEarnGetAllocationStatusParams, type KrakenEarnGetAllocationStatusResult, type KrakenEarnGetDeallocationStatusParams, type KrakenEarnGetDeallocationStatusResult, type KrakenEarnListAllocationsParams, type KrakenEarnListAllocationsResult, type KrakenEarnListAllocationsResultObject, type KrakenEarnListStrategiesParams, type KrakenEarnListStrategiesResult, type KrakenEarnListStrategiesResultObject, type KrakenEarnLockType, type KrakenEarnStrategy, type KrakenEditOrderDescription, type KrakenEditOrderParams, type KrakenEditOrderResult, type KrakenExportReportFormat, type KrakenExportReportStatus, type KrakenExportReportStatusState, type KrakenExportReportType, type KrakenExtendedBalanceEntry, type KrakenExtendedBalanceMap, type KrakenFeeScheduleEntry, type KrakenFeeTierInfo, type KrakenGetAccountBalanceParams, type KrakenGetAssetInfoParams, type KrakenGetClosedOrdersParams, type KrakenGetCreditLinesParams, type KrakenGetDepositAddressesParams, type KrakenGetDepositAddressesResult, type KrakenGetDepositMethodsParams, type KrakenGetDepositMethodsResult, type KrakenGetDepositStatusParams, type KrakenGetExportReportStatusParams, type KrakenGetExtendedBalanceParams, type KrakenGetLedgersInfoParams, type KrakenGetLedgersQueryParams, type KrakenGetOhlcDataParams, type KrakenGetOpenOrdersParams, type KrakenGetOpenPositionsParams, type KrakenGetOrderAmendsParams, type KrakenGetOrderBookParams, type KrakenGetOrdersInfoParams, type KrakenGetPostTradeDataParams, type KrakenGetPostTradeDataResult, type KrakenGetPreTradeDataParams, type KrakenGetRecentSpreadsParams, type KrakenGetRecentTradesParams, type KrakenGetTickerInformationParams, type KrakenGetTradableAssetPairsParams, type KrakenGetTradeBalanceParams, type KrakenGetTradeVolumeParams, type KrakenGetTradesHistoryParams, type KrakenGetTradesInfoParams, type KrakenGetWebSocketsTokenResult, type KrakenGetWithdrawAddressesParams, type KrakenGetWithdrawAddressesResult, type KrakenGetWithdrawInfoParams, type KrakenGetWithdrawInfoResult, type KrakenGetWithdrawMethodsParams, type KrakenGetWithdrawMethodsResult, type KrakenGetWithdrawStatusParams, type KrakenGetWithdrawStatusResult, type KrakenLedgerEntry, type KrakenLedgerEntryType, type KrakenLedgerMap, type KrakenLedgerTypeFilter, type KrakenLedgersInfoResult, type KrakenLogger, type KrakenOhlcEntry, type KrakenOhlcInterval, type KrakenOhlcMap, type KrakenOhlcResponse, type KrakenOpenOrder, type KrakenOpenOrderDescription, type KrakenOpenOrdersMap, type KrakenOpenOrdersResult, type KrakenOpenPosition, type KrakenOpenPositionsConsolidationMode, type KrakenOpenPositionsMap, type KrakenOrderAmendEntry, type KrakenOrderAmendType, type KrakenOrderAmendsResult, type KrakenOrderBook, type KrakenOrderBookLevel, type KrakenOrderBookMap, type KrakenOrderSide, type KrakenOrderStatus, type KrakenOrderTrigger, type KrakenOrderType, type KrakenPositionStatus, type KrakenPostTradeEntry, type KrakenPreTradeDataResult, type KrakenQueriedLedgersMap, type KrakenQueriedOrder, type KrakenQueriedOrdersMap, type KrakenQueriedTradesMap, type KrakenRebaseMultiplier$1 as KrakenRebaseMultiplier, type KrakenRecentSpreadsResponse, type KrakenRecentTradesResponse, type KrakenRequestExportReportParams, type KrakenRequestExportReportResult, type KrakenRetrieveExportParams, type KrakenRetrieveExportResult, type KrakenServerTime, KrakenSpotAccountDataApi, KrakenSpotEarnApi, KrakenSpotFundingApi, KrakenSpotMarketDataApi, KrakenSpotRestClient, KrakenSpotSubaccountsApi, KrakenSpotTradingApi, KrakenSpotTransparencyApi, type KrakenSpotWebsocketClientOptions, KrakenSpotWebsocketV2Client, KrakenSpotWsAdminApi, KrakenSpotWsMarketDataApi, KrakenSpotWsUserDataApi, KrakenSpotWsUserTradingApi, type KrakenSpreadEntry, type KrakenSpreadsMap, type KrakenSystemStatus, type KrakenSystemStatusResult, type KrakenTickerAssetClass, type KrakenTickerInfoMap, type KrakenTradeBalanceResult, type KrakenTradeEntry, type KrakenTradeHistoryEntry, type KrakenTradeHistoryMap, type KrakenTradeHistoryTypeFilter, type KrakenTradeVolumeFeesMap, type KrakenTradeVolumeResult, type KrakenTradesHistoryResult, type KrakenTradesMap, type KrakenWalletTransferParams, type KrakenWalletTransferResult, type KrakenWebSocketLike, type KrakenWebSocketLikeCtor, KrakenWebsocketBase, type KrakenWebsocketConnectionOptions, type KrakenWebsocketLogger, type KrakenWithdrawAddress, type KrakenWithdrawCancelParams, type KrakenWithdrawCancelResult, type KrakenWithdrawFundsParams, type KrakenWithdrawFundsResult, type KrakenWithdrawInfo, type KrakenWithdrawMethod, type KrakenWithdrawStatusEntry, type KrakenWsAddOrderConditional, type KrakenWsAddOrderOptions, type KrakenWsAddOrderParams, type KrakenWsAddOrderResponse, type KrakenWsAddOrderResult, type KrakenWsAddOrderTriggers, type KrakenWsAmendOrderOptions, type KrakenWsAmendOrderParams, type KrakenWsAmendOrderResponse, type KrakenWsAmendOrderResult, type KrakenWsBalanceEventCategory, type KrakenWsBalanceEventSubtype, type KrakenWsBalanceEventType, type KrakenWsBalanceLedgerTransaction, type KrakenWsBalanceUpdateWalletId, type KrakenWsBalanceWalletEntry, type KrakenWsBalanceWalletId, type KrakenWsBalanceWalletType, type KrakenWsBalancesMessage, type KrakenWsBalancesSnapshotAsset, type KrakenWsBalancesSnapshotMessage, type KrakenWsBalancesSubscribeOptions, type KrakenWsBalancesSubscribeParams, type KrakenWsBalancesSubscribeResponse, type KrakenWsBalancesSubscribeResult, type KrakenWsBalancesUnsubscribeOptions, type KrakenWsBalancesUnsubscribeParams, type KrakenWsBalancesUnsubscribeResponse, type KrakenWsBalancesUnsubscribeResult, type KrakenWsBalancesUpdateMessage, type KrakenWsBatchAddOptions, type KrakenWsBatchAddOrderEntry, type KrakenWsBatchAddOrderResultEntry, type KrakenWsBatchAddParams, type KrakenWsBatchAddResponse, type KrakenWsBatchCancelOptions, type KrakenWsBatchCancelParams, type KrakenWsBatchCancelResponse, type KrakenWsBatchCancelResult, type KrakenWsBookLevel, type KrakenWsBookMessage, type KrakenWsBookSnapshotMessage, type KrakenWsBookSubscribeOptions, type KrakenWsBookSubscribeParams, type KrakenWsBookSubscribeResponse, type KrakenWsBookUnsubscribeOptions, type KrakenWsBookUnsubscribeParams, type KrakenWsBookUnsubscribeResponse, type KrakenWsBookUpdateMessage, type KrakenWsCancelAllOptions, type KrakenWsCancelAllOrdersAfterOptions, type KrakenWsCancelAllOrdersAfterParams, type KrakenWsCancelAllOrdersAfterResponse, type KrakenWsCancelAllOrdersAfterResult, type KrakenWsCancelAllParams, type KrakenWsCancelAllResponse, type KrakenWsCancelAllResult, type KrakenWsCancelOrderOptions, type KrakenWsCancelOrderParams, type KrakenWsCancelOrderResponse, type KrakenWsCancelOrderResult, type KrakenWsEditOrderOptions, type KrakenWsEditOrderParams, type KrakenWsEditOrderResponse, type KrakenWsEditOrderResult, type KrakenWsExecutionContingent, type KrakenWsExecutionFeeEntry, type KrakenWsExecutionReport, type KrakenWsExecutionTimeInForce, type KrakenWsExecutionTriggers, type KrakenWsExecutionType, type KrakenWsExecutionsMessage, type KrakenWsExecutionsSubscribeOptions, type KrakenWsExecutionsSubscribeParams, type KrakenWsExecutionsSubscribeResponse, type KrakenWsExecutionsSubscribeResult, type KrakenWsExecutionsUnsubscribeOptions, type KrakenWsExecutionsUnsubscribeParams, type KrakenWsExecutionsUnsubscribeResponse, type KrakenWsExecutionsUnsubscribeResult, type KrakenWsFeePreference, type KrakenWsHeartbeatHandler, type KrakenWsHeartbeatMessage, type KrakenWsInstrumentAsset, type KrakenWsInstrumentAssetStatus, type KrakenWsInstrumentData, type KrakenWsInstrumentMessage, type KrakenWsInstrumentPair, type KrakenWsInstrumentPairStatus, type KrakenWsInstrumentSnapshotMessage, type KrakenWsInstrumentSubscribeOptions, type KrakenWsInstrumentSubscribeParams, type KrakenWsInstrumentSubscribeResponse, type KrakenWsInstrumentUnsubscribeOptions, type KrakenWsInstrumentUnsubscribeParams, type KrakenWsInstrumentUnsubscribeResponse, type KrakenWsInstrumentUpdateMessage, type KrakenWsLevel3Depth, type KrakenWsLevel3Message, type KrakenWsLevel3OrderEventType, type KrakenWsLevel3SnapshotMessage, type KrakenWsLevel3SubscribeOptions, type KrakenWsLevel3SubscribeParams, type KrakenWsLevel3SubscribeResponse, type KrakenWsLevel3UnsubscribeOptions, type KrakenWsLevel3UnsubscribeParams, type KrakenWsLevel3UnsubscribeResponse, type KrakenWsLevel3UpdateMessage, type KrakenWsLiquidityIndicator, type KrakenWsMessageHandler, type KrakenWsMethodResponseEnvelope, type KrakenWsOhlcMessage, type KrakenWsOhlcSnapshotMessage, type KrakenWsOhlcSubscribeOptions, type KrakenWsOhlcSubscribeParams, type KrakenWsOhlcSubscribeResponse, type KrakenWsOhlcUnsubscribeOptions, type KrakenWsOhlcUnsubscribeParams, type KrakenWsOhlcUnsubscribeResponse, type KrakenWsOhlcUpdateMessage, type KrakenWsOrderSide, type KrakenWsOrderStatus, type KrakenWsOrderType, type KrakenWsPingParams, type KrakenWsPingResponse, type KrakenWsPingResult, type KrakenWsPositionStatus, type KrakenWsPriceType, type KrakenWsStatusData, type KrakenWsStatusUpdateMessage, type KrakenWsStpType, type KrakenWsTickerData, type KrakenWsTickerMessage, type KrakenWsTickerSnapshotMessage, type KrakenWsTickerSubscribeOptions, type KrakenWsTickerSubscribeParams, type KrakenWsTickerSubscribeResponse, type KrakenWsTickerUnsubscribeOptions, type KrakenWsTickerUnsubscribeParams, type KrakenWsTickerUnsubscribeResponse, type KrakenWsTickerUpdateMessage, type KrakenWsTimeInForce, type KrakenWsTradeEntry, type KrakenWsTradeMessage, type KrakenWsTradeOrderType, type KrakenWsTradeSide, type KrakenWsTradeSnapshotMessage, type KrakenWsTradeSubscribeOptions, type KrakenWsTradeSubscribeParams, type KrakenWsTradeSubscribeResponse, type KrakenWsTradeUnsubscribeOptions, type KrakenWsTradeUnsubscribeParams, type KrakenWsTradeUnsubscribeResponse, type KrakenWsTradeUpdateMessage, type KrakenWsTriggerReference, type KrakenWsTriggerStatus };
+declare class KrakenBulkBase {
+    readonly logger?: KrakenLogger;
+    readonly userAgent?: string;
+    private readonly storageDir;
+    private readonly googleDriveApiKey?;
+    private driveFolderCache;
+    constructor(options?: KrakenBulkClientOptions);
+    driveApiKeyEnvVar(): string;
+    hasGoogleDriveApiKey(): boolean;
+    getStorageDir(): string;
+    sourceKey(source: KrakenBulkSource): string;
+    datasetDir(dataset: KrakenBulkDataset): string;
+    zipsDir(dataset: KrakenBulkDataset): string;
+    extractedRootDir(dataset: KrakenBulkDataset): string;
+    private zipBucket;
+    private extractBucket;
+    private zipsBucketDir;
+    private extractedBucketDir;
+    /**
+     * New location ONLY:
+     *  - .../zips/complete/complete.zip
+     *  - .../zips/quarterly/<YYYYQn>.zip
+     */
+    zipPath(dataset: KrakenBulkDataset, source: KrakenBulkSource): string;
+    /**
+     * New extracted location ONLY:
+     *  - .../extracted/complete/
+     *  - .../extracted/quarterly/<YYYYQn>/
+     */
+    extractedDir(dataset: KrakenBulkDataset, source: KrakenBulkSource): string;
+    ensureDatasetDirs(dataset: KrakenBulkDataset): Promise<void>;
+    has(dataset: KrakenBulkDataset, source: KrakenBulkSource): Promise<KrakenBulkHasResult>;
+    downloadByFileId(dataset: KrakenBulkDataset, source: KrakenBulkSource, fileId: string, originalUrl: string, opts?: KrakenBulkDownloadOptions): Promise<KrakenBulkDownloadResult>;
+    extract(dataset: KrakenBulkDataset, source: KrakenBulkSource, opts?: KrakenBulkExtractOptions): Promise<KrakenBulkExtractResult>;
+    delete(dataset: KrakenBulkDataset, params: KrakenBulkDeleteParams): Promise<void>;
+    listDriveFolder(folderId: string): Promise<Array<{
+        id: string;
+        name: string;
+    }>>;
+    safeStatSize(p: string): Promise<number>;
+    private markerOkPath;
+    private markerInProgressPath;
+    private writeMarkerInProgress;
+    private writeMarkerOk;
+    private isExtractedReady;
+    private dirHasCsv;
+}
+
+/**
+ * Kraken Bulk OHLCVT API
+ * Provides methods to download, extract, check, delete, and query OHLCVT bulk data.
+ *
+ * Supports complete and quarterly datasets.
+ * Requires Google Drive API key for downloading quarterly datasets.
+ */
+declare class KrakenBulkOhlcvtApi {
+    private readonly base;
+    constructor(base: KrakenBulkBase);
+    /**
+     * Download OHLCVT bulk data ZIP.
+     *
+     * @param source
+     * @param opts
+     * @returns { Promise<KrakenBulkDownloadResult> }
+     */
+    download(source: KrakenBulkSource, opts?: KrakenBulkDownloadOptions): Promise<KrakenBulkDownloadResult>;
+    /**
+     * Extract OHLCVT bulk data ZIP.
+     *
+     * @param source
+     * @param opts
+     * @returns { Promise<KrakenBulkExtractResult> }
+     */
+    extract(source: KrakenBulkSource, opts?: KrakenBulkExtractOptions): Promise<KrakenBulkExtractResult>;
+    /**
+     * Check if OHLCVT bulk data ZIP and extracted directory exist.
+     *
+     * @param source
+     * @returns { Promise<KrakenBulkHasResult> }
+     */
+    has(source: KrakenBulkSource): Promise<KrakenBulkHasResult>;
+    /**
+     * Delete OHLCVT bulk data ZIP and/or extracted directory.
+     *
+     * @param params
+     * @returns { Promise<void> }
+     */
+    delete(params: {
+        scope: 'zips' | 'extracted' | 'all';
+        source?: KrakenBulkSource;
+    }): Promise<void>;
+    /**
+     * Query OHLCVT data for a specific pair and interval.
+     *
+     * @param q
+     * @param opts
+     * @returns { AsyncIterable<KrakenBulkOhlcvtRow> }
+     */
+    query(q: KrakenBulkOhlcvtQuery, opts?: KrakenBulkQueryOptions): AsyncIterable<KrakenBulkOhlcvtRow>;
+    /**
+     * List available trading pairs in the extracted OHLCVT data.
+     *
+     * @param source
+     * @returns { Promise<string[]> }
+     */
+    listPairs(source?: KrakenBulkSource): Promise<string[]>;
+    /**
+     * List available intervals for a specific trading pair in the extracted OHLCVT data.
+     *
+     * @param pair
+     * @param source
+     * @returns { Promise<KrakenBulkOhlcInterval[]> }
+     */
+    listIntervals(pair: string, source?: KrakenBulkSource): Promise<KrakenBulkOhlcInterval[]>;
+    /**
+     * List available quarters for OHLCVT quarterly datasets.
+     *
+     * @returns { Promise<string[]> }
+     */
+    listAvailableQuarters(): Promise<string[]>;
+    /**
+     * Query from extracted data.
+     *
+     * @param source
+     * @param q
+     * @param opts
+     * @returns { AsyncIterable<KrakenBulkOhlcvtRow> }
+     */
+    private queryFromExtracted;
+    /**
+     * Download quarterly OHLCVT ZIP.
+     *
+     * @param quarter
+     * @param opts
+     * @returns { Promise<KrakenBulkDownloadResult> }
+     */
+    private downloadQuarter;
+}
+
+/**
+ * Kraken Bulk Trades API
+ * Provides methods to download, extract, check, delete, and query trades bulk data.
+ *
+ * Supports complete and quarterly datasets.
+ * Requires Google Drive API key for downloading quarterly datasets.
+ */
+declare class KrakenBulkTradesApi {
+    private readonly base;
+    constructor(base: KrakenBulkBase);
+    /**
+     * Download Trades bulk data ZIP.
+     *
+     * @param source
+     * @param opts
+     * @returns { Promise<KrakenBulkDownloadResult> }
+     */
+    download(source: KrakenBulkSource, opts?: KrakenBulkDownloadOptions): Promise<KrakenBulkDownloadResult>;
+    /**
+     * Extract Trades bulk data ZIP.
+     *
+     * @param source
+     * @param opts
+     * @returns { Promise<KrakenBulkExtractResult> }
+     */
+    extract(source: KrakenBulkSource, opts?: KrakenBulkExtractOptions): Promise<KrakenBulkExtractResult>;
+    /**
+     * Check if Trades bulk data ZIP and extracted directory exist.
+     *
+     * @param source
+     * @returns { Promise<KrakenBulkHasResult> }
+     */
+    has(source: KrakenBulkSource): Promise<KrakenBulkHasResult>;
+    /**
+     * Delete Trades bulk data ZIP and/or extracted directory.
+     *
+     * @param params
+     * @returns { Promise<void> }
+     */
+    delete(params: {
+        scope: 'zips' | 'extracted' | 'all';
+        source?: KrakenBulkSource;
+    }): Promise<void>;
+    /**
+     * Query Trades data for a specific pair.
+     *
+     * @param q
+     * @param opts
+     * @returns { AsyncIterable<KrakenBulkTradeRow> }
+     */
+    query(q: KrakenBulkTradesQuery, opts?: KrakenBulkQueryOptions): AsyncIterable<KrakenBulkTradeRow>;
+    /**
+     * List available trading pairs in the extracted Trades data.
+     *
+     * @param source
+     * @returns { Promise<string[]> }
+     */
+    listPairs(source?: KrakenBulkSource): Promise<string[]>;
+    /**
+     * List available quarters for Trades quarterly datasets.
+     *
+     * @returns { Promise<string[]> }
+     */
+    listAvailableQuarters(): Promise<string[]>;
+    /**
+     * Query from extracted data.
+     *
+     * Supports both common CSV layouts:
+     * - [ts, price, volume, ...]
+     * - [price, volume, ts, ...] (Kraken REST-style)
+     */
+    private queryFromExtracted;
+    /**
+     * Download quarterly Trades ZIP.
+     *
+     * @param quarter
+     * @param opts
+     * @returns { Promise<KrakenBulkDownloadResult> }
+     */
+    private downloadQuarter;
+}
+
+declare class KrakenBulkClient {
+    readonly trades: KrakenBulkTradesApi;
+    readonly ohlcvt: KrakenBulkOhlcvtApi;
+    private readonly base;
+    constructor(options?: KrakenBulkClientOptions);
+}
+
+export { type KrakenAccountBalanceMap, type KrakenAccountTransferParams, type KrakenAccountTransferResult, type KrakenAddOrderBatchOrderDescription, type KrakenAddOrderBatchOrderParams, type KrakenAddOrderBatchOrderResult, type KrakenAddOrderBatchParams, type KrakenAddOrderBatchResult, type KrakenAddOrderDescription, type KrakenAddOrderParams, type KrakenAddOrderResult, type KrakenAddOrderStpType, type KrakenAddOrderTimeInForce, type KrakenAmendOrderParams, type KrakenAmendOrderResult, type KrakenApiResponse, type KrakenAssetClass, type KrakenAssetInfo, type KrakenAssetInfoMap, type KrakenAssetPair, type KrakenAssetPairInfoType, type KrakenAssetPairMap, type KrakenAssetPairStatus, type KrakenAssetStatus, type KrakenAssetTickerInfo, KrakenBulkClient, type KrakenBulkClientOptions, type KrakenBulkDataset, type KrakenBulkDeleteParams, type KrakenBulkDeleteScope, type KrakenBulkDownloadOptions, type KrakenBulkDownloadProgress, type KrakenBulkDownloadProgressCallback, type KrakenBulkDownloadResult, type KrakenBulkExtractOptions, type KrakenBulkExtractProgressCallback, type KrakenBulkExtractResult, type KrakenBulkHasResult, type KrakenBulkOhlcInterval, type KrakenBulkOhlcvtQuery, type KrakenBulkOhlcvtRow, type KrakenBulkQuarter, type KrakenBulkQueryOptions, type KrakenBulkSource, type KrakenBulkTradeRow, type KrakenBulkTradesQuery, type KrakenCancelAllOrdersAfterParams, type KrakenCancelAllOrdersAfterResult, type KrakenCancelAllOrdersResult, type KrakenCancelOrderBatchOrderRef, type KrakenCancelOrderBatchParams, type KrakenCancelOrderBatchResult, type KrakenCancelOrderParams, type KrakenCancelOrderResult, type KrakenClientOptions, type KrakenClosedOrder, type KrakenClosedOrdersCloseTime, type KrakenClosedOrdersMap, type KrakenClosedOrdersResult, type KrakenCreateSubaccountParams, type KrakenCreateSubaccountResult, type KrakenCreditLinesAssetEntry, type KrakenCreditLinesAssetMap, type KrakenCreditLinesLimitsMonitor, type KrakenCreditLinesResponse, type KrakenCreditLinesResult, type KrakenDeleteExportReportParams, type KrakenDeleteExportReportResult, type KrakenDeleteExportReportType, type KrakenDepositAddress, type KrakenDepositMethod, type KrakenDepositStatusEntry, type KrakenEarnAllocateFundsParams, type KrakenEarnAllocateFundsResult, type KrakenEarnAllocationItem, type KrakenEarnAllocationStatus, type KrakenEarnAmountBreakdown, type KrakenEarnDeallocateFundsParams, type KrakenEarnDeallocateFundsResult, type KrakenEarnDeallocationStatus, type KrakenEarnGetAllocationStatusParams, type KrakenEarnGetAllocationStatusResult, type KrakenEarnGetDeallocationStatusParams, type KrakenEarnGetDeallocationStatusResult, type KrakenEarnListAllocationsParams, type KrakenEarnListAllocationsResult, type KrakenEarnListAllocationsResultObject, type KrakenEarnListStrategiesParams, type KrakenEarnListStrategiesResult, type KrakenEarnListStrategiesResultObject, type KrakenEarnLockType, type KrakenEarnStrategy, type KrakenEditOrderDescription, type KrakenEditOrderParams, type KrakenEditOrderResult, type KrakenExportReportFormat, type KrakenExportReportStatus, type KrakenExportReportStatusState, type KrakenExportReportType, type KrakenExtendedBalanceEntry, type KrakenExtendedBalanceMap, type KrakenFeeScheduleEntry, type KrakenFeeTierInfo, type KrakenGetAccountBalanceParams, type KrakenGetAssetInfoParams, type KrakenGetClosedOrdersParams, type KrakenGetCreditLinesParams, type KrakenGetDepositAddressesParams, type KrakenGetDepositAddressesResult, type KrakenGetDepositMethodsParams, type KrakenGetDepositMethodsResult, type KrakenGetDepositStatusParams, type KrakenGetExportReportStatusParams, type KrakenGetExtendedBalanceParams, type KrakenGetLedgersInfoParams, type KrakenGetLedgersQueryParams, type KrakenGetOhlcDataParams, type KrakenGetOpenOrdersParams, type KrakenGetOpenPositionsParams, type KrakenGetOrderAmendsParams, type KrakenGetOrderBookParams, type KrakenGetOrdersInfoParams, type KrakenGetPostTradeDataParams, type KrakenGetPostTradeDataResult, type KrakenGetPreTradeDataParams, type KrakenGetRecentSpreadsParams, type KrakenGetRecentTradesParams, type KrakenGetTickerInformationParams, type KrakenGetTradableAssetPairsParams, type KrakenGetTradeBalanceParams, type KrakenGetTradeVolumeParams, type KrakenGetTradesHistoryParams, type KrakenGetTradesInfoParams, type KrakenGetWebSocketsTokenResult, type KrakenGetWithdrawAddressesParams, type KrakenGetWithdrawAddressesResult, type KrakenGetWithdrawInfoParams, type KrakenGetWithdrawInfoResult, type KrakenGetWithdrawMethodsParams, type KrakenGetWithdrawMethodsResult, type KrakenGetWithdrawStatusParams, type KrakenGetWithdrawStatusResult, type KrakenLedgerEntry, type KrakenLedgerEntryType, type KrakenLedgerMap, type KrakenLedgerTypeFilter, type KrakenLedgersInfoResult, type KrakenLogger, type KrakenOhlcEntry, type KrakenOhlcInterval, type KrakenOhlcMap, type KrakenOhlcResponse, type KrakenOpenOrder, type KrakenOpenOrderDescription, type KrakenOpenOrdersMap, type KrakenOpenOrdersResult, type KrakenOpenPosition, type KrakenOpenPositionsConsolidationMode, type KrakenOpenPositionsMap, type KrakenOrderAmendEntry, type KrakenOrderAmendType, type KrakenOrderAmendsResult, type KrakenOrderBook, type KrakenOrderBookLevel, type KrakenOrderBookMap, type KrakenOrderSide, type KrakenOrderStatus, type KrakenOrderTrigger, type KrakenOrderType, type KrakenPositionStatus, type KrakenPostTradeEntry, type KrakenPreTradeDataResult, type KrakenQueriedLedgersMap, type KrakenQueriedOrder, type KrakenQueriedOrdersMap, type KrakenQueriedTradesMap, type KrakenRebaseMultiplier$1 as KrakenRebaseMultiplier, type KrakenRecentSpreadsResponse, type KrakenRecentTradesResponse, type KrakenRequestExportReportParams, type KrakenRequestExportReportResult, type KrakenRetrieveExportParams, type KrakenRetrieveExportResult, type KrakenServerTime, KrakenSpotAccountDataApi, KrakenSpotEarnApi, KrakenSpotFundingApi, KrakenSpotMarketDataApi, KrakenSpotRestClient, KrakenSpotSubaccountsApi, KrakenSpotTradingApi, KrakenSpotTransparencyApi, type KrakenSpotWebsocketClientOptions, KrakenSpotWebsocketV2Client, KrakenSpotWsAdminApi, KrakenSpotWsMarketDataApi, KrakenSpotWsUserDataApi, KrakenSpotWsUserTradingApi, type KrakenSpreadEntry, type KrakenSpreadsMap, type KrakenSystemStatus, type KrakenSystemStatusResult, type KrakenTickerAssetClass, type KrakenTickerInfoMap, type KrakenTradeBalanceResult, type KrakenTradeEntry, type KrakenTradeHistoryEntry, type KrakenTradeHistoryMap, type KrakenTradeHistoryTypeFilter, type KrakenTradeVolumeFeesMap, type KrakenTradeVolumeResult, type KrakenTradesHistoryResult, type KrakenTradesMap, type KrakenWalletTransferParams, type KrakenWalletTransferResult, type KrakenWebSocketLike, type KrakenWebSocketLikeCtor, KrakenWebsocketBase, type KrakenWebsocketConnectionOptions, type KrakenWebsocketLogger, type KrakenWithdrawAddress, type KrakenWithdrawCancelParams, type KrakenWithdrawCancelResult, type KrakenWithdrawFundsParams, type KrakenWithdrawFundsResult, type KrakenWithdrawInfo, type KrakenWithdrawMethod, type KrakenWithdrawStatusEntry, type KrakenWsAddOrderConditional, type KrakenWsAddOrderOptions, type KrakenWsAddOrderParams, type KrakenWsAddOrderResponse, type KrakenWsAddOrderResult, type KrakenWsAddOrderTriggers, type KrakenWsAmendOrderOptions, type KrakenWsAmendOrderParams, type KrakenWsAmendOrderResponse, type KrakenWsAmendOrderResult, type KrakenWsBalanceEventCategory, type KrakenWsBalanceEventSubtype, type KrakenWsBalanceEventType, type KrakenWsBalanceLedgerTransaction, type KrakenWsBalanceUpdateWalletId, type KrakenWsBalanceWalletEntry, type KrakenWsBalanceWalletId, type KrakenWsBalanceWalletType, type KrakenWsBalancesMessage, type KrakenWsBalancesSnapshotAsset, type KrakenWsBalancesSnapshotMessage, type KrakenWsBalancesSubscribeOptions, type KrakenWsBalancesSubscribeParams, type KrakenWsBalancesSubscribeResponse, type KrakenWsBalancesSubscribeResult, type KrakenWsBalancesUnsubscribeOptions, type KrakenWsBalancesUnsubscribeParams, type KrakenWsBalancesUnsubscribeResponse, type KrakenWsBalancesUnsubscribeResult, type KrakenWsBalancesUpdateMessage, type KrakenWsBatchAddOptions, type KrakenWsBatchAddOrderEntry, type KrakenWsBatchAddOrderResultEntry, type KrakenWsBatchAddParams, type KrakenWsBatchAddResponse, type KrakenWsBatchCancelOptions, type KrakenWsBatchCancelParams, type KrakenWsBatchCancelResponse, type KrakenWsBatchCancelResult, type KrakenWsBookLevel, type KrakenWsBookMessage, type KrakenWsBookSnapshotMessage, type KrakenWsBookSubscribeOptions, type KrakenWsBookSubscribeParams, type KrakenWsBookSubscribeResponse, type KrakenWsBookUnsubscribeOptions, type KrakenWsBookUnsubscribeParams, type KrakenWsBookUnsubscribeResponse, type KrakenWsBookUpdateMessage, type KrakenWsCancelAllOptions, type KrakenWsCancelAllOrdersAfterOptions, type KrakenWsCancelAllOrdersAfterParams, type KrakenWsCancelAllOrdersAfterResponse, type KrakenWsCancelAllOrdersAfterResult, type KrakenWsCancelAllParams, type KrakenWsCancelAllResponse, type KrakenWsCancelAllResult, type KrakenWsCancelOrderOptions, type KrakenWsCancelOrderParams, type KrakenWsCancelOrderResponse, type KrakenWsCancelOrderResult, type KrakenWsEditOrderOptions, type KrakenWsEditOrderParams, type KrakenWsEditOrderResponse, type KrakenWsEditOrderResult, type KrakenWsExecutionContingent, type KrakenWsExecutionFeeEntry, type KrakenWsExecutionReport, type KrakenWsExecutionTimeInForce, type KrakenWsExecutionTriggers, type KrakenWsExecutionType, type KrakenWsExecutionsMessage, type KrakenWsExecutionsSubscribeOptions, type KrakenWsExecutionsSubscribeParams, type KrakenWsExecutionsSubscribeResponse, type KrakenWsExecutionsSubscribeResult, type KrakenWsExecutionsUnsubscribeOptions, type KrakenWsExecutionsUnsubscribeParams, type KrakenWsExecutionsUnsubscribeResponse, type KrakenWsExecutionsUnsubscribeResult, type KrakenWsFeePreference, type KrakenWsHeartbeatHandler, type KrakenWsHeartbeatMessage, type KrakenWsInstrumentAsset, type KrakenWsInstrumentAssetStatus, type KrakenWsInstrumentData, type KrakenWsInstrumentMessage, type KrakenWsInstrumentPair, type KrakenWsInstrumentPairStatus, type KrakenWsInstrumentSnapshotMessage, type KrakenWsInstrumentSubscribeOptions, type KrakenWsInstrumentSubscribeParams, type KrakenWsInstrumentSubscribeResponse, type KrakenWsInstrumentUnsubscribeOptions, type KrakenWsInstrumentUnsubscribeParams, type KrakenWsInstrumentUnsubscribeResponse, type KrakenWsInstrumentUpdateMessage, type KrakenWsLevel3Depth, type KrakenWsLevel3Message, type KrakenWsLevel3OrderEventType, type KrakenWsLevel3SnapshotMessage, type KrakenWsLevel3SubscribeOptions, type KrakenWsLevel3SubscribeParams, type KrakenWsLevel3SubscribeResponse, type KrakenWsLevel3UnsubscribeOptions, type KrakenWsLevel3UnsubscribeParams, type KrakenWsLevel3UnsubscribeResponse, type KrakenWsLevel3UpdateMessage, type KrakenWsLiquidityIndicator, type KrakenWsMessageHandler, type KrakenWsMethodResponseEnvelope, type KrakenWsOhlcMessage, type KrakenWsOhlcSnapshotMessage, type KrakenWsOhlcSubscribeOptions, type KrakenWsOhlcSubscribeParams, type KrakenWsOhlcSubscribeResponse, type KrakenWsOhlcUnsubscribeOptions, type KrakenWsOhlcUnsubscribeParams, type KrakenWsOhlcUnsubscribeResponse, type KrakenWsOhlcUpdateMessage, type KrakenWsOrderSide, type KrakenWsOrderStatus, type KrakenWsOrderType, type KrakenWsPingParams, type KrakenWsPingResponse, type KrakenWsPingResult, type KrakenWsPositionStatus, type KrakenWsPriceType, type KrakenWsStatusData, type KrakenWsStatusUpdateMessage, type KrakenWsStpType, type KrakenWsTickerData, type KrakenWsTickerMessage, type KrakenWsTickerSnapshotMessage, type KrakenWsTickerSubscribeOptions, type KrakenWsTickerSubscribeParams, type KrakenWsTickerSubscribeResponse, type KrakenWsTickerUnsubscribeOptions, type KrakenWsTickerUnsubscribeParams, type KrakenWsTickerUnsubscribeResponse, type KrakenWsTickerUpdateMessage, type KrakenWsTimeInForce, type KrakenWsTradeEntry, type KrakenWsTradeMessage, type KrakenWsTradeOrderType, type KrakenWsTradeSide, type KrakenWsTradeSnapshotMessage, type KrakenWsTradeSubscribeOptions, type KrakenWsTradeSubscribeParams, type KrakenWsTradeSubscribeResponse, type KrakenWsTradeUnsubscribeOptions, type KrakenWsTradeUnsubscribeParams, type KrakenWsTradeUnsubscribeResponse, type KrakenWsTradeUpdateMessage, type KrakenWsTriggerReference, type KrakenWsTriggerStatus };