@siebly/kraken-api 0.0.9

package/dist/cjs/types/response/shared.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.types.js.map

package/dist/cjs/types/response/shared.types.js.map

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

package/dist/cjs/types/response/spot.types.d.ts

@@ -0,0 +1,590 @@
+/**
+ * Market Data
+ */
+export interface SpotSystemStatus {
+    status: 'online' | 'maintenance' | 'cancel_only' | 'post_only';
+    timestamp: string;
+}
+export interface SpotAssetInfo {
+    aclass: string;
+    altname: string;
+    decimals: number;
+    display_decimals: number;
+    collateral_value?: number;
+    status?: string;
+}
+export interface SpotAssetPair {
+    altname: string;
+    wsname?: string;
+    aclass_base: string;
+    base: string;
+    aclass_quote: string;
+    quote: string;
+    lot?: string;
+    pair_decimals: number;
+    cost_decimals: number;
+    lot_decimals: number;
+    lot_multiplier: number;
+    leverage_buy?: number[];
+    leverage_sell?: number[];
+    fees?: number[][];
+    fees_maker?: number[][];
+    fee_volume_currency?: string;
+    margin_call?: number;
+    margin_stop?: number;
+    ordermin: string;
+    costmin?: string;
+    tick_size?: string;
+    status?: string;
+    long_position_limit?: number;
+    short_position_limit?: number;
+}
+export interface SpotAssetTickerInfo {
+    a: string[];
+    b: string[];
+    c: string[];
+    v: string[];
+    p: string[];
+    t: number[];
+    l: string[];
+    h: string[];
+    o: string;
+}
+export type SpotOHLCData = [
+    number,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    number
+];
+export interface SpotOHLCResponse {
+    last: number;
+    [pairName: string]: SpotOHLCData[] | number;
+}
+export type SpotOrderBookEntry = [string, string, number];
+export interface SpotOrderBook {
+    asks: SpotOrderBookEntry[];
+    bids: SpotOrderBookEntry[];
+}
+export interface SpotOrderBookResponse {
+    [pairName: string]: SpotOrderBook;
+}
+export type SpotTradeData = [
+    string,
+    string,
+    number,
+    string,
+    string,
+    string,
+    number
+];
+export interface SpotRecentTradesResponse {
+    last: string;
+    [pairName: string]: SpotTradeData[] | string;
+}
+export type SpotSpreadData = [number, string, string];
+export interface SpotRecentSpreadsResponse {
+    last: number;
+    [pairName: string]: SpotSpreadData[] | number;
+}
+/**
+ * Account Data
+ */
+export interface SpotAccountBalance {
+    [assetName: string]: string;
+}
+export interface SpotExtendedBalanceAsset {
+    balance: string;
+    credit: string;
+    credit_used: string;
+    hold_trade: string;
+}
+export interface SpotExtendedBalance {
+    [assetName: string]: SpotExtendedBalanceAsset;
+}
+export interface SpotCreditLinesAsset {
+    balance: string;
+    credit_limit: string;
+    credit_used: string;
+    available_credit: string;
+}
+export interface SpotCreditLinesMonitor {
+    total_credit_usd: string | null;
+    total_credit_used_usd: string | null;
+    total_collateral_value_usd: string | null;
+    equity_usd: string | null;
+    ongoing_balance: string | null;
+    debt_to_equity: string | null;
+}
+export interface SpotCreditLines {
+    asset_details: {
+        [assetName: string]: SpotCreditLinesAsset;
+    };
+    limits_monitor: SpotCreditLinesMonitor;
+}
+export interface SpotTradeBalance {
+    eb: string;
+    tb: string;
+    m: string;
+    n: string;
+    c: string;
+    v: string;
+    e: string;
+    mf: string;
+    ml: string;
+    uv: string;
+}
+export interface SpotOpenOrderDescription {
+    pair: string;
+    type: 'buy' | 'sell';
+    ordertype: 'market' | 'limit' | 'iceberg' | 'stop-loss' | 'take-profit' | 'stop-loss-limit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
+    price: string;
+    price2: string;
+    leverage: string;
+    order: string;
+    close: string;
+}
+export interface SpotOpenOrder {
+    refid: string | null;
+    userref: number | null;
+    cl_ord_id: string | null;
+    status: 'pending' | 'open' | 'closed' | 'canceled' | 'expired';
+    opentm: number;
+    starttm: number;
+    expiretm: number;
+    descr: SpotOpenOrderDescription;
+    vol: string;
+    vol_exec: string;
+    cost: string;
+    fee: string;
+    price: string;
+    stopprice: string;
+    limitprice: string;
+    trigger?: 'last' | 'index';
+    margin?: boolean;
+    misc: string;
+    stopped?: string;
+    touched?: string;
+    liquidated?: string;
+    partial?: string;
+    amended?: string;
+    sender_sub_id: string | null;
+    oflags: string;
+    trades?: string[];
+}
+export interface SpotOpenOrdersResponse {
+    open: {
+        [orderId: string]: SpotOpenOrder;
+    };
+}
+export interface SpotClosedOrder extends SpotOpenOrder {
+    closetm: number;
+    reason: string;
+}
+export interface SpotClosedOrdersResponse {
+    closed: {
+        [orderId: string]: SpotClosedOrder;
+    };
+    count?: number;
+}
+export interface SpotQueryOrdersResponse {
+    [orderId: string]: SpotOpenOrder | SpotClosedOrder;
+}
+export interface SpotOrderAmend {
+    amend_id: string;
+    amend_type: 'original' | 'user' | 'restated';
+    order_qty: string;
+    display_qty: string;
+    remaining_qty: string;
+    limit_price: string;
+    trigger_price: string;
+    reason: string;
+    post_only: boolean;
+    timestamp: number;
+}
+export interface SpotOrderAmendsResponse {
+    count: number;
+    amends: SpotOrderAmend[];
+}
+export interface SpotTrade {
+    ordertxid: string;
+    postxid: string;
+    pair: string;
+    time: number;
+    type: string;
+    ordertype: string;
+    price: string;
+    cost: string;
+    fee: string;
+    vol: string;
+    margin: string;
+    leverage: string;
+    misc: string;
+    ledgers?: string[];
+    trade_id: number;
+    maker: boolean;
+    posstatus?: string;
+    cprice?: number;
+    ccost?: number;
+    cfee?: number;
+    cvol?: number;
+    cmargin?: number;
+    net?: number;
+    trades?: string[];
+}
+export interface SpotTradesHistoryResponse {
+    count: number;
+    trades: {
+        [tradeId: string]: SpotTrade;
+    };
+}
+export interface SpotQueryTradesResponse {
+    [tradeId: string]: SpotTrade;
+}
+export interface SpotOpenPosition {
+    ordertxid: string;
+    posstatus: 'open';
+    pair: string;
+    time: number;
+    type: string;
+    ordertype: string;
+    cost: string;
+    fee: string;
+    vol: string;
+    vol_closed: string;
+    margin: string;
+    value?: string;
+    net?: string;
+    terms: string;
+    rollovertm: string;
+    misc: string;
+    oflags: string;
+}
+export interface SpotOpenPositionsResponse {
+    [positionId: string]: SpotOpenPosition;
+}
+export interface SpotLedgerEntry {
+    refid: string;
+    time: number;
+    type: 'none' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'spend' | 'receive' | 'settled' | 'credit' | 'staking' | 'reward' | 'dividend' | 'sale' | 'conversion' | 'nfttrade' | 'nftcreatorfee' | 'nftrebate' | 'custodytransfer';
+    subtype: string;
+    aclass: string;
+    asset: string;
+    amount: string;
+    fee: string;
+    balance: string;
+}
+export interface SpotLedgersInfoResponse {
+    ledger: {
+        [ledgerId: string]: SpotLedgerEntry;
+    };
+    count?: number;
+}
+export interface SpotQueryLedgersResponse {
+    [ledgerId: string]: SpotLedgerEntry;
+}
+export interface SpotFeeTierInfo {
+    fee: string;
+    min_fee: string;
+    max_fee: string;
+    next_fee: string | null;
+    tier_volume: string | null;
+    next_volume: string | null;
+}
+export interface SpotTradeVolume {
+    currency: string;
+    volume: string;
+    fees?: {
+        [pairName: string]: SpotFeeTierInfo;
+    };
+    fees_maker?: {
+        [pairName: string]: SpotFeeTierInfo;
+    };
+}
+export interface SpotRequestExportReportResponse {
+    id: string;
+}
+export interface SpotExportReportStatus {
+    id: string;
+    descr: string;
+    format: string;
+    report: string;
+    subtype: string;
+    status: 'Queued' | 'Processing' | 'Processed';
+    flags: string;
+    fields: string;
+    createdtm: string;
+    expiretm: string;
+    starttm: string;
+    completedtm: string;
+    datastarttm: string;
+    dataendtm: string;
+    aclass: string;
+    asset: string;
+}
+export interface SpotDeleteExportReportResponse {
+    delete?: boolean;
+    cancel?: boolean;
+}
+/**
+ * Trading
+ */
+export interface SpotAddOrderDescription {
+    order: string;
+    close?: string;
+}
+export interface SpotSubmitOrderResponse {
+    descr: SpotAddOrderDescription;
+    txid: string[];
+}
+export interface SpotWebSocketsTokenResponse {
+    token: string;
+    expires: number;
+}
+export interface SpotBatchOrderResult {
+    descr?: {
+        order: string;
+    };
+    error?: string;
+    txid?: string;
+}
+/**
+ * Funding
+ */
+export interface SpotDepositMethod {
+    method: string;
+    limit: string | boolean;
+    fee: string;
+    'address-setup-fee': string;
+    'gen-address': boolean;
+    minimum: string;
+}
+export interface SpotDepositAddress {
+    address: string;
+    expiretm: string;
+    new: boolean;
+    tag?: string;
+}
+export interface SpotDepositStatus {
+    method: string;
+    aclass: string;
+    asset: string;
+    refid: string;
+    txid: string;
+    info: string;
+    amount: string;
+    fee: string;
+    time: number;
+    status: string;
+    'status-prop'?: 'return' | 'onhold';
+    originators?: string[];
+}
+export interface SpotDepositStatusResponse {
+    cursor?: string;
+    [key: string]: SpotDepositStatus[] | string | undefined;
+}
+export interface SpotWithdrawalMethod {
+    asset: string;
+    method: string;
+    network: string;
+    minimum: string;
+}
+export interface SpotWithdrawalAddress {
+    address: string;
+    asset: string;
+    method: string;
+    key: string;
+    tag?: string;
+    verified: boolean;
+}
+export interface SpotWithdrawalInfo {
+    method: string;
+    limit: string;
+    amount: string;
+    fee: string;
+}
+export interface SpotWithdrawalStatus {
+    method: string;
+    network: string;
+    aclass: string;
+    asset: string;
+    refid: string;
+    txid: string;
+    info: string;
+    amount: string;
+    fee: string;
+    time: number;
+    status: 'Initial' | 'Pending' | 'Settled' | 'Success' | 'Failure';
+    'status-prop'?: 'cancel-pending' | 'canceled' | 'cancel-denied' | 'return' | 'onhold';
+    key: string;
+}
+/**
+ * Subaccounts
+ */
+export interface SpotAccountTransferResponse {
+    transfer_id: string;
+    status: string;
+}
+/**
+ * Earn
+ */
+export interface SpotEarnAmount {
+    native: string;
+    converted: string;
+}
+export interface SpotEarnAllocationDetails {
+    native: string;
+    converted: string;
+    created_at: string;
+    expires: string;
+}
+export interface SpotEarnAllocationState {
+    allocation_count: number;
+    allocations: SpotEarnAllocationDetails[];
+    native: string;
+    converted: string;
+}
+export interface SpotEarnPayout {
+    accumulated_reward: SpotEarnAmount;
+    estimated_reward: SpotEarnAmount;
+    period_start: string;
+    period_end: string;
+}
+export interface SpotEarnAllocation {
+    strategy_id: string;
+    native_asset: string;
+    amount_allocated: {
+        total: SpotEarnAmount;
+        bonding?: SpotEarnAllocationState;
+        exit_queue?: SpotEarnAllocationState;
+        unbonding?: SpotEarnAllocationState;
+        pending?: SpotEarnAmount;
+    };
+    total_rewarded: SpotEarnAmount;
+    payout?: SpotEarnPayout;
+}
+export interface SpotListEarnAllocationsResponse {
+    converted_asset: string;
+    total_allocated: string;
+    total_rewarded: string;
+    items: SpotEarnAllocation[];
+}
+export interface SpotEarnAPREstimate {
+    low: string;
+    high: string;
+}
+export interface SpotEarnAutoCompound {
+    type: 'disabled' | string;
+    default?: boolean;
+}
+export interface SpotEarnLockType {
+    type: 'flex' | 'bonded' | 'timed' | 'instant';
+    payout_frequency?: number;
+    bonding_period?: number;
+    bonding_period_variable?: boolean;
+    bonding_rewards?: boolean;
+    unbonding_period?: number;
+    unbonding_period_variable?: boolean;
+    unbonding_rewards?: boolean;
+    exit_queue_period?: number;
+}
+export interface SpotEarnYieldSource {
+    type: 'staking' | 'off_chain' | string;
+}
+export interface SpotEarnStrategy {
+    id: string;
+    asset: string;
+    lock_type: SpotEarnLockType;
+    apr_estimate?: SpotEarnAPREstimate;
+    user_min_allocation?: string;
+    allocation_fee: string | number;
+    deallocation_fee: string | number;
+    auto_compound: SpotEarnAutoCompound;
+    yield_source: SpotEarnYieldSource;
+    can_allocate: boolean;
+    can_deallocate: boolean;
+    allocation_restriction_info: string[];
+    user_cap?: string;
+}
+/**
+ * Transparency
+ */
+export interface SpotPreTradeLevel {
+    side: 'BUY' | 'SELL';
+    price: string;
+    qty: string;
+    count: number;
+    publication_ts: string;
+}
+export interface SpotPreTradeData {
+    symbol: string;
+    description: string;
+    base_asset: string;
+    base_notation: 'NOML';
+    quote_asset: string;
+    quote_notation: 'MONE';
+    venue: string;
+    system: 'CLOB';
+    bids: SpotPreTradeLevel[];
+    asks: SpotPreTradeLevel[];
+}
+export interface SpotPostTrade {
+    trade_id: string;
+    price: string;
+    quantity: string;
+    symbol: string;
+    description: string;
+    base_asset: string;
+    base_notation: 'UNIT';
+    quote_asset: string;
+    quote_notation: 'MONE';
+    trade_venue: string;
+    trade_ts: string;
+    publication_venue: string;
+    publication_ts: string;
+}
+export interface SpotPostTradeDataResponse {
+    last_ts: string;
+    count: number;
+    trades: SpotPostTrade[];
+}
+/**
+ * OAuth
+ */
+export interface OauthGetAccessTokenResponse {
+    access_token: string;
+    token_type: 'bearer';
+    expires_in: number;
+    refresh_token: string;
+}
+export interface OauthGetUserInfoResponse {
+    result: {
+        email: string;
+        iban: string;
+    };
+}
+export interface OauthFastApiKey {
+    api_key?: string;
+    api_key_name: string;
+    created_time: string;
+    id: string;
+    ip_allowlist: string[];
+    last_used: number;
+    modified_time: string;
+    nonce: number;
+    nonce_window: number;
+    oauth_client: string;
+    permissions: any;
+    purpose: string;
+    query_from: number;
+    query_to: number;
+    valid_until: number;
+}
+export interface OauthCreateFastApiKeyResponse {
+    result: OauthFastApiKey & {
+        secret: string;
+    };
+}

package/dist/cjs/types/response/spot.types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Market Data
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot.types.js.map

package/dist/cjs/types/response/spot.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spot.types.js","sourceRoot":"","sources":["../../../../src/types/response/spot.types.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/dist/cjs/types/response/ws.d.ts

@@ -0,0 +1,11 @@
+export interface WsServerInfo {
+    endpoint: string;
+    encrypt: boolean;
+    protocol: string;
+    pingInterval: number;
+    pingTimeout: number;
+}
+export interface WsConnectionInfo {
+    token: string;
+    instanceServers: WsServerInfo[];
+}

package/dist/cjs/types/response/ws.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ws.js.map

package/dist/cjs/types/response/ws.js.map

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

package/dist/cjs/types/response/wsapi.types.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Websocket API v2 Spot Response Types
+ */
+export interface WSAPIAddSpotOrderResult {
+    order_id: string;
+    cl_ord_id?: string;
+    order_userref?: number;
+    warnings?: string[];
+}
+export interface WSAPIAmendSpotOrderResult {
+    amend_id: string;
+    order_id?: string;
+    cl_ord_id?: string;
+    warnings?: string[];
+}
+export interface WSAPICancelSpotOrderResult {
+    order_id: string;
+    cl_ord_id?: string;
+    warnings?: string[];
+}
+export interface WSAPICancelAllSpotOrdersResult {
+    count: number;
+    warnings?: string[];
+}
+export interface WSAPICancelAllSpotOrdersAfterResult {
+    currentTime: string;
+    triggerTime: string;
+    warnings?: string[];
+}
+export interface WSAPIBatchAddSpotOrdersResult {
+    order_id: string;
+    cl_ord_id?: string;
+    order_userref?: number;
+    warnings?: string[];
+}
+export interface WSAPIBatchCancelSpotOrdersResult {
+    count: number;
+    warnings?: string[];
+}
+export interface WSAPIEditSpotOrderResult {
+    order_id: string;
+    original_order_id: string;
+    warnings?: string[];
+}

package/dist/cjs/types/response/wsapi.types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Websocket API v2 Spot Response Types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=wsapi.types.js.map

package/dist/cjs/types/response/wsapi.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsapi.types.js","sourceRoot":"","sources":["../../../../src/types/response/wsapi.types.ts"],"names":[],"mappings":";AAAA;;GAEG"}