@siebly/kraken-api 0.0.9

package/dist/cjs/SpotClient.d.ts

@@ -0,0 +1,547 @@
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { RestClientType } from './lib/requestUtils.js';
+import { OauthCreateFastApiKeyParams, OauthGetAccessTokenParams, OauthUpdateFastApiKeyParams, SpotAccountTransferParams, SpotAmendOrderParams, SpotGetAssetPairsParams, SpotGetClosedOrdersParams, SpotGetDepositAddressesParams, SpotGetDepositMethodsParams, SpotGetDepositStatusParams, SpotGetLedgersInfoParams, SpotGetOHLCParams, SpotGetOpenOrdersParams, SpotGetOpenPositionsParams, SpotGetOrderBookParams, SpotGetPostTradeDataParams, SpotGetRecentSpreadsParams, SpotGetRecentTradesParams, SpotGetTradesHistoryParams, SpotGetWithdrawalAddressesParams, SpotGetWithdrawalInfoParams, SpotGetWithdrawalMethodsParams, SpotGetWithdrawalsStatusParams, SpotListEarnAllocationsParams, SpotListEarnStrategiesParams, SpotQueryLedgersParams, SpotQueryOrdersParams, SpotQueryTradesParams, SpotRequestExportReportParams, SpotSubmitOrderBatchParams, SpotSubmitOrderParams, SpotWalletTransferParams, SpotWithdrawFundsParams } from './types/request/spot.types.js';
+import { SpotAPISuccessResponse } from './types/response/shared.types.js';
+import { OauthCreateFastApiKeyResponse, OauthFastApiKey, OauthGetAccessTokenResponse, OauthGetUserInfoResponse, SpotAccountBalance, SpotAccountTransferResponse, SpotAssetInfo, SpotAssetPair, SpotAssetTickerInfo, SpotBatchOrderResult, SpotClosedOrdersResponse, SpotCreditLines, SpotDeleteExportReportResponse, SpotDepositAddress, SpotDepositMethod, SpotDepositStatusResponse, SpotEarnStrategy, SpotExportReportStatus, SpotExtendedBalance, SpotLedgersInfoResponse, SpotListEarnAllocationsResponse, SpotOHLCResponse, SpotOpenOrdersResponse, SpotOpenPositionsResponse, SpotOrderAmendsResponse, SpotOrderBookResponse, SpotPostTradeDataResponse, SpotPreTradeData, SpotQueryLedgersResponse, SpotQueryOrdersResponse, SpotQueryTradesResponse, SpotRecentSpreadsResponse, SpotRecentTradesResponse, SpotRequestExportReportResponse, SpotSubmitOrderResponse, SpotSystemStatus, SpotTradeBalance, SpotTradesHistoryResponse, SpotTradeVolume, SpotWebSocketsTokenResponse, SpotWithdrawalAddress, SpotWithdrawalInfo, SpotWithdrawalMethod, SpotWithdrawalStatus } from './types/response/spot.types.js';
+/**
+ * The SpotClient provides integration to the Kraken Spot API.
+ *
+ * Docs:
+ * - https://docs.kraken.com/api/docs/guides/spot-rest-intro/
+ * - https://docs.kraken.com/api/docs/rest-api/get-server-time
+ */
+export declare class SpotClient extends BaseRestClient {
+    getClientType(): RestClientType;
+    /**
+     *
+     * Misc Utility Methods
+     *
+     */
+    generateNewOrderID(): string;
+    /**
+     *
+     * Spot REST API - Market Data
+     *
+     */
+    /**
+     * Get Server Time
+     *
+     * Get the server's time.
+     */
+    getServerTime(): Promise<SpotAPISuccessResponse<{
+        unixtime: number;
+        rfc1123: string;
+    }>>;
+    /**
+     * Get System Status
+     *
+     * Get the current system status or trading mode.
+     */
+    getSystemStatus(): Promise<SpotAPISuccessResponse<SpotSystemStatus>>;
+    /**
+     * Get Asset Info
+     *
+     * Get information about the assets that are available for deposit, withdrawal, trading and earn.
+     */
+    getAssetInfo(params?: {
+        asset?: string;
+        aclass?: 'currency' | 'tokenized_asset';
+    }): Promise<SpotAPISuccessResponse<Record<string, SpotAssetInfo>>>;
+    /**
+     * Get Tradable Asset Pairs
+     *
+     * Get tradable asset pairs
+     */
+    getAssetPairs(params?: SpotGetAssetPairsParams): Promise<SpotAPISuccessResponse<Record<string, SpotAssetPair>>>;
+    /**
+     * Get Ticker Information
+     *
+     * Get ticker information for all or requested markets.
+     * Note: Today's prices start at midnight UTC.
+     * Leaving the pair parameter blank will return tickers for all tradeable assets on Kraken.
+     */
+    getTicker(params?: {
+        pair?: string;
+        asset_class?: 'tokenized_asset' | 'forex';
+    }): Promise<SpotAPISuccessResponse<Record<string, SpotAssetTickerInfo>>>;
+    /**
+     * Get OHLC Data
+     *
+     * Retrieve OHLC market data. The last entry in the OHLC array is for the current, not-yet-committed timeframe,
+     * and will always be present, regardless of the value of since. Returns up to 720 of the most recent entries
+     * (older data cannot be retrieved, regardless of the value of since).
+     */
+    getCandles(params: SpotGetOHLCParams): Promise<SpotAPISuccessResponse<SpotOHLCResponse>>;
+    /**
+     * Get Order Book
+     *
+     * Returns level 2 (L2) order book, which describes the individual price levels in the book with aggregated
+     * order quantities at each level.
+     */
+    getOrderBook(params: SpotGetOrderBookParams): Promise<SpotAPISuccessResponse<SpotOrderBookResponse>>;
+    /**
+     * Get Recent Trades
+     *
+     * Returns the last 1000 trades by default
+     */
+    getRecentTrades(params: SpotGetRecentTradesParams): Promise<SpotAPISuccessResponse<SpotRecentTradesResponse>>;
+    /**
+     * Get Recent Spreads
+     *
+     * Returns the last ~200 top-of-book spreads for a given pair
+     */
+    getRecentSpreads(params: SpotGetRecentSpreadsParams): Promise<SpotAPISuccessResponse<SpotRecentSpreadsResponse>>;
+    /**
+     *
+     * Spot REST API - Account Data
+     *
+     */
+    /**
+     * Get Account Balance
+     *
+     * Retrieve all cash balances, net of pending withdrawals.
+     */
+    getAccountBalance(params?: {
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotAccountBalance>>;
+    /**
+     * Get Extended Balance
+     *
+     * Retrieve all extended account balances, including credits and held amounts.
+     * Balance available for trading is calculated as: available balance = balance + credit - credit_used - hold_trade
+     */
+    getExtendedBalance(params?: {
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotExtendedBalance>>;
+    /**
+     * Get Credit Lines
+     *
+     * Retrieve all credit line details for VIPs with this functionality.
+     */
+    getCreditLines(params?: {
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotCreditLines | null>>;
+    /**
+     * Get Trade Balance
+     *
+     * Retrieve a summary of collateral balances, margin position valuations, equity and margin level.
+     */
+    getTradeBalance(params?: {
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotTradeBalance>>;
+    /**
+     * Get Open Orders
+     *
+     * Retrieve information about currently open orders.
+     */
+    getOpenOrders(params?: SpotGetOpenOrdersParams): Promise<SpotAPISuccessResponse<SpotOpenOrdersResponse>>;
+    /**
+     * Get Closed Orders
+     *
+     * Retrieve information about orders that have been closed (filled or cancelled).
+     * 50 results are returned at a time, the most recent by default.
+     */
+    getClosedOrders(params?: SpotGetClosedOrdersParams): Promise<SpotAPISuccessResponse<SpotClosedOrdersResponse>>;
+    /**
+     * Query Orders Info
+     *
+     * Retrieve information about specific orders.
+     */
+    getOrders(params: SpotQueryOrdersParams): Promise<SpotAPISuccessResponse<SpotQueryOrdersResponse>>;
+    /**
+     * Get Order Amends
+     *
+     * Retrieves an audit trail of amend transactions on the specified order.
+     * The list is ordered by ascending amend timestamp.
+     */
+    getOrderAmends(params: {
+        order_id: string;
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotOrderAmendsResponse>>;
+    /**
+     * Get Trades History
+     *
+     * Retrieve information about trades/fills. 50 results are returned at a time, the most recent by default.
+     */
+    getTradesHistory(params?: SpotGetTradesHistoryParams): Promise<SpotAPISuccessResponse<SpotTradesHistoryResponse>>;
+    /**
+     * Query Trades Info
+     *
+     * Retrieve information about specific trades/fills.
+     */
+    getTrades(params: SpotQueryTradesParams): Promise<SpotAPISuccessResponse<SpotQueryTradesResponse>>;
+    /**
+     * Get Open Positions
+     *
+     * Get information about open margin positions.
+     */
+    getOpenPositions(params?: SpotGetOpenPositionsParams): Promise<SpotAPISuccessResponse<SpotOpenPositionsResponse>>;
+    /**
+     * Get Ledgers Info
+     *
+     * Retrieve information about ledger entries. 50 results are returned at a time, the most recent by default.
+     */
+    getLedgersInfo(params?: SpotGetLedgersInfoParams): Promise<SpotAPISuccessResponse<SpotLedgersInfoResponse>>;
+    /**
+     * Query Ledgers
+     *
+     * Retrieve information about specific ledger entries.
+     */
+    getLedgers(params: SpotQueryLedgersParams): Promise<SpotAPISuccessResponse<SpotQueryLedgersResponse>>;
+    /**
+     * Get Trade Volume
+     *
+     * Returns 30 day USD trading volume and resulting fee schedule for any asset pair(s) provided.
+     */
+    getTradingVolume(params?: {
+        pair?: string;
+        rebase_multiplier?: 'rebased' | 'base';
+    }): Promise<SpotAPISuccessResponse<SpotTradeVolume>>;
+    /**
+     * Request Export Report
+     *
+     * Request export of trades or ledgers.
+     */
+    requestLedgersExport(params: SpotRequestExportReportParams): Promise<SpotAPISuccessResponse<SpotRequestExportReportResponse>>;
+    /**
+     * Get Export Report Status
+     *
+     * Get status of requested data exports.
+     */
+    getLedgersExportStatus(params: {
+        report: 'trades' | 'ledgers';
+    }): Promise<SpotAPISuccessResponse<SpotExportReportStatus[]>>;
+    /**
+     * Retrieve Data Export
+     *
+     * Retrieve a processed data export (binary zip archive).
+     */
+    getLedgersExport(params: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * Delete Export Report
+     *
+     * Delete or cancel exported trades/ledgers report.
+     */
+    deleteLedgersExport(params: {
+        id: string;
+        type: 'cancel' | 'delete';
+    }): Promise<SpotAPISuccessResponse<SpotDeleteExportReportResponse>>;
+    /**
+     *
+     * Spot REST API - Trading
+     *
+     */
+    /**
+     * Add Order
+     *
+     * Place a new order.
+     * Note: See the getAssetPairs() endpoint for details on the available trading pairs, their price and quantity precisions,
+     * order minimums, available leverage, etc.
+     */
+    submitOrder(params: SpotSubmitOrderParams): Promise<SpotAPISuccessResponse<SpotSubmitOrderResponse>>;
+    /**
+     * Amend Order
+     *
+     * Amend an existing order. The order identifiers assigned by Kraken and/or client will stay the same.
+     * Queue priority in the order book will be maintained where possible.
+     */
+    amendOrder(params: SpotAmendOrderParams): Promise<SpotAPISuccessResponse<{
+        amend_id: string;
+    }>>;
+    /**
+     * Cancel Order
+     *
+     * Cancel a particular open order (or set of open orders) by txid, userref or cl_ord_id.
+     */
+    cancelOrder(params: {
+        txid?: string | number;
+        cl_ord_id?: string;
+    }): Promise<SpotAPISuccessResponse<{
+        count: number;
+        pending?: boolean;
+    }>>;
+    /**
+     * Cancel All Orders
+     *
+     * Cancel all open orders.
+     */
+    cancelAllOrders(): Promise<SpotAPISuccessResponse<{
+        count: number;
+        pending: boolean;
+    }>>;
+    /**
+     * Cancel All Orders After X
+     *
+     * CancelAllOrdersAfter provides a "Dead Man's Switch" mechanism to protect the client from network malfunction,
+     * extreme latency or unexpected matching engine downtime. The client can send a request with a timeout (in seconds),
+     * that will start a countdown timer which will cancel all client orders when the timer expires.
+     */
+    cancelAllOrdersAfter(params: {
+        timeout: number;
+    }): Promise<SpotAPISuccessResponse<{
+        currentTime: string;
+        triggerTime: string;
+    }>>;
+    /**
+     * Get Websockets Token
+     *
+     * An authentication token must be requested via this REST API endpoint in order to connect to and authenticate
+     * with the Websockets API. The token should be used within 15 minutes of creation.
+     */
+    getWebSocketsToken(): Promise<SpotAPISuccessResponse<SpotWebSocketsTokenResponse>>;
+    /**
+     * Add Order Batch
+     *
+     * Sends a collection of orders (minimum of 2 and maximum 15). All orders in batch are limited to a single pair.
+     * Validation is performed on the whole batch prior to submission. If an order fails validation, the whole batch will be rejected.
+     */
+    submitBatchOrders(params: SpotSubmitOrderBatchParams): Promise<SpotAPISuccessResponse<{
+        orders: SpotBatchOrderResult[];
+    }>>;
+    /**
+     * Cancel Order Batch
+     *
+     * Cancel multiple open orders by txid, userref or cl_ord_id (maximum 50 total unique IDs/references).
+     */
+    cancelBatchOrders(params: {
+        orders?: Array<string | number>;
+        cl_ord_ids?: string[];
+    }): Promise<SpotAPISuccessResponse<{
+        count: number;
+    }>>;
+    /**
+     *
+     * Spot REST API - Funding
+     *
+     */
+    /**
+     * Get Deposit Methods
+     *
+     * Retrieve methods available for depositing a particular asset.
+     */
+    getDepositMethods(params: SpotGetDepositMethodsParams): Promise<SpotAPISuccessResponse<SpotDepositMethod[]>>;
+    /**
+     * Get Deposit Addresses
+     *
+     * Retrieve (or generate a new) deposit addresses for a particular asset and method.
+     */
+    getDepositAddresses(params: SpotGetDepositAddressesParams): Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>;
+    /**
+     * Get Status of Recent Deposits
+     *
+     * Retrieve information about recent deposits. Results are sorted by recency.
+     */
+    getDepositsStatus(params?: SpotGetDepositStatusParams): Promise<SpotAPISuccessResponse<SpotDepositStatusResponse>>;
+    /**
+     * Get Withdrawal Methods
+     *
+     * Retrieve a list of withdrawal methods available for the user.
+     */
+    getWithdrawalMethods(params?: SpotGetWithdrawalMethodsParams): Promise<SpotAPISuccessResponse<SpotWithdrawalMethod[]>>;
+    /**
+     * Get Withdrawal Addresses
+     *
+     * Retrieve a list of withdrawal addresses available for the user.
+     */
+    getWithdrawalAddresses(params?: SpotGetWithdrawalAddressesParams): Promise<SpotAPISuccessResponse<SpotWithdrawalAddress[]>>;
+    /**
+     * Get Withdrawal Information
+     *
+     * Retrieve fee information about potential withdrawals for a particular asset, key and amount.
+     */
+    getWithdrawalInfo(params: SpotGetWithdrawalInfoParams): Promise<SpotAPISuccessResponse<SpotWithdrawalInfo>>;
+    /**
+     * Withdraw Funds
+     *
+     * Make a withdrawal request.
+     */
+    submitWithdrawal(params: SpotWithdrawFundsParams): Promise<SpotAPISuccessResponse<{
+        refid: string;
+    }>>;
+    /**
+     * Get Status of Recent Withdrawals
+     *
+     * Retrieve information about recent withdrawals. Results are sorted by recency.
+     */
+    getWithdrawalsStatus(params?: SpotGetWithdrawalsStatusParams): Promise<SpotAPISuccessResponse<SpotWithdrawalStatus[]>>;
+    /**
+     * Request Withdrawal Cancellation
+     *
+     * Cancel a recently requested withdrawal, if it has not already been successfully processed.
+     */
+    cancelWithdrawal(params: {
+        asset: string;
+        refid: string;
+    }): Promise<SpotAPISuccessResponse<boolean>>;
+    /**
+     * Request Wallet Transfer
+     *
+     * Transfer from a Kraken spot wallet to a Kraken Futures wallet.
+     * Note: Transfer in the other direction must be requested via the Kraken Futures API.
+     */
+    submitTransferToFutures(params: SpotWalletTransferParams): Promise<SpotAPISuccessResponse<{
+        refid: string;
+    }>>;
+    /**
+     *
+     * Subaccounts
+     *
+     */
+    /**
+     * Create Subaccount
+     *
+     * Create a trading subaccount.
+     * Note: CreateSubaccount must be called using an API key from the master account.
+     */
+    createSubaccount(params: {
+        username: string;
+        email: string;
+    }): Promise<SpotAPISuccessResponse<boolean>>;
+    /**
+     * Account Transfer
+     *
+     * Transfer funds to and from master and subaccounts.
+     * Note: AccountTransfer must be called using an API key from the master account.
+     */
+    submitSubaccountTransfer(params: SpotAccountTransferParams): Promise<SpotAPISuccessResponse<SpotAccountTransferResponse>>;
+    /**
+     *
+     * Earn
+     *
+     */
+    /**
+     * Allocate Earn Funds
+     *
+     * Allocate funds to the Strategy.
+     * This method is asynchronous. Use getAllocationStatus() to poll the result.
+     */
+    allocateEarnFunds(params: {
+        amount: string;
+        strategy_id: string;
+    }): Promise<SpotAPISuccessResponse<boolean>>;
+    /**
+     * Deallocate Earn Funds
+     *
+     * Deallocate funds from a strategy.
+     * This method is asynchronous. Use getDeallocationStatus() to poll the result.
+     */
+    deallocateEarnFunds(params: {
+        amount: string;
+        strategy_id: string;
+    }): Promise<SpotAPISuccessResponse<boolean>>;
+    /**
+     * Get Allocation Status
+     *
+     * Get the status of the last allocation request.
+     */
+    getEarnAllocationStatus(params: {
+        strategy_id: string;
+    }): Promise<SpotAPISuccessResponse<{
+        pending: boolean;
+    }>>;
+    /**
+     * Get Deallocation Status
+     *
+     * Get the status of the last deallocation request.
+     */
+    getEarnDeallocationStatus(params: {
+        strategy_id: string;
+    }): Promise<SpotAPISuccessResponse<{
+        pending: boolean;
+    }>>;
+    /**
+     * List Earn Strategies
+     *
+     * List earn strategies along with their parameters.
+     * Returns only strategies that are available to the user based on geographic region.
+     */
+    getEarnStrategies(params?: SpotListEarnStrategiesParams): Promise<SpotAPISuccessResponse<{
+        items: SpotEarnStrategy[];
+        next_cursor?: string;
+    }>>;
+    /**
+     * List Earn Allocations
+     *
+     * List all allocations for the user.
+     * By default all allocations are returned, even for strategies that have been used in the past and have zero balance now.
+     */
+    getEarnAllocations(params?: SpotListEarnAllocationsParams): Promise<SpotAPISuccessResponse<SpotListEarnAllocationsResponse>>;
+    /**
+     *
+     * Transparency
+     *
+     */
+    /**
+     * Pre-Trade Data
+     *
+     * Returns the price levels in the order book with aggregated order quantities at each price level.
+     * The top 10 levels are returned for each trading pair.
+     */
+    getPreTradeData(params: {
+        symbol: string;
+    }): Promise<SpotAPISuccessResponse<SpotPreTradeData>>;
+    /**
+     * Post-Trade Data
+     *
+     * Returns a list of trades on the spot exchange.
+     * If no filter parameters are specified, the last 1000 trades for all pairs are received.
+     */
+    getPostTradeData(params?: SpotGetPostTradeDataParams): Promise<SpotAPISuccessResponse<SpotPostTradeDataResponse>>;
+    /**
+     *
+     * Spot REST API - OAuth
+     *
+     */
+    /**
+     * Get Access Token
+     *
+     * Retrieve the access token.
+     * Note: This endpoint uses Basic authentication (Authorization header with base64-encoded client credentials).
+     */
+    getOAuthAccessToken(params: OauthGetAccessTokenParams): Promise<OauthGetAccessTokenResponse>;
+    /**
+     * Get User Info
+     *
+     * Returns the email address and IIBAN of the user.
+     * Note: Requires OAuth2 Bearer token. Scopes required: account.info:basic
+     */
+    getOAuthUserInfo(): Promise<OauthGetUserInfoResponse>;
+    /**
+     * Create Fast API Key
+     *
+     * Creates a Fast API key.
+     * Note: Requires OAuth2 Bearer token. Scopes required: account.fast-api-key:write
+     */
+    createOAuthFastApiKey(params: OauthCreateFastApiKeyParams): Promise<OauthCreateFastApiKeyResponse>;
+    /**
+     * Delete Fast API Key
+     *
+     * Deletes a Fast API key.
+     * Note: Requires OAuth2 Bearer token. Scopes required: account.fast-api-key:write
+     */
+    deleteOAuthFastApiKey(params: {
+        api_key_name: string;
+    }): Promise<{
+        result: boolean;
+    }>;
+    /**
+     * Update Fast API Key
+     *
+     * Updates a Fast API key.
+     * Note: Requires OAuth2 Bearer token. Scopes required: account.fast-api-key:write
+     */
+    updateOAuthFastApiKey(params: OauthUpdateFastApiKeyParams): Promise<{
+        result: boolean;
+    }>;
+    /**
+     * List Fast API Keys
+     *
+     * List all Fast API keys.
+     * Note: Requires OAuth2 Bearer token. Scopes required: account.fast-api-key:read
+     */
+    listOAuthFastApiKeys(): Promise<{
+        result: OauthFastApiKey[];
+    }>;
+}