@0xmonaco/types 0.8.11 → 0.8.15

package/dist/margin-accounts/index.d.ts

@@ -1,26 +1,26 @@
 import type { BaseAPI } from "../api";
 import type { OrderSide, OrderType, PositionSide } from "../trading";
 export interface MarginAccountSummary {
-    margin_account_id: string;
+    marginAccountId: string;
     label?: string;
-    margin_bucket_id?: string;
-    margin_mode?: "ISOLATED" | "CROSS";
-    trading_pair_id?: string;
-    strategy_key?: string;
-    account_state: string;
+    riskBucketId?: string;
+    marginMode?: "ISOLATED" | "CROSS";
+    tradingPairId?: string;
+    strategyKey?: string;
+    accountState: string;
     equity: string;
-    initial_margin_required: string;
-    maintenance_margin_required: string;
-    free_collateral: string;
-    withdrawable_collateral: string;
-    total_position_notional: string;
-    unrealized_pnl: string;
-    realized_pnl: string;
-    updated_at: string;
+    initialMarginRequired: string;
+    maintenanceMarginRequired: string;
+    freeCollateral: string;
+    withdrawableCollateral: string;
+    totalPositionNotional: string;
+    unrealizedPnl: string;
+    realizedPnl: string;
+    updatedAt: string;
 }
 export interface ListMarginAccountsParams {
     page?: number;
-    page_size?: number;
+    pageSize?: number;
     state?: string;
     tradingPairId?: string;
 }
@@ -28,7 +28,7 @@ export interface ListMarginAccountsResponse {
     accounts: MarginAccountSummary[];
     total: number;
     page: number;
-    page_size: number;
+    pageSize: number;
 }
 export interface GetMarginAccountSummaryParams {
     tradingPairId?: string;
@@ -38,16 +38,16 @@ export interface GetAvailableCollateralParams {
 }
 export interface GetAvailableCollateralResponse {
     asset: string;
-    wallet_available: string;
-    wallet_locked: string;
-    margin_transferable?: string;
+    walletAvailable: string;
+    walletLocked: string;
+    marginTransferable?: string;
     /**
      * Free collateral held in the user's parent margin account for this asset
      * (equity minus initial margin required) — collateral already inside margin
      * and available to open new positions or transfer back out. Absent when the
      * user has no margin account yet.
      */
-    margin_available_collateral?: string;
+    marginAvailableCollateral?: string;
 }
 export interface TransferCollateralRequest {
     asset: string;
@@ -55,39 +55,47 @@ export interface TransferCollateralRequest {
     tradingPairId?: string;
     strategyKey?: string;
 }
-export interface TransferCollateralToAutoMarginAccountRequest extends TransferCollateralRequest {
+export interface TransferCollateralToParentMarginAccountRequest {
+    asset: string;
+    amount: string;
+}
+export interface TransferCollateralToRiskBucketRequest extends TransferCollateralToParentMarginAccountRequest {
     tradingPairId: string;
     strategyKey?: string;
 }
+export interface TransferCollateralFromParentMarginAccountRequest {
+    asset: string;
+    amount: string;
+}
 export interface TransferCollateralResponse {
-    movement_id: string;
-    margin_account_id: string;
-    strategy_key?: string;
+    movementId: string;
+    marginAccountId: string;
+    strategyKey?: string;
     asset: string;
     amount: string;
     status: string;
-    new_equity: string;
-    new_total_collateral_value: string;
-    new_withdrawable_collateral: string;
+    newEquity: string;
+    newTotalCollateralValue: string;
+    newWithdrawableCollateral: string;
 }
 export interface GetMarginAccountMovementsParams {
-    movement_type?: string;
+    movementType?: string;
     page?: number;
-    page_size?: number;
+    pageSize?: number;
 }
 export interface MarginAccountMovement {
-    movement_id: string;
-    margin_account_id: string;
-    movement_type: string;
+    movementId: string;
+    marginAccountId: string;
+    movementType: string;
     asset: string;
     amount: string;
-    created_at: string;
+    createdAt: string;
 }
 export interface GetMarginAccountMovementsResponse {
     movements: MarginAccountMovement[];
     total: number;
     page: number;
-    page_size: number;
+    pageSize: number;
 }
 export interface SimulateOrderRiskRequest {
     tradingPairId: string;
@@ -99,29 +107,53 @@ export interface SimulateOrderRiskRequest {
     leverage: string;
     reduceOnly?: boolean;
 }
-export interface SimulateAutoMarginOrderRiskRequest extends SimulateOrderRiskRequest {
+export interface SimulateRiskBucketOrderRiskRequest extends SimulateOrderRiskRequest {
     strategyKey?: string;
 }
 export interface SimulateOrderRiskResponse {
     accepted: boolean;
-    reject_reason?: string;
-    margin_account_id: string;
-    strategy_key?: string;
-    equity_after: string;
-    initial_margin_required_after: string;
-    maintenance_margin_required_after: string;
-    free_collateral_after: string;
-    estimated_fee?: string;
-    estimated_liquidation_price?: string;
+    rejectReason?: string;
+    marginAccountId: string;
+    strategyKey?: string;
+    equityAfter: string;
+    initialMarginRequiredAfter: string;
+    maintenanceMarginRequiredAfter: string;
+    freeCollateralAfter: string;
+    estimatedFee?: string;
+    estimatedLiquidationPrice?: string;
 }
 export interface MarginAccountsAPI extends BaseAPI {
     listMarginAccounts(params?: ListMarginAccountsParams): Promise<ListMarginAccountsResponse>;
+    getParentMarginAccountSummary(params?: GetMarginAccountSummaryParams): Promise<MarginAccountSummary>;
+    /**
+     * @deprecated Prefer getParentMarginAccountSummary(). Parent margin account ids
+     * are auto-resolved for the authenticated wallet/application scope.
+     */
     getMarginAccountSummary(marginAccountId: string, params?: GetMarginAccountSummaryParams): Promise<MarginAccountSummary>;
     getAvailableCollateral(params?: GetAvailableCollateralParams): Promise<GetAvailableCollateralResponse>;
+    /**
+     * @deprecated Prefer transferCollateralToParentMarginAccount() or
+     * transferCollateralToRiskBucket().
+     */
     transferCollateralToMarginAccount(marginAccountId: string, request: TransferCollateralRequest): Promise<TransferCollateralResponse>;
-    transferCollateralToAutoMarginAccount(request: TransferCollateralToAutoMarginAccountRequest): Promise<TransferCollateralResponse>;
+    transferCollateralToParentMarginAccount(request: TransferCollateralToParentMarginAccountRequest): Promise<TransferCollateralResponse>;
+    transferCollateralToRiskBucket(request: TransferCollateralToRiskBucketRequest): Promise<TransferCollateralResponse>;
+    /**
+     * @deprecated Prefer transferCollateralFromParentMarginAccount().
+     */
     transferCollateralFromMarginAccount(marginAccountId: string, request: TransferCollateralRequest): Promise<TransferCollateralResponse>;
+    transferCollateralFromParentMarginAccount(request: TransferCollateralFromParentMarginAccountRequest): Promise<TransferCollateralResponse>;
+    getParentMarginAccountMovements(params?: GetMarginAccountMovementsParams): Promise<GetMarginAccountMovementsResponse>;
+    /**
+     * @deprecated Prefer getParentMarginAccountMovements(). Parent margin account ids
+     * are auto-resolved for the authenticated wallet/application scope.
+     */
     getMarginAccountMovements(marginAccountId: string, params?: GetMarginAccountMovementsParams): Promise<GetMarginAccountMovementsResponse>;
+    simulateParentMarginOrderRisk(request: SimulateOrderRiskRequest): Promise<SimulateOrderRiskResponse>;
+    /**
+     * @deprecated Prefer simulateParentMarginOrderRisk(). Parent margin account ids
+     * are auto-resolved for the authenticated wallet/application scope.
+     */
     simulateOrderRisk(marginAccountId: string, request: SimulateOrderRiskRequest): Promise<SimulateOrderRiskResponse>;
-    simulateAutoMarginOrderRisk(request: SimulateAutoMarginOrderRiskRequest): Promise<SimulateOrderRiskResponse>;
+    simulateRiskBucketOrderRisk(request: SimulateRiskBucketOrderRiskRequest): Promise<SimulateOrderRiskResponse>;
 }

package/dist/market/index.d.ts

@@ -3,7 +3,9 @@
  *
  * Types for market data operations including trading pair metadata and OHLCV data.
  */
+import type { Address } from "viem";
 import type { BaseAPI } from "../api";
+import type { TradingMode } from "../trading";
 /**
  * Trading pair metadata
  */
@@ -13,45 +15,45 @@ export interface TradingPair {
     /** Trading pair symbol e.g. BTC/USDC */
     symbol: string;
     /** Base token symbol */
-    base_token: string;
+    baseToken: string;
     /** Quote token symbol */
-    quote_token: string;
+    quoteToken: string;
     /** Base asset ID (UUID) */
-    base_asset_id: string;
+    baseAssetId: string;
     /** Quote asset ID (UUID) */
-    quote_asset_id: string;
+    quoteAssetId: string;
     /** Base token contract address */
-    base_token_contract: string;
+    baseTokenContract: Address;
     /** Quote token contract address */
-    quote_token_contract: string;
+    quoteTokenContract: Address;
     /** Base token decimals */
-    base_decimals: number;
+    baseDecimals: number;
     /** Base token icon URL */
-    base_icon_url: string;
+    baseIconUrl: string;
     /** Quote token decimals */
-    quote_decimals: number;
+    quoteDecimals: number;
     /** Quote token icon URL */
-    quote_icon_url: string;
-    /** Market type (e.g. SPOT) */
-    market_type: string;
-    /** Asset-class category: crypto, equities, or commodities */
+    quoteIconUrl: string;
+    /** Market type (SPOT or MARGIN) */
+    marketType: TradingMode;
+    /** Asset-class category: crypto, equities, commodities, or fx */
     category: string;
     /** Whether the market is active */
-    is_active: boolean;
+    isActive: boolean;
     /** Maker fee in basis points */
-    maker_fee_bps: number;
+    makerFeeBps: number;
     /** Taker fee in basis points */
-    taker_fee_bps: number;
+    takerFeeBps: number;
     /** Minimum order size */
-    min_order_size: string;
+    minOrderSize: string;
     /** Maximum order size */
-    max_order_size: string;
+    maxOrderSize: string;
     /** Tick size for price increments */
-    tick_size: string;
+    tickSize: string;
     /** Minimum supported leverage for margin markets (optional, margin only) */
-    min_leverage?: string | null;
+    minLeverage?: string | null;
     /** Maximum supported leverage for margin markets (optional, margin only) */
-    max_leverage?: string | null;
+    maxLeverage?: string | null;
 }
 /**
  * OHLCV candlestick data point (matches API response format)
@@ -119,33 +121,33 @@ export interface GetTradingPairsParams {
     /** Page number (starts from 1) */
     page?: number;
     /** Number of items per page (max 100) */
-    page_size?: number;
+    pageSize?: number;
     /** Filter by market type (SPOT, MARGIN) */
-    market_type?: string;
+    marketType?: TradingMode;
     /** Filter by base token symbol */
-    base_token?: string;
+    baseToken?: string;
     /** Filter by quote token symbol */
-    quote_token?: string;
+    quoteToken?: string;
     /** Filter by active status */
-    is_active?: boolean;
-    /** Filter by asset-class category (crypto, equities, commodities) */
+    isActive?: boolean;
+    /** Filter by asset-class category (crypto, equities, commodities, fx) */
     category?: string;
 }
 /**
  * Response for listing trading pairs with pagination
  */
 export interface GetTradingPairsResponse {
-    trading_pairs: TradingPair[];
+    tradingPairs: TradingPair[];
     page: number;
-    page_size: number;
+    pageSize: number;
     total: number;
-    total_pages: number;
+    totalPages: number;
 }
 /**
  * Response for a single trading pair
  */
 export interface GetTradingPairResponse {
-    trading_pair: TradingPair;
+    tradingPair: TradingPair;
 }
 /**
  * Query parameters for the market screener
@@ -154,12 +156,12 @@ export interface GetScreenerParams {
     /** Page number (min 1, default 1) */
     page?: number;
     /** Items per page (min 1, max 100, default 50) */
-    page_size?: number;
+    pageSize?: number;
     /** Filter by market type: SPOT or MARGIN */
-    market_type?: string;
+    marketType?: TradingMode;
     /** Filter by active status */
-    is_active?: boolean;
-    /** Filter by asset-class category (crypto, equities, commodities) */
+    isActive?: boolean;
+    /** Filter by asset-class category (crypto, equities, commodities, fx) */
     category?: string;
 }
 /**
@@ -167,58 +169,58 @@ export interface GetScreenerParams {
  */
 export interface ScreenerSnapshotPoint {
     /** UTC day boundary (ms since epoch, as string) */
-    bucket_start: string;
+    bucketStart: string;
     /** Quote-token volume for the day */
-    quote_volume: string;
+    quoteVolume: string;
     /** Percent price change (close - open) / open * 100 for the day */
-    price_change_percent: string;
+    priceChangePercent: string;
 }
 /**
  * Per-pair screener row. Window fields are null when there is insufficient history.
  */
 export interface ScreenerItem {
     /** Trading pair UUID */
-    trading_pair_id: string;
+    tradingPairId: string;
     /** Trading pair symbol (e.g. "BTC/USDC") */
     symbol: string;
     /** Base token icon URL */
-    base_icon_url: string;
+    baseIconUrl: string;
     /** Quote token icon URL */
-    quote_icon_url: string;
+    quoteIconUrl: string;
     /** Most recent close price (null if no trades yet) */
-    last_price: string | null;
+    lastPrice: string | null;
     /** Timestamp of the last candle (ms since epoch, as string; null if no trades yet) */
-    last_price_timestamp: string | null;
+    lastPriceTimestamp: string | null;
     /** Quote-token volume in the last 1 hour (null if <1h history) */
-    quote_volume_1h: string | null;
+    quoteVolume1h: string | null;
     /** Quote-token volume in the last 24 hours (null if <24h history) */
-    quote_volume_24h: string | null;
+    quoteVolume24h: string | null;
     /** Quote-token volume in the last 7 days (null if <7d history) */
-    quote_volume_7d: string | null;
+    quoteVolume7d: string | null;
     /** Percent price change over the last 1 hour (null if <1h history) */
-    price_change_percent_1h: string | null;
+    priceChangePercent1h: string | null;
     /** Percent price change over the last 24 hours (null if <24h history) */
-    price_change_percent_24h: string | null;
+    priceChangePercent24h: string | null;
     /** Percent price change over the last 7 days (null if <7d history) */
-    price_change_percent_7d: string | null;
+    priceChangePercent7d: string | null;
     /** Up to 7 UTC-day buckets (oldest first); empty when <1 day of history */
-    snapshot_7d: ScreenerSnapshotPoint[];
-    /** Asset-class category: crypto, equities, or commodities */
+    snapshot7d: ScreenerSnapshotPoint[];
+    /** Asset-class category: crypto, equities, commodities, or fx */
     category: string;
     /** Life-to-date cumulative quote-token volume since inception ("0" if no trades yet) */
-    total_quote_volume_ltd: string;
+    totalQuoteVolumeLtd: string;
     /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
-    total_trade_count_ltd: number;
+    totalTradeCountLtd: number;
 }
 /**
- * Paginated screener response, sorted by quote_volume_24h desc (nulls last)
+ * Paginated screener response, sorted by quoteVolume24h desc (nulls last)
  */
 export interface GetScreenerResponse {
     items: ScreenerItem[];
     page: number;
-    page_size: number;
+    pageSize: number;
     total: number;
-    total_pages: number;
+    totalPages: number;
 }
 /**
  * API response wrapper for single trading pair
@@ -233,132 +235,131 @@ export interface MarketMetadata {
     /** Trading pair symbol (e.g., "BTC/USDC") */
     symbol: string;
     /** Base token icon URL */
-    base_icon_url: string;
+    baseIconUrl: string;
     /** Quote token icon URL */
-    quote_icon_url: string;
+    quoteIconUrl: string;
     /** Current price (8 decimal precision, null if no trades yet) */
-    last_price: string | null;
+    lastPrice: string | null;
     /** Unix timestamp (ms) of latest price (null if no trades yet) */
-    last_price_timestamp: number | null;
+    lastPriceTimestamp: number | null;
     /** 24h high price (null if <24h data) */
-    high_24h: string | null;
+    high24h: string | null;
     /** 24h low price (null if <24h data) */
-    low_24h: string | null;
+    low24h: string | null;
     /** 24h volume in base asset (null if <24h data) */
-    volume_24h: string | null;
+    volume24h: string | null;
     /** Absolute price change in 24h (null if <24h data) */
-    price_change_24h: string | null;
+    priceChange24h: string | null;
     /** Percentage price change in 24h (2 decimals, null if <24h data) */
-    price_change_percent_24h: string | null;
+    priceChangePercent24h: string | null;
     /** Unix timestamp (ms) when market started trading (null if not available) */
-    market_initialization_timestamp: number | null;
+    marketInitializationTimestamp: number | null;
     /** Life-to-date cumulative base-token volume since inception ("0" if no trades yet) */
-    total_base_volume_ltd: string;
+    totalBaseVolumeLtd: string;
     /** Life-to-date cumulative quote-token volume since inception ("0" if no trades yet) */
-    total_quote_volume_ltd: string;
+    totalQuoteVolumeLtd: string;
     /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
-    total_trade_count_ltd: number;
+    totalTradeCountLtd: number;
 }
 /**
  * Exchange-wide life-to-date cumulative statistics across all trading pairs.
  */
 export interface MarketStats {
     /** Life-to-date cumulative quote-token (notional) volume summed across all pairs */
-    total_quote_volume_ltd: string;
+    totalQuoteVolumeLtd: string;
     /** Life-to-date cumulative number of trades summed across all pairs */
-    total_trade_count_ltd: number;
+    totalTradeCountLtd: number;
 }
 export interface RiskTier {
     notional_floor: string;
     notional_cap?: string;
-    initial_margin_ratio: string;
-    maintenance_margin_ratio: string;
-    max_leverage: string;
+    initialMarginRatio: string;
+    maintenanceMarginRatio: string;
+    maxLeverage: string;
 }
 export interface PerpMarketConfig {
-    trading_pair_id: string;
+    tradingPairId: string;
     symbol: string;
-    min_leverage: string;
-    max_leverage: string;
-    initial_margin_ratio: string;
-    maintenance_margin_ratio: string;
-    funding_interval_seconds: number;
-    liquidation_fee_bps?: string;
-    risk_tiers: RiskTier[];
-    updated_at: string;
+    minLeverage: string;
+    maxLeverage: string;
+    initialMarginRatio: string;
+    maintenanceMarginRatio: string;
+    fundingIntervalSeconds: number;
+    liquidationFeeBps?: string;
+    riskTiers: RiskTier[];
+    updatedAt: string;
 }
 export interface PerpMarketSummary {
-    trading_pair_id: string;
+    tradingPairId: string;
     symbol: string;
-    last_price: string;
-    mark_price: string;
-    index_price: string;
-    high_24h?: string;
-    low_24h?: string;
-    volume_24h?: string;
-    price_change_24h?: string;
-    price_change_percent_24h?: string;
-    open_interest: string;
-    current_funding_rate?: string;
-    estimated_next_funding_rate?: string;
-    next_funding_time?: string;
-    market_status: string;
-    market_regime: string;
-    updated_at: string;
+    lastPrice: string;
+    markPrice: string;
+    indexPrice: string;
+    high24h?: string;
+    low24h?: string;
+    volume24h?: string;
+    priceChange24h?: string;
+    priceChangePercent24h?: string;
+    openInterest: string;
+    currentFundingRate?: string;
+    estimatedNextFundingRate?: string;
+    nextFundingTime?: string;
+    marketStatus: string;
+    marketRegime: string;
+    updatedAt: string;
 }
 export interface MarkPrice {
-    trading_pair_id: string;
-    mark_price: string;
-    oracle_provider: string;
-    oracle_epoch?: string;
-    updated_at: string;
+    tradingPairId: string;
+    markPrice: string;
+    oracleProvider: string;
+    oracleEpoch?: string;
+    updatedAt: string;
     regime: string;
 }
 export interface IndexComponent {
     provider: string;
     price: string;
     weight?: string;
-    updated_at?: string;
+    updatedAt?: string;
 }
 export interface IndexPrice {
-    trading_pair_id: string;
-    index_price: string;
+    tradingPairId: string;
+    indexPrice: string;
     components: IndexComponent[];
-    updated_at: string;
+    updatedAt: string;
 }
 export interface FundingState {
-    trading_pair_id: string;
-    current_funding_rate: string;
-    estimated_next_funding_rate?: string;
-    next_funding_time: string;
-    funding_interval_seconds: number;
-    last_funding_time?: string;
-    updated_at: string;
+    tradingPairId: string;
+    currentFundingRate: string;
+    estimatedNextFundingRate?: string;
+    nextFundingTime: string;
+    fundingIntervalSeconds: number;
+    lastFundingTime?: string;
+    updatedAt: string;
 }
 export interface FundingRecord {
-    trading_pair_id: string;
-    funding_rate: string;
-    funding_time: string;
-    cumulative_funding_per_unit?: string;
+    tradingPairId: string;
+    fundingRate: string;
+    cumulativeFundingPerUnit?: string;
 }
 export interface ListFundingHistoryParams {
-    start_time?: string;
-    end_time?: string;
+    startTime?: string;
+    endTime?: string;
     page?: number;
-    page_size?: number;
+    pageSize?: number;
 }
 export interface ListFundingHistoryResponse {
     records: FundingRecord[];
     total: number;
     page: number;
-    page_size: number;
+    pageSize: number;
 }
 export interface OpenInterest {
-    trading_pair_id: string;
-    open_interest?: string;
-    open_interest_base: string;
-    open_interest_notional: string;
-    updated_at: string;
+    tradingPairId: string;
+    openInterest?: string;
+    openInterestBase: string;
+    openInterestNotional: string;
+    updatedAt: string;
 }
 /**
  * Market API interface.
@@ -381,9 +382,11 @@ export interface MarketAPI extends BaseAPI {
     /**
      * Fetch metadata for a single trading pair by its symbol (e.g. BTC-USDC).
      * @param symbol - Trading pair symbol
+     * @param marketType - Optional market type filter (e.g. "SPOT", "MARGIN") to
+     *   disambiguate a symbol that exists in more than one market
      * @returns Promise resolving to trading pair or undefined if not found
      */
-    getTradingPairBySymbol(symbol: string): Promise<TradingPair | undefined>;
+    getTradingPairBySymbol(symbol: string, marketType?: TradingMode): Promise<TradingPair | undefined>;
     /**
      * Fetch the paginated market screener: per-pair price/volume/change windows
      * (1h, 24h, 7d) plus a 7-day daily snapshot, sorted by 24h quote volume.