@siebly/kraken-api 0.0.9

package/dist/cjs/types/request/partner.types.d.ts

@@ -0,0 +1,291 @@
+/**
+ * Create User request parameters
+ */
+export interface PartnerCreateUserParams {
+    email: string;
+    external_id: string;
+    tos_version_accepted: number;
+    full_name: {
+        first_name: string;
+        middle_name?: string;
+        last_name: string;
+    };
+    date_of_birth: string;
+    residence: {
+        line1: string;
+        line2?: string;
+        city: string;
+        postal_code: string;
+        province?: string;
+        country: string;
+    };
+    phone: string;
+    nationalities: string[];
+    occupation: 'agriculture' | 'business_management' | 'computers_and_it' | 'construction' | 'education' | 'finance' | 'government' | 'healthcare' | 'hospitality' | 'manufacturing' | 'marketing' | 'media' | 'other' | 'science' | 'self_employed' | 'student' | 'transportation' | 'unemployed';
+    city_of_birth?: string;
+    country_of_birth?: string;
+    tax_ids?: Array<{
+        id: string;
+        issuing_country: string;
+    }>;
+    language?: string;
+}
+/**
+ * Update User request parameters
+ */
+export interface PartnerUpdateUserParams {
+    user: string;
+    tos_version_accepted?: number;
+    full_name?: {
+        first_name: string;
+        middle_name?: string;
+        last_name: string;
+    };
+    date_of_birth?: string;
+    city_of_birth?: string;
+    country_of_birth?: string;
+    residence?: {
+        line1: string;
+        line2?: string;
+        city: string;
+        postal_code: string;
+        province?: string;
+        country: string;
+    };
+    phone?: string;
+    nationalities?: string[];
+    tax_ids?: Array<{
+        id: string;
+        issuing_country: string;
+    }>;
+    occupation?: 'agriculture' | 'business_management' | 'computers_and_it' | 'construction' | 'education' | 'finance' | 'government' | 'healthcare' | 'hospitality' | 'manufacturing' | 'marketing' | 'media' | 'other' | 'science' | 'self_employed' | 'student' | 'transportation' | 'unemployed';
+    language?: string;
+}
+/**
+ * Submit Verification request parameters
+ */
+export interface PartnerSubmitVerificationParams {
+    user: string;
+    type: 'identity_document';
+    metadata: {
+        identity: {
+            full_name: {
+                first_name: string;
+                middle_name?: string;
+                last_name: string;
+            };
+            date_of_birth: string;
+        };
+        document_type: 'passport' | 'drivers_license' | 'id_card' | 'residence_card' | 'special_permanent_residence_card';
+        document_number: string;
+        issuing_country: string;
+        nationality?: string;
+    };
+    verifier: string;
+    verified_at: string;
+    verifier_response?: any;
+    external_verification_id?: string;
+    expiration_date?: string;
+    front: any;
+    back: any;
+    verifier_response_file?: any;
+}
+/**
+ * List Assets request parameters
+ */
+export interface PartnerListAssetsParams {
+    'filter[user]'?: string;
+    'filter[assets][]'?: string[];
+    'filter[platform_statuses][]'?: Array<'enabled' | 'deposit_only' | 'withdrawal_only' | 'funding_temporarily_disabled' | 'disabled'>;
+    'filter[tradable_only]'?: boolean;
+    sort?: 'trending' | 'market_cap_rank' | '-market_cap_rank' | 'symbol' | '-symbol' | 'name' | '-name' | 'change_percent_1h' | '-change_percent_1h' | 'change_percent_24h' | '-change_percent_24h' | 'change_percent_7d' | '-change_percent_7d' | 'change_percent_30d' | '-change_percent_30d' | 'change_percent_1y' | '-change_percent_1y' | 'listing_date' | '-listing_date';
+    'page[size]'?: number;
+    'page[number]'?: number;
+    quote?: string;
+    lang?: string;
+}
+/**
+ * Get Asset request parameters
+ */
+export interface PartnerGetAssetParams {
+    asset: string;
+    quote?: string;
+    lang?: string;
+}
+/**
+ * List Asset Rates request parameters
+ */
+export interface PartnerListAssetRatesParams {
+    asset: string;
+    quote?: string;
+    start_time?: string;
+    end_time?: string;
+    interval?: string;
+}
+/**
+ * Request Quote request parameters
+ */
+export interface PartnerRequestQuoteParams {
+    user: string;
+    type: 'receive' | 'spend';
+    amount: {
+        asset_class?: 'currency';
+        asset: string;
+        amount: string;
+    };
+    quote: {
+        asset: string;
+    };
+    fee_bps: string;
+    spread_bps: string;
+    quote_currency?: string;
+}
+/**
+ * Get Quote request parameters
+ */
+export interface PartnerGetQuoteParams {
+    quote_id: string;
+    user: string;
+}
+/**
+ * Execute Quote request parameters
+ */
+export interface PartnerExecuteQuoteParams {
+    quote_id: string;
+    user: string;
+}
+/**
+ * Get Portfolio Summary request parameters
+ */
+export interface PartnerGetPortfolioSummaryParams {
+    user: string;
+    quote?: string;
+    'include[current_day_pnl]'?: any;
+}
+/**
+ * Get Portfolio History request parameters
+ */
+export interface PartnerGetPortfolioHistoryParams {
+    user: string;
+    'include[assets][]'?: string[];
+    'include[total_balance]'?: boolean;
+    'include[total_pnl]'?: boolean;
+    start_date?: string;
+    end_date?: string;
+    resolution?: number;
+    quote?: string;
+    cursor?: string;
+}
+/**
+ * List Portfolio Details request parameters
+ */
+export interface PartnerListPortfolioDetailsParams {
+    user: string;
+    quote?: string;
+}
+/**
+ * List Portfolio Transactions request parameters
+ */
+export interface PartnerListPortfolioTransactionsParams {
+    user: string;
+    cursor?: string;
+    types?: Array<'simple_order' | 'simple_order_failed' | 'earn_reward'>;
+    page_size?: number;
+    assets?: string[];
+    from_time?: string;
+    until_time?: string;
+    statuses?: Array<'no_status' | 'unspecified' | 'in_progress' | 'successful' | 'failed'>;
+    ids?: string[];
+    sorting?: 'descending' | 'ascending';
+    ref_ids?: any[];
+    quote?: string;
+}
+/**
+ * Get Earn Summary request parameters
+ */
+export interface PartnerGetEarnSummaryParams {
+    user: string;
+    currency?: string;
+}
+/**
+ * List Earn Assets request parameters
+ */
+export interface PartnerListEarnAssetsParams {
+    assets?: string[];
+    user?: string;
+    currency?: string;
+}
+/**
+ * Toggle Auto-Earn request parameters
+ */
+export interface PartnerToggleAutoEarnParams {
+    user: string;
+    want_enabled: boolean;
+}
+/**
+ * Withdraw Funds request parameters
+ */
+export interface PartnerWithdrawFundsParams {
+    asset: string;
+    key: string;
+    amount: string;
+}
+/**
+ * List Funding Transactions request parameters
+ */
+export interface PartnerListFundingTransactionsParams {
+    type: 'withdrawal' | 'deposit';
+    cursor?: string;
+    page_size?: number;
+}
+/**
+ * List Settlement Reports request parameters
+ */
+export interface PartnerListSettlementReportsParams {
+    'filter[start_date]'?: string;
+    'filter[end_date]'?: string;
+    'filter[report_type][]'?: Array<'trades' | 'transfers' | 'earn_rewards'>;
+    'page[size]'?: number;
+    'page[number]'?: number;
+}
+/**
+ * Get Settlement Report request parameters
+ */
+export interface PartnerGetSettlementReportParams {
+    id: string;
+}
+/**
+ * Get Ramp Limits request parameters
+ */
+export interface PartnerGetRampLimitsParams {
+    in_asset: string;
+    out_asset: string;
+    funding_type: string;
+    withdrawal_method: string;
+}
+/**
+ * Get Ramp Prospective Quote request parameters
+ */
+export interface PartnerGetRampProspectiveQuoteParams {
+    in_asset: string;
+    in_amount: string;
+    out_asset: string;
+    funding_type: string;
+    withdrawal_method: string;
+}
+/**
+ * Get Ramp Checkout URL request parameters
+ */
+export interface PartnerGetRampCheckoutUrlParams {
+    in_asset: string;
+    in_amount: string;
+    out_asset: string;
+    funding_type: string;
+    withdrawal_method: string;
+    country?: string;
+    redirect_url?: string;
+    network?: string;
+    external_user_id?: string;
+    external_transaction_id?: string;
+    external_metadata?: string;
+}

package/dist/cjs/types/request/partner.types.js

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

package/dist/cjs/types/request/partner.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner.types.js","sourceRoot":"","sources":["../../../../src/types/request/partner.types.ts"],"names":[],"mappings":";AAAA,4BAA4B"}

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

@@ -0,0 +1,324 @@
+/**
+ * Market Data
+ */
+export interface SpotGetAssetPairsParams {
+    pair?: string;
+    aclass_base?: 'currency' | 'tokenized_asset';
+    info?: 'info' | 'leverage' | 'fees' | 'margin';
+    country_code?: string;
+}
+export interface SpotGetOHLCParams {
+    pair: string;
+    interval?: 1 | 5 | 15 | 30 | 60 | 240 | 1440 | 10080 | 21600;
+    since?: number;
+    asset_class?: 'tokenized_asset';
+}
+export interface SpotGetOrderBookParams {
+    pair: string;
+    count?: number;
+    asset_class?: 'tokenized_asset';
+}
+export interface SpotGetRecentTradesParams {
+    pair: string;
+    since?: string;
+    count?: number;
+    asset_class?: 'tokenized_asset';
+}
+export interface SpotGetRecentSpreadsParams {
+    pair: string;
+    since?: number;
+    asset_class?: 'tokenized_asset';
+}
+/**
+ * Account Data
+ */
+export interface SpotGetOpenOrdersParams {
+    trades?: boolean;
+    userref?: number;
+    cl_ord_id?: string;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetClosedOrdersParams {
+    trades?: boolean;
+    userref?: number;
+    cl_ord_id?: string;
+    start?: number;
+    end?: number;
+    ofs?: number;
+    closetime?: 'open' | 'close' | 'both';
+    consolidate_taker?: boolean;
+    without_count?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotQueryOrdersParams {
+    trades?: boolean;
+    userref?: number;
+    txid: string;
+    consolidate_taker?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetTradesHistoryParams {
+    type?: 'all' | 'any position' | 'closed position' | 'closing position' | 'no position';
+    trades?: boolean;
+    start?: number;
+    end?: number;
+    ofs?: number;
+    consolidate_taker?: boolean;
+    ledgers?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotQueryTradesParams {
+    txid: string;
+    trades?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetOpenPositionsParams {
+    txid?: string;
+    docalcs?: boolean;
+    consolidation?: 'market';
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetLedgersInfoParams {
+    asset?: string;
+    aclass?: string;
+    type?: 'all' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'credit' | 'settled' | 'staking' | 'dividend' | 'sale' | 'nft_rebate';
+    start?: number;
+    end?: number;
+    ofs?: number;
+    without_count?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotQueryLedgersParams {
+    id: string;
+    trades?: boolean;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotRequestExportReportParams {
+    report: 'trades' | 'ledgers';
+    format?: 'CSV' | 'TSV';
+    description: string;
+    fields?: string;
+    starttm?: number;
+    endtm?: number;
+}
+/**
+ * Trading
+ */
+export interface SpotSubmitOrderParams {
+    userref?: number;
+    cl_ord_id?: string;
+    ordertype: 'market' | 'limit' | 'iceberg' | 'stop-loss' | 'take-profit' | 'stop-loss-limit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
+    type: 'buy' | 'sell';
+    volume: string;
+    displayvol?: string;
+    pair: string;
+    asset_class?: 'tokenized_asset';
+    price?: string;
+    price2?: string;
+    trigger?: 'index' | 'last';
+    leverage?: string;
+    reduce_only?: boolean;
+    stptype?: 'cancel-newest' | 'cancel-oldest' | 'cancel-both';
+    oflags?: string;
+    timeinforce?: 'GTC' | 'IOC' | 'GTD';
+    starttm?: string;
+    expiretm?: string;
+    'close[ordertype]'?: string;
+    'close[price]'?: string;
+    'close[price2]'?: string;
+    deadline?: string;
+    validate?: boolean;
+}
+export interface SpotAmendOrderParams {
+    txid?: string;
+    cl_ord_id?: string;
+    order_qty?: string;
+    display_qty?: string;
+    limit_price?: string;
+    trigger_price?: string;
+    pair?: string;
+    post_only?: boolean;
+    deadline?: string;
+}
+export interface SpotBatchOrderItem {
+    userref?: number;
+    cl_ord_id?: string;
+    ordertype: 'market' | 'limit' | 'iceberg' | 'stop-loss' | 'take-profit' | 'stop-loss-limit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
+    type: 'buy' | 'sell';
+    volume: string;
+    displayvol?: string;
+    price?: string;
+    price2?: string;
+    trigger?: 'index' | 'last';
+    leverage?: string;
+    reduce_only?: boolean;
+    stptype?: 'cancel-newest' | 'cancel-oldest' | 'cancel-both';
+    oflags?: string;
+    timeinforce?: 'GTC' | 'IOC' | 'GTD';
+    starttm?: string;
+    expiretm?: string;
+    close?: {
+        ordertype?: string;
+        price?: string;
+        price2?: string;
+    };
+}
+export interface SpotSubmitOrderBatchParams {
+    orders: SpotBatchOrderItem[];
+    pair: string;
+    asset_class?: 'tokenized_asset';
+    deadline?: string;
+    validate?: boolean;
+}
+/**
+ * Funding
+ */
+export interface SpotGetDepositMethodsParams {
+    asset: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetDepositAddressesParams {
+    asset: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    method: string;
+    new?: boolean;
+    amount?: string | number;
+}
+export interface SpotGetDepositStatusParams {
+    asset?: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    method?: string;
+    start?: string;
+    end?: string;
+    cursor?: boolean | string;
+    limit?: number;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetWithdrawalMethodsParams {
+    asset?: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    network?: string;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetWithdrawalAddressesParams {
+    asset?: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    method?: string;
+    key?: string;
+    verified?: boolean;
+}
+export interface SpotGetWithdrawalInfoParams {
+    asset: string;
+    key: string;
+    amount: string;
+}
+export interface SpotWithdrawFundsParams {
+    asset: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    key: string;
+    address?: string;
+    amount: string;
+    max_fee?: string;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotGetWithdrawalsStatusParams {
+    asset?: string;
+    aclass?: 'currency' | 'tokenized_asset';
+    method?: string;
+    start?: string;
+    end?: string;
+    cursor?: boolean | string;
+    limit?: number;
+    rebase_multiplier?: 'rebased' | 'base';
+}
+export interface SpotWalletTransferParams {
+    asset: string;
+    from: 'Spot Wallet';
+    to: 'Futures Wallet';
+    amount: string;
+}
+/**
+ * Subaccounts
+ */
+export interface SpotAccountTransferParams {
+    asset: string;
+    asset_class?: 'currency' | 'tokenized_asset';
+    amount: string;
+    from: string;
+    to: string;
+}
+/**
+ * Earn
+ */
+export interface SpotListEarnStrategiesParams {
+    ascending?: boolean;
+    asset?: string;
+    cursor?: string;
+    limit?: number;
+    lock_type?: ('flex' | 'bonded' | 'timed' | 'instant')[];
+}
+export interface SpotListEarnAllocationsParams {
+    ascending?: boolean;
+    converted_asset?: string;
+    hide_zero_allocations?: boolean;
+}
+/**
+ * Transparency
+ */
+export interface SpotGetPostTradeDataParams {
+    symbol?: string;
+    from_ts?: string;
+    to_ts?: string;
+    count?: number;
+}
+/**
+ * OAuth
+ */
+export interface OauthGetAccessTokenParams {
+    grant_type: 'authorization_code' | 'refresh_token';
+    code?: string;
+    redirect_uri?: string;
+    refresh_token?: string;
+}
+export interface OauthCreateFastApiKeyParams {
+    api_key_name: string;
+    ip_allowlist: string[];
+    nonce_window?: number;
+    permissions: {
+        export_data?: boolean;
+        funds_add?: boolean;
+        funds_earn?: boolean;
+        funds_query?: boolean;
+        funds_withdraw?: boolean;
+        ledger_query?: boolean;
+        trades_close?: boolean;
+        trades_modify?: boolean;
+        trades_query_closed?: boolean;
+        trades_query_open?: boolean;
+    };
+    query_from?: number;
+    query_to?: number;
+    valid_until?: number;
+}
+export interface OauthUpdateFastApiKeyParams {
+    new_api_key_name?: string;
+    api_key_name: string;
+    ip_allowlist: string[];
+    nonce_window?: number;
+    permissions: {
+        export_data?: boolean;
+        funds_add?: boolean;
+        funds_earn?: boolean;
+        funds_query?: boolean;
+        funds_withdraw?: boolean;
+        ledger_query?: boolean;
+        trades_close?: boolean;
+        trades_modify?: boolean;
+        trades_query_closed?: boolean;
+        trades_query_open?: boolean;
+    };
+    query_from?: number;
+    query_to?: number;
+    valid_until?: number;
+}

package/dist/cjs/types/request/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/request/spot.types.js.map

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