valr-typescript-client 1.0.6 → 1.0.8

package/dist/index.d.mts

@@ -1044,6 +1044,21 @@ interface DepositAddress {
         tag?: string;
     };
 }
+/**
+ * Crypto deposit history params
+ */
+interface CryptoDepositHistoryParams {
+    /** Number of records to skip */
+    skip?: number;
+    /** Maximum number of records to return */
+    limit?: number;
+    /** Start time (ISO 8601) */
+    startTime?: ISOTimestamp;
+    /** End time (ISO 8601) */
+    endTime?: ISOTimestamp;
+    /** Filter by currency code */
+    currency?: CurrencyCode;
+}
 /**
  * Crypto deposit history item
  */
@@ -1094,36 +1109,45 @@ interface WhitelistedAddress {
  * Withdrawal configuration info
  */
 interface WithdrawalConfigInfo {
+    /** Currency code */
+    currency: CurrencyCode;
+    /** Whether withdrawals are active */
+    isActive: boolean;
     /** Minimum withdrawal amount */
     minimumWithdrawAmount: string;
-    /** Maximum withdrawal amount */
-    maximumWithdrawAmount: string;
-    /** Withdrawal fee */
-    withdrawalFee: string;
-    /** Whether withdrawals are enabled */
-    withdrawalsEnabled: boolean;
-    /** Available networks for withdrawal */
-    networks?: Array<{
-        networkType: string;
-        minimumWithdrawAmount: string;
-        maximumWithdrawAmount: string;
-        withdrawalFee: string;
-    }>;
+    /** Network type */
+    networkType: string;
+    /** Whether payment reference is supported */
+    supportsPaymentReference: boolean;
+    /** Withdrawal cost/fee */
+    withdrawCost: string;
+    /** Withdrawal decimal places */
+    withdrawalDecimalPlaces: number;
 }
 /**
  * Crypto withdrawal request
  */
 interface CryptoWithdrawalRequest {
-    /** Currency code */
+    /** Currency code (not in body, used in path) */
     currency: CurrencyCode;
-    /** Withdrawal amount */
-    amount: string;
     /** Destination address */
     address: string;
+    /** Withdrawal amount */
+    amount: string;
     /** Network type */
     networkType?: NetworkType;
     /** Payment reference/memo (optional) */
     paymentReference?: string;
+    /** Allow borrowing to fulfill withdrawal */
+    allowBorrow?: boolean;
+    /** Beneficiary name (Travel Rule requirement) */
+    beneficiaryName?: string;
+    /** Whether beneficiary is a corporate entity (Travel Rule) */
+    isCorporate?: boolean;
+    /** Whether address is self-hosted (Travel Rule) */
+    isSelfHosted?: boolean;
+    /** Service provider ID */
+    serviceProviderId?: string;
 }
 /**
  * Crypto withdrawal response
@@ -1131,14 +1155,6 @@ interface CryptoWithdrawalRequest {
 interface CryptoWithdrawalResponse {
     /** Unique withdrawal ID */
     id: string;
-    /** Currency code */
-    currency: CurrencyCode;
-    /** Withdrawal amount */
-    amount: string;
-    /** Fee amount */
-    feeAmount: string;
-    /** When withdrawal was created */
-    createdAt: ISOTimestamp;
 }
 /**
  * Crypto withdrawal status
@@ -1173,10 +1189,10 @@ interface CryptoWithdrawalStatus {
  * Service provider information
  */
 interface ServiceProvider {
+    /** Service provider ID */
+    id: string;
     /** Provider name */
     name: string;
-    /** Supported currencies */
-    supportedCurrencies: CurrencyCode[];
 }
 /**
  * Crypto withdrawal history params
@@ -1186,6 +1202,12 @@ interface CryptoWithdrawalHistoryParams {
     skip?: number;
     /** Maximum number of records to return */
     limit?: number;
+    /** Filter by currency code */
+    currency?: CurrencyCode;
+    /** Start time (ISO 8601) */
+    startTime?: ISOTimestamp;
+    /** End time (ISO 8601) */
+    endTime?: ISOTimestamp;
 }
 /**
  * Crypto withdrawal history item
@@ -1268,41 +1290,22 @@ interface LinkBankAccountRequest {
     branchCode: string;
     /** Account type */
     accountType: string;
+    /** Country code */
+    country: string;
 }
 /**
  * Fiat deposit reference
  */
 interface FiatDepositReference {
-    /** Currency code */
-    currency: CurrencyCode;
     /** Reference code to use when depositing */
     reference: string;
-    /** Deposit instructions */
-    depositInstructions?: string;
 }
 /**
  * Auto-buy deposit reference
  */
 interface AutoBuyDepositReference {
-    /** Fiat currency code */
-    currency: CurrencyCode;
-    /** Crypto currency to auto-buy */
-    buyCurrencySymbol: CurrencyCode;
     /** Reference code to use when depositing */
     reference: string;
-    /** Deposit instructions */
-    depositInstructions?: string;
-}
-/**
- * Supported auto-buy currency
- */
-interface AutoBuyCurrency {
-    /** Currency code */
-    currencySymbol: CurrencyCode;
-    /** Currency name */
-    currencyName: string;
-    /** Whether auto-buy is enabled */
-    enabled: boolean;
 }
 /**
  * Fiat withdrawal request
@@ -1316,6 +1319,8 @@ interface FiatWithdrawalRequest {
     linkedBankAccountId: string;
     /** Whether withdrawal is fast */
     fast?: boolean;
+    /** Allow borrowing to fulfill withdrawal */
+    allowBorrow?: boolean;
 }
 /**
  * Fiat withdrawal response
@@ -1323,12 +1328,6 @@ interface FiatWithdrawalRequest {
 interface FiatWithdrawalResponse {
     /** Unique withdrawal ID */
     id: string;
-    /** Currency code */
-    currency: CurrencyCode;
-    /** Withdrawal amount */
-    amount: string;
-    /** When withdrawal was created */
-    createdAt: ISOTimestamp;
 }
 
 /**
@@ -1947,18 +1946,60 @@ interface OrderStatusUpdate extends BaseWebSocketMessage {
     customerOrderId?: CustomerOrderId;
 }
 /**
- * Balance update (WebSocket)
+ * Currency info in balance update
  */
-interface BalanceUpdate extends BaseWebSocketMessage {
-    type: 'BALANCE_UPDATE';
-    /** Currency */
-    currency: string;
+interface BalanceCurrency {
+    /** Currency symbol */
+    symbol: string;
+    /** Decimal places */
+    decimalPlaces: number;
+    /** Whether currency is active */
+    isActive: boolean;
+    /** Short name */
+    shortName: string;
+    /** Long name */
+    longName: string;
+    /** Supported withdraw decimal places */
+    supportedWithdrawDecimalPlaces: number;
+    /** Whether currency can be used as collateral */
+    collateral: boolean;
+    /** Collateral weight */
+    collateralWeight: string;
+}
+/**
+ * Balance update data
+ */
+interface BalanceUpdateData {
+    /** Currency info */
+    currency: BalanceCurrency;
     /** Available balance */
     available: string;
     /** Reserved balance */
     reserved: string;
     /** Total balance */
     total: string;
+    /** When balance was updated */
+    updatedAt: ISOTimestamp;
+    /** Lend reserved amount */
+    lendReserved: string;
+    /** Borrow collateral reserved */
+    borrowCollateralReserved: string;
+    /** Borrowed amount */
+    borrowedAmount: string;
+    /** Total in reference currency */
+    totalInReference: string;
+    /** Total in reference currency weighted */
+    totalInReferenceWeighted: string;
+    /** Reference currency */
+    referenceCurrency: string;
+}
+/**
+ * Balance update (WebSocket)
+ */
+interface BalanceUpdate extends BaseWebSocketMessage {
+    type: 'BALANCE_UPDATE';
+    /** Balance data */
+    data: BalanceUpdateData;
 }
 /**
  * Account trade (WebSocket)
@@ -2538,16 +2579,21 @@ declare class WalletsAPI {
     /**
      * Get crypto deposit history
      *
-     * @param skip - Number of records to skip
-     * @param limit - Maximum number of records to return
+     * @param params - Optional query parameters for filtering
      * @returns Promise resolving to array of deposit history items
      *
      * @example
      * ```typescript
-     * const deposits = await client.wallets.getCryptoDepositHistory(0, 100);
+     * const deposits = await client.wallets.getCryptoDepositHistory({
+     *   skip: 0,
+     *   limit: 100,
+     *   currency: 'BTC',
+     *   startTime: '2025-01-01T00:00:00Z',
+     *   endTime: '2025-01-31T23:59:59Z'
+     * });
      * ```
      */
-    getCryptoDepositHistory(skip?: number, limit?: number): Promise<CryptoDepositHistoryItem[]>;
+    getCryptoDepositHistory(params?: CryptoDepositHistoryParams): Promise<CryptoDepositHistoryItem[]>;
     /**
      * Get whitelisted withdrawal address book
      *
@@ -2577,6 +2623,7 @@ declare class WalletsAPI {
      * Returns withdrawal limits and fees.
      *
      * @param currencyCode - Currency code
+     * @param networkType - Optional network type
      * @returns Promise resolving to withdrawal config info
      *
      * @example
@@ -2585,7 +2632,7 @@ declare class WalletsAPI {
      * console.log('Fee:', config.withdrawalFee);
      * ```
      */
-    getCryptoWithdrawalInfo(currencyCode: CurrencyCode): Promise<WithdrawalConfigInfo>;
+    getCryptoWithdrawalInfo(currencyCode: CurrencyCode, networkType?: string): Promise<WithdrawalConfigInfo>;
     /**
      * Withdraw cryptocurrency
      *
@@ -2750,17 +2797,17 @@ declare class WalletsAPI {
      * Returns which crypto currencies can be auto-bought with the specified fiat currency.
      *
      * @param currencyCode - Fiat currency code
-     * @returns Promise resolving to array of supported auto-buy currencies
+     * @returns Promise resolving to array of supported currency codes
      *
      * @example
      * ```typescript
      * const currencies = await client.wallets.getAutoBuyCurrencies('ZAR');
-     * currencies.forEach(c => {
-     *   console.log(`${c.currencySymbol}: ${c.enabled ? 'enabled' : 'disabled'}`);
+     * currencies.forEach(code => {
+     *   console.log(`Supports auto-buy for: ${code}`);
      * });
      * ```
      */
-    getAutoBuyCurrencies(currencyCode: CurrencyCode): Promise<AutoBuyCurrency[]>;
+    getAutoBuyCurrencies(currencyCode: CurrencyCode): Promise<CurrencyCode[]>;
     /**
      * Withdraw fiat currency
      *
@@ -3264,6 +3311,8 @@ interface WebSocketClientConfig {
     reconnectDelay?: number;
     /** Maximum reconnect attempts (default: Infinity) */
     maxReconnectAttempts?: number;
+    /** Base URL for WS (defaults to wss://api.valr.com) */
+    baseURL?: string;
 }
 /**
  * WebSocket event types
@@ -3283,13 +3332,14 @@ interface WebSocketEvents {
 declare abstract class ValrWebSocketClient<TEvents extends WebSocketEvents = WebSocketEvents> extends EventEmitter<TEvents> {
     protected ws?: WebSocket;
     protected url: string;
+    protected path: string;
     protected config: Required<WebSocketClientConfig>;
     protected reconnectAttempts: number;
     protected reconnectTimer?: NodeJS.Timeout;
     protected isIntentionalClose: boolean;
     protected isConnected: boolean;
     protected isAuthenticated: boolean;
-    constructor(url: string, config?: WebSocketClientConfig);
+    constructor(path: string, config?: WebSocketClientConfig);
     /**
      * Connect to WebSocket
      */
@@ -3310,10 +3360,6 @@ declare abstract class ValrWebSocketClient<TEvents extends WebSocketEvents = Web
      * Handle WebSocket open event
      */
     protected handleOpen(): void;
-    /**
-     * Authenticate WebSocket connection
-     */
-    protected authenticate(): void;
     /**
      * Handle incoming WebSocket message
      */
@@ -3620,11 +3666,12 @@ declare class RequestSigner {
  * Base URL for VALR API
  */
 declare const API_BASE_URL = "https://api.valr.com";
+declare const WS_BASE_URL = "wss://api.valr.com";
 /**
  * WebSocket URLs
  */
-declare const WS_ACCOUNT_URL = "wss://api.valr.com/ws/account";
-declare const WS_TRADE_URL = "wss://api.valr.com/ws/trade";
+declare const WS_ACCOUNT_URL_PATH = "/ws/account";
+declare const WS_TRADE_URL_PATH = "/ws/trade";
 /**
  * API rate limits
  */
@@ -3661,4 +3708,4 @@ declare const HEADERS: {
     readonly RATE_LIMITED: "x-valr-ratelimited";
 };
 
-export { API_BASE_URL, AccountAPI, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyCurrency, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyLeverageSettings, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginStatus, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, PayAPI, type Payment, type PaymentStatus, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL, WS_TRADE_URL, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };
+export { API_BASE_URL, AccountAPI, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoDepositHistoryParams, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyLeverageSettings, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginStatus, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, PayAPI, type Payment, type PaymentStatus, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL_PATH, WS_BASE_URL, WS_TRADE_URL_PATH, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };