@siebly/kraken-api 0.0.9

package/dist/mjs/types/response/derivatives.types.js

@@ -0,0 +1,5 @@
+/**
+ * Market Data
+ */
+export {};
+//# sourceMappingURL=derivatives.types.js.map

package/dist/mjs/types/response/derivatives.types.js.map

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

package/dist/mjs/types/response/institutional.types.d.ts

@@ -0,0 +1,318 @@
+export type CustodyVaultStatus = 'pending' | 'created' | 'failed' | 'disabled';
+export interface CustodyVault {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    count_assets: number;
+    status: CustodyVaultStatus;
+    iiban: string;
+    deposit_lock_rekeying_only?: boolean | null;
+    name: string;
+    description?: string | null;
+    balance_fiat?: string | null;
+    balance_diff?: string | null;
+    available_balance_fiat?: string | null;
+    otc_enabled?: boolean;
+}
+export interface CustodyApiError {
+    severity: 'E' | 'W';
+    errorClass: string;
+    type: string;
+    errorMessage?: string | null;
+}
+export interface CustodyListVaultsResponse {
+    result?: CustodyVault[] | null;
+    errors?: CustodyApiError[];
+    start?: number;
+    total?: number;
+}
+export interface CustodyAssetBalance {
+    current_usd_value?: string | null;
+    quantity: string;
+}
+export interface CustodyVaultAssetDetail {
+    asset: string;
+    current_usd_price?: string | null;
+    available_balance: CustodyAssetBalance;
+    total_balance: CustodyAssetBalance;
+}
+export interface CustodyVaultWithAssets extends CustodyVault {
+    asset_details: CustodyVaultAssetDetail[];
+}
+export interface CustodyGetVaultResponse {
+    result?: CustodyVaultWithAssets | null;
+    errors: CustodyApiError[];
+}
+export interface CustodyDepositMethod {
+    method?: string;
+    limit?: string | boolean;
+    fee?: string;
+    'fee-percentage'?: string | null;
+    'address-setup-fee'?: string | null;
+    'gen-address'?: boolean | null;
+    minimum?: string | null;
+}
+export interface CustodyDepositMethodsResponse {
+    result?: CustodyDepositMethod[] | null;
+    error: CustodyApiError[];
+}
+export interface CustodyDepositAddress {
+    address: string;
+    expiretm?: string;
+    memo?: string | null;
+    new?: boolean | null;
+    tag?: string | null;
+}
+export interface CustodyDepositAddressesResponse {
+    error: CustodyApiError[];
+    result?: CustodyDepositAddress[] | null;
+}
+export type CustodyTransactionType = 'unspecified' | 'deposit' | 'withdrawal' | 'trade' | 'margin' | 'adjustment' | 'rollover' | 'interest' | 'credit' | 'transfer' | 'transfer_peer_to_peer' | 'settle' | 'dividend' | 'nft_trade' | 'reward' | 'nft_creator_fee' | 'nft_rebate' | 'nft_airdrop' | 'simple_order' | 'simple_order_with_deposit' | 'simple_order_failed' | 'custom_simple_order' | 'custom_simple_order_with_deposit' | 'custom_simple_order_failed' | 'recurring_simple_order' | 'recurring_simple_order_with_deposit' | 'recurring_simple_order_failed' | 'simple_order_opposite_side' | 'reserved_fee' | 'fee_sweep' | 'ic_settlement' | 'fee_sweep_dlt' | 'reward_sweep' | 'reward_sweep_old' | 'interest_sweep' | 'conversion' | 'dust_sweep' | 'futures_transfer' | 'custody_transfer' | 'deposit_action' | 'withdrawal_action' | 'legacy_staking_allocation' | 'legacy_staking_deallocation' | 'legacy_staking_reward' | 'earn_legacy_migration' | 'block_trade' | 'equity_trade' | 'equity_acats' | 'earn_staking_allocation' | 'earn_staking_deallocation' | 'earn_staking_reward' | 'earn_staking_auto_allocation' | 'earn_oir_allocation' | 'earn_oir_deallocation' | 'earn_oir_reward' | 'earn_oir_auto_allocation' | 'earn_base_reward' | 'earn_base_auto_allocation' | 'earn_base_auto_deallocation' | 'custody_staking' | 'custody_unstaking' | 'custody_staking_reward' | 'custody_staking_reward_aggregated' | 'credit_rollover' | 'airdrop' | 'earn_oir_auto_deallocation' | 'earn_staking_auto_deallocation' | 'bridge_deposit' | 'bridge_simple_order' | 'simple_order_deposit_action' | 'otc_buy' | 'otc_sell' | 'bundle_trade' | 'equity_fee' | 'equity_journal' | 'corporate_action' | 'user_account_transfer' | 'earn_restaking' | 'subscription' | 'custody_otc_loan_pledge' | 'custody_otc_collateral_liquidation' | 'paytag_transfer' | 'paylink_transfer' | 'paytag_request_transfer' | 'paylink_request_transfer' | 'kard_transfer' | 'krak_card' | 'custody_otc_loan_release' | 'fpsl_reward' | 'fcm_trade' | 'boost' | 'fcm_misc';
+export type CustodyTransactionCategory = 'unspecified' | 'deposit' | 'withdrawal' | 'transfer' | 'krak_card' | 'trade' | 'margin_trade' | 'margin_rollover' | 'margin_settle' | 'earn' | 'earn_rewards' | 'simple_trading' | 'nft' | 'block_trade' | 'credit' | 'equity_trade' | 'equity_acats' | 'equity_dividend' | 'reward_bonus' | 'conversion' | 'reward' | 'custody' | 'legacy_staking' | 'legacy_staking_rewards' | 'equity_fee' | 'equity_journal' | 'corporate_action' | 'fpsl_reward' | 'subscription' | 'other';
+export type CustodyTransactionArea = 'unspecified' | 'funding' | 'transfer' | 'krak_card' | 'spot_margin' | 'equity' | 'earn' | 'simple_trading' | 'custody' | 'staking' | 'nft' | 'other';
+export type CustodyTransactionStatus = 'unspecified' | 'in_progress' | 'successful' | 'failed';
+export type CustodyTransactionAssetClass = 'currency' | 'forex' | 'equity' | 'equity_pair' | 'nft' | 'derivatives' | 'tokenized_asset' | 'futures_contract';
+export interface CustodyTransactionAmount {
+    amount: string;
+    asset: string;
+    class: CustodyTransactionAssetClass;
+}
+export interface CustodyTransactionSide {
+    ledger_id?: string | null;
+    time?: string | null;
+    subtype?: string | null;
+    amount: CustodyTransactionAmount;
+    quoted_amount?: CustodyTransactionAmount | null;
+    fee?: CustodyTransactionAmount | null;
+    quoted_fee?: CustodyTransactionAmount | null;
+    total?: CustodyTransactionAmount | null;
+    quoted_total?: CustodyTransactionAmount | null;
+    balance?: CustodyTransactionAmount | null;
+    wallet?: Record<string, any> | null;
+}
+export interface CustodyTransaction {
+    id: string;
+    time: string;
+    type: CustodyTransactionType;
+    category: CustodyTransactionCategory;
+    area: CustodyTransactionArea;
+    status?: CustodyTransactionStatus | null;
+    ref_id: string;
+    ref_id2?: string | null;
+    spend?: CustodyTransactionSide | null;
+    receive?: CustodyTransactionSide | null;
+    details?: Record<string, any> | null;
+}
+export interface CustodyTransactionStats {
+    transactions_seen?: number;
+}
+export interface CustodyListTransactionsResponse {
+    result?: {
+        transactions: CustodyTransaction[];
+        stats?: CustodyTransactionStats | null;
+        next_cursor?: string | null;
+    } | null;
+    errors: CustodyApiError[];
+}
+export type CustodyTransactionResultType = 'complete' | 'incomplete_requires_long_timeout' | 'incomplete';
+export interface CustodyGetTransactionResponse {
+    error: CustodyApiError[];
+    result?: {
+        transaction: CustodyTransaction;
+        result_type: CustodyTransactionResultType;
+    } | null;
+}
+export interface CustodyWithdrawMethodLimit {
+    remaining: string | number;
+    maximum: string | number;
+}
+export interface CustodyWithdrawMethodLimitInfo {
+    limit_type: string;
+    description?: string | null;
+    limits: Record<string, CustodyWithdrawMethodLimit>;
+}
+export interface CustodyWithdrawMethodFee {
+    aclass: string;
+    asset: string;
+    fee: string;
+    fee_percentage?: string | null;
+}
+export interface CustodyWithdrawMethod {
+    asset: string;
+    method_id?: string | null;
+    method?: string | null;
+    network_id?: string | null;
+    network?: string | null;
+    minimum?: string | null;
+    limits?: CustodyWithdrawMethodLimitInfo[] | null;
+    fee?: CustodyWithdrawMethodFee | null;
+}
+export interface CustodyWithdrawMethodsResponse {
+    error: CustodyApiError[];
+    result?: CustodyWithdrawMethod[] | null;
+}
+export interface CustodyWithdrawAddress {
+    address?: string | null;
+    asset?: string | null;
+    method?: string | null;
+    key?: string | null;
+    verified: boolean;
+    memo?: string | null;
+    tag?: string | null;
+    networks?: string[] | null;
+}
+export interface CustodyWithdrawAddressesResponse {
+    error: CustodyApiError[];
+    result?: CustodyWithdrawAddress[] | null;
+}
+export type CustodyUserRole = 'admin' | 'initiator' | 'reviewer' | 'auditor';
+export interface CustodyTaskUser {
+    full_name?: string | null;
+    role?: CustodyUserRole | null;
+    ip_address?: string | null;
+    iiban?: string | null;
+}
+export interface CustodyTaskReviewerStatistics {
+    current_count: number;
+    approved: number;
+    denied: number;
+    undecided: number;
+}
+export type CustodyTaskState = 'pending' | 'approved' | 'denied' | 'canceled' | 'expired' | 'executed' | 'failed';
+export type CustodyTaskUserDecision = 'approved' | 'denied' | 'undecided';
+export interface CustodyTask {
+    can_review: boolean;
+    reviewer_statistics: CustodyTaskReviewerStatistics;
+    current_user_decision: CustodyTaskUserDecision;
+    id: string;
+    approval_id: string;
+    created_at: string;
+    updated_at: string;
+    expires_at: string;
+    initiator: CustodyTaskUser;
+}
+export interface CustodyListTasksResponse {
+    result?: CustodyTask[] | null;
+    errors: CustodyApiError[];
+    start: number;
+    total: number;
+}
+export interface CustodyTaskDetails {
+    state: CustodyTaskState;
+    [key: string]: any;
+}
+export interface CustodyGetTaskResponse {
+    result?: CustodyTaskDetails | null;
+    errors: CustodyApiError[];
+}
+export type CustodyActivityAction = 'created' | 'review_approved' | 'review_denied' | 'canceled' | 'executed' | 'failed' | 'expired';
+export interface CustodyActivity {
+    task: CustodyTaskDetails;
+    id: string;
+    created_at: string;
+}
+export interface CustodyListActivitiesResponse {
+    result?: CustodyActivity[] | null;
+    errors: CustodyApiError[];
+    start: number;
+    total: number;
+}
+export interface CustodyActivityDetails {
+    type: CustodyActivityAction;
+    comment?: string | null;
+    user: CustodyTaskUser;
+    [key: string]: any;
+}
+export interface CustodyGetActivityResponse {
+    result?: CustodyActivityDetails | null;
+    errors: CustodyApiError[];
+}
+export interface OtcQuote {
+    [key: string]: any;
+}
+export interface OTCCreateQuoteResponse {
+    result?: {
+        quote: OtcQuote;
+    };
+    error: string[];
+}
+export interface OTCUpdateQuoteResponse {
+    result?: {
+        quote_id?: string;
+    };
+    error: string[];
+}
+export interface OtcPair {
+    base: string;
+    quote: string;
+    pair_name: string;
+    pair_decimals: number;
+    lot_decimals: number;
+    cost_decimals: number;
+    max_base_amount: string;
+    max_notional?: string;
+    min_base_amount?: string;
+    min_notional?: string;
+}
+export interface OTCGetPairsResponse {
+    result: {
+        spot_pairs: OtcPair[];
+    };
+    error: string[];
+}
+export interface OtcActiveQuote {
+    expires: {
+        time: number;
+    };
+    quote_id: string;
+    client_order_id?: string | null;
+    base: string;
+    quote: string;
+    type: string;
+    price?: string;
+    amount: string;
+    total?: string;
+    settlement: string;
+}
+export interface OTCGetActiveQuotesResponse {
+    result?: OtcActiveQuote[];
+    error: string[];
+}
+export interface OtcHistoricalQuote {
+    trade_id?: string | null;
+    status?: string | null;
+    acceptance: {
+        status: string;
+        time: number;
+    };
+    settlement_status: string;
+    quote_id: string;
+    client_order_id?: string | null;
+    base: string;
+    quote: string;
+    type: string;
+    price: string;
+    amount: string;
+    total: string;
+    settlement: string;
+}
+export interface OTCGetHistoricalQuotesResponse {
+    result?: OtcHistoricalQuote[];
+    error: string[];
+}
+export interface OtcExposures {
+    max_otc: string;
+    max_rfq: string;
+    used_otc: string;
+    used_rfq: string;
+}
+export interface OTCGetExposuresResponse {
+    result?: OtcExposures;
+    error: string[];
+}
+export interface OTCCheckClientResponse {
+    result?: {
+        permissions: string[];
+    };
+    error: string[];
+}

package/dist/mjs/types/response/institutional.types.js

@@ -0,0 +1,3 @@
+// Custody API - Response Types
+export {};
+//# sourceMappingURL=institutional.types.js.map

package/dist/mjs/types/response/institutional.types.js.map

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

package/dist/mjs/types/response/partner.types.d.ts

@@ -0,0 +1,332 @@
+/**
+ * Create User response
+ */
+export interface PartnerCreateUserResponse {
+    result: {
+        user: {
+            iiban: string;
+        };
+    };
+}
+/**
+ * Get User response
+ */
+export interface PartnerGetUserResponse {
+    result?: {
+        user: string;
+        external_id?: string;
+        user_type: 'individual' | 'corporate';
+        status: {
+            state: string;
+            required_actions?: any[];
+        };
+        created_at: string;
+    };
+}
+/**
+ * Update User response
+ */
+export interface PartnerUpdateUserResponse {
+    result?: 'success';
+}
+/**
+ * Submit Verification response
+ */
+export interface PartnerSubmitVerificationResponse {
+    result?: {
+        verification_id: string;
+    };
+}
+/**
+ * List Assets response
+ */
+export interface PartnerListAssetsResponse {
+    result: {
+        assets: any[];
+        links: any;
+        meta: {
+            total_items?: number;
+            total_pages?: number;
+            page_size?: number;
+            page_number?: number;
+        };
+    };
+}
+/**
+ * Get Asset response
+ */
+export interface PartnerGetAssetResponse {
+    result: any;
+}
+/**
+ * List Asset Rates response
+ */
+export interface PartnerListAssetRatesResponse {
+    result: {
+        rates: Array<{
+            timestamp: string;
+            price: string;
+        }>;
+        meta: any;
+    };
+}
+/**
+ * Request Quote response
+ */
+export interface PartnerRequestQuoteResponse {
+    result: {
+        quote_id: string;
+        type: 'receive' | 'spend';
+        status: any;
+        expires: string;
+        spend: any;
+        quoted_spend?: any;
+        receive: any;
+        quoted_receive?: any;
+        unit_price: any;
+        quoted_unit_price?: any;
+    };
+}
+/**
+ * Get Quote response
+ */
+export interface PartnerGetQuoteResponse {
+    result?: {
+        quote_id: string;
+        transaction_id?: string;
+        type: 'receive' | 'spend';
+        status: any;
+        expires: string;
+        spend: any;
+        quoted_spend?: any;
+        receive: any;
+        quoted_receive?: any;
+        unit_price: any;
+        quoted_unit_price?: any;
+    };
+}
+/**
+ * Execute Quote response
+ */
+export interface PartnerExecuteQuoteResponse {
+    result?: {
+        quote_id: string;
+        status: any;
+        transaction_id?: string;
+    };
+}
+/**
+ * Get Portfolio Summary response
+ */
+export interface PartnerGetPortfolioSummaryResponse {
+    result: {
+        timestamp: string;
+        currency: string;
+        portfolio_value: string;
+        withheld_value: string;
+        open_orders: string;
+        available_balance: string;
+        lots_upnl?: string;
+        cost_basis?: string;
+        current_day_pnl?: {
+            since: string;
+            pnl: string;
+        };
+    };
+}
+/**
+ * Get Portfolio History response
+ */
+export interface PartnerGetPortfolioHistoryResponse {
+    result: {
+        start_date: string;
+        end_date: string;
+        next_cursor?: string;
+        currency?: string;
+        total_pnl?: string;
+        total_pnl_pct?: string;
+        history: any[];
+    };
+}
+/**
+ * List Portfolio Details response
+ */
+export interface PartnerListPortfolioDetailsResponse {
+    result?: {
+        timestamp: string;
+        currency: string;
+        assets: any[];
+    };
+}
+/**
+ * List Portfolio Transactions response
+ */
+export interface PartnerListPortfolioTransactionsResponse {
+    result?: {
+        transactions: any[];
+        stats?: {
+            transactions_seen?: number;
+        };
+        next_cursor?: string;
+    };
+}
+/**
+ * Get Earn Summary response
+ */
+export interface PartnerGetEarnSummaryResponse {
+    result: {
+        auto_earn_eligible: boolean;
+        auto_earn_enabled: boolean;
+        auto_earn_last_changed?: string;
+        payout_period: string;
+        total_allocated_converted: string;
+        total_rewarded_converted_true_rates: string;
+        total_rewarded_converted_current_rate: string;
+        num_earning_assets: number;
+        upcoming_rewards: any[];
+    };
+}
+/**
+ * List Earn Assets response
+ */
+export interface PartnerListEarnAssetsResponse {
+    result: {
+        assets: Record<string, any>;
+    };
+}
+/**
+ * Toggle Auto-Earn response
+ */
+export interface PartnerToggleAutoEarnResponse {
+    result?: any;
+}
+/**
+ * Withdraw Funds response
+ */
+export interface PartnerWithdrawFundsResponse {
+    result?: {
+        reference_id: string;
+    };
+}
+/**
+ * List Funding Transactions response
+ */
+export interface PartnerListFundingTransactionsResponse {
+    result: {
+        transactions: Array<{
+            type: 'withdrawal' | 'deposit';
+            date: string;
+            asset: string;
+            amount: string;
+            status: 'initial' | 'pending' | 'settled' | 'success' | 'partial' | 'failure';
+            ref_id: string;
+        }>;
+        next_cursor?: string;
+    };
+}
+/**
+ * List Settlement Reports response
+ */
+export interface PartnerListSettlementReportsResponse {
+    result?: {
+        reports: Array<{
+            id: string;
+            date: string;
+            type: 'trades' | 'transfers' | 'earn_rewards';
+            size: number;
+            name: string;
+        }>;
+        links: {
+            self?: string;
+            first?: string;
+            last?: string;
+            prev?: string;
+            next?: string;
+        };
+        meta: {
+            total_items?: number;
+            total_pages?: number;
+            page_size?: number;
+            page_number?: number;
+        };
+    };
+}
+/**
+ * Get Settlement Report response
+ */
+export interface PartnerGetSettlementReportResponse {
+    result?: {
+        id: string;
+        date: string;
+        type: 'trades' | 'transfers' | 'earn_rewards';
+        size: number;
+        name: string;
+        download_url: string;
+        expires_at: string;
+    };
+}
+/**
+ * List Ramp Buy Crypto Assets response
+ */
+export interface PartnerListRampBuyCryptoAssetsResponse {
+    result: {
+        assets: any[];
+    };
+}
+/**
+ * List Ramp Fiat Currencies response
+ */
+export interface PartnerListRampFiatCurrenciesResponse {
+    result: {
+        currencies: Array<{
+            asset: string;
+            asset_class?: 'currency';
+        }>;
+    };
+}
+/**
+ * List Ramp Payment Methods response
+ */
+export interface PartnerListRampPaymentMethodsResponse {
+    result: {
+        methods: Array<{
+            funding_type: string;
+            external_id?: string;
+        }>;
+    };
+}
+/**
+ * List Ramp Countries response
+ */
+export interface PartnerListRampCountriesResponse {
+    result: {
+        countries: any[];
+    };
+}
+/**
+ * Get Ramp Limits response
+ */
+export interface PartnerGetRampLimitsResponse {
+    result: {
+        limits: any;
+    };
+}
+/**
+ * Get Ramp Prospective Quote response
+ */
+export interface PartnerGetRampProspectiveQuoteResponse {
+    result: {
+        spend: any;
+        receive: any;
+        unit_price: any;
+    };
+}
+/**
+ * Get Ramp Checkout URL response
+ */
+export interface PartnerGetRampCheckoutUrlResponse {
+    result: {
+        checkout_url: string;
+        request_data: any;
+    };
+}

package/dist/mjs/types/response/partner.types.js

@@ -0,0 +1,3 @@
+// Partner API response types
+export {};
+//# sourceMappingURL=partner.types.js.map

package/dist/mjs/types/response/partner.types.js.map

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

package/dist/mjs/types/response/shared.types.d.ts

@@ -0,0 +1,27 @@
+import { RestClientOptions } from '../../lib/requestUtils.js';
+export type DerivativesAPISuccessResponse<TData> = {
+    result: 'success';
+    serverTime: string;
+} & TData;
+export interface DerivativesAPIErrorResponse {
+    result: 'error';
+    error: string;
+    serverTime: string;
+}
+export type DerivativesAPIResponse<TData> = DerivativesAPISuccessResponse<TData> | DerivativesAPIErrorResponse;
+export type SpotAPISuccessResponse<TData> = {
+    error: string[];
+    result: TData;
+};
+export interface SpotAPIErrorResponse {
+    error: string[];
+}
+export type SpotAPIResponse<TData> = SpotAPISuccessResponse<TData> | SpotAPIErrorResponse;
+export interface GenericAPIError<TBody = any> {
+    code: number;
+    message: string;
+    body: TBody;
+    headers: Record<string, string>;
+    requestOptions: RestClientOptions;
+    requestParams: Record<string, any>;
+}

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

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