@0xmonaco/types 0.8.7-develop.0e951a5 → 0.8.7-develop.0f12336

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,39 +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;
+    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) */
+    minLeverage?: string | null;
+    /** Maximum supported leverage for margin markets (optional, margin only) */
+    maxLeverage?: string | null;
 }
 /**
  * OHLCV candlestick data point (matches API response format)
@@ -113,31 +121,106 @@ 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;
+    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
+ */
+export interface GetScreenerParams {
+    /** Page number (min 1, default 1) */
+    page?: number;
+    /** Items per page (min 1, max 100, default 50) */
+    pageSize?: number;
+    /** Filter by market type: SPOT or MARGIN */
+    marketType?: TradingMode;
+    /** Filter by active status */
+    isActive?: boolean;
+    /** Filter by asset-class category (crypto, equities, commodities, fx) */
+    category?: string;
+}
+/**
+ * One UTC-day bucket in a pair's 7-day screener snapshot
+ */
+export interface ScreenerSnapshotPoint {
+    /** UTC day boundary (ms since epoch, as string) */
+    bucketStart: string;
+    /** Quote-token volume for the day */
+    quoteVolume: string;
+    /** Percent price change (close - open) / open * 100 for the day */
+    priceChangePercent: string;
+}
+/**
+ * Per-pair screener row. Window fields are null when there is insufficient history.
+ */
+export interface ScreenerItem {
+    /** Trading pair UUID */
+    tradingPairId: string;
+    /** Trading pair symbol (e.g. "BTC/USDC") */
+    symbol: string;
+    /** Base token icon URL */
+    baseIconUrl: string;
+    /** Quote token icon URL */
+    quoteIconUrl: string;
+    /** Most recent close price (null if no trades yet) */
+    lastPrice: string | null;
+    /** Timestamp of the last candle (ms since epoch, as string; null if no trades yet) */
+    lastPriceTimestamp: string | null;
+    /** Quote-token volume in the last 1 hour (null if <1h history) */
+    quoteVolume1h: string | null;
+    /** Quote-token volume in the last 24 hours (null if <24h history) */
+    quoteVolume24h: string | null;
+    /** Quote-token volume in the last 7 days (null if <7d history) */
+    quoteVolume7d: string | null;
+    /** Percent price change over the last 1 hour (null if <1h history) */
+    priceChangePercent1h: string | null;
+    /** Percent price change over the last 24 hours (null if <24h history) */
+    priceChangePercent24h: string | null;
+    /** Percent price change over the last 7 days (null if <7d history) */
+    priceChangePercent7d: string | null;
+    /** Up to 7 UTC-day buckets (oldest first); empty when <1 day of history */
+    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) */
+    totalQuoteVolumeLtd: string;
+    /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
+    totalTradeCountLtd: number;
+}
+/**
+ * Paginated screener response, sorted by quoteVolume24h desc (nulls last)
+ */
+export interface GetScreenerResponse {
+    items: ScreenerItem[];
+    page: number;
+    pageSize: number;
+    total: number;
+    totalPages: number;
 }
 /**
  * API response wrapper for single trading pair
@@ -152,117 +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) */
+    totalBaseVolumeLtd: string;
+    /** Life-to-date cumulative quote-token volume since inception ("0" if no trades yet) */
+    totalQuoteVolumeLtd: string;
+    /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
+    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 */
+    totalQuoteVolumeLtd: string;
+    /** Life-to-date cumulative number of trades summed across all pairs */
+    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.
@@ -275,12 +372,34 @@ export interface MarketAPI extends BaseAPI {
      * @returns Promise resolving to paginated response with trading pairs
      */
     getPaginatedTradingPairs(params?: GetTradingPairsParams): Promise<GetTradingPairsResponse>;
+    /**
+     * Fetch a single trading pair by its UUID.
+     * @param tradingPairId - Trading pair UUID
+     * @returns Promise resolving to the trading pair
+     * @throws {APIError} If the pair is not found
+     */
+    getTradingPair(tradingPairId: string): Promise<TradingPair>;
     /**
      * 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.
+     * @param params - Optional pagination and filter parameters
+     * @returns Promise resolving to the paginated screener response
+     */
+    getScreener(params?: GetScreenerParams): Promise<GetScreenerResponse>;
+    /**
+     * Fetch exchange-wide life-to-date cumulative statistics across all trading
+     * pairs: total quote-token (notional) volume and total number of trades.
+     * @returns Promise resolving to the global market stats
+     */
+    getMarketStats(): Promise<MarketStats>;
     /**
      * Fetch historical candlestick data for a trading pair.
      *

package/dist/positions/index.d.ts

@@ -3,36 +3,37 @@ import type { OrderType, PositionSide, TimeInForce } from "../trading";
 export type PositionStatus = "OPEN" | "CLOSED" | "LIQUIDATING";
 export type ClosePositionType = "MARKET" | "LIMIT" | "IOC";
 export interface Position {
-    position_id: string;
-    margin_account_id: string;
-    trading_pair_id: string;
+    positionId: string;
+    marginAccountId: string;
+    riskBucketId?: string;
+    tradingPairId: string;
     side: PositionSide;
     size: string;
-    entry_price: string;
-    mark_price: string;
-    index_price?: string;
-    unrealized_pnl: string;
-    realized_pnl: string;
-    isolated_margin: string;
+    entryPrice: string;
+    markPrice: string;
+    indexPrice?: string;
+    unrealizedPnl: string;
+    realizedPnl: string;
+    isolatedMargin: string;
     leverage?: string;
-    maintenance_margin_required: string;
-    initial_margin_required?: string;
-    liquidation_price: string;
+    maintenanceMarginRequired: string;
+    initialMarginRequired?: string;
+    liquidationPrice: string;
     status: PositionStatus;
-    updated_at: string;
+    updatedAt: string;
 }
 export interface ListPositionsParams {
-    margin_account_id?: string;
-    trading_pair_id?: string;
+    marginAccountId?: string;
+    tradingPairId?: string;
     status?: PositionStatus;
     page?: number;
-    page_size?: number;
+    pageSize?: number;
 }
 export interface ListPositionsResponse {
     positions: Position[];
     total: number;
     page: number;
-    page_size: number;
+    pageSize: number;
 }
 export type GetPositionResponse = Position;
 export interface ClosePositionRequest {
@@ -42,21 +43,42 @@ export interface ClosePositionRequest {
     quantity?: string;
 }
 export interface ClosePositionResponse {
-    close_order_id: string;
+    closeOrderId: string;
     status: string;
     message: string;
-    submitted_quantity: string;
+    submittedQuantity: string;
+}
+export interface BatchCloseAllRequest {
+    tradingPairId?: string;
+    slippageToleranceBps?: number;
+}
+export interface BatchCloseError {
+    code: string;
+    message: string;
+}
+export interface BatchCloseResult {
+    positionId: string;
+    closeOrderId?: string;
+    status?: string;
+    submittedQuantity?: string;
+    error?: BatchCloseError;
+}
+export interface BatchCloseAllResponse {
+    totalRequested: number;
+    totalClosed: number;
+    totalFailed: number;
+    results: BatchCloseResult[];
 }
 export interface PositionRisk {
-    position_id: string;
-    mark_price: string;
-    index_price?: string;
-    unrealized_pnl: string;
-    liquidation_price: string;
-    margin_ratio: string;
-    maintenance_margin_required: string;
-    initial_margin_required?: string;
-    updated_at: string;
+    positionId: string;
+    markPrice: string;
+    indexPrice?: string;
+    unrealizedPnl: string;
+    liquidationPrice: string;
+    marginRatio: string;
+    maintenanceMarginRequired: string;
+    initialMarginRequired?: string;
+    updatedAt: string;
 }
 export interface AddPositionMarginRequest {
     amount: string;
@@ -66,9 +88,9 @@ export interface ReducePositionMarginRequest {
     amount: string;
 }
 export interface PositionMarginResponse {
-    position_id: string;
-    margin_account_id: string;
-    new_isolated_margin: string;
+    positionId: string;
+    marginAccountId: string;
+    newIsolatedMargin: string;
     status: string;
     message: string;
 }
@@ -86,40 +108,41 @@ export interface AttachPositionTpSlRequest {
     stopLoss?: TpSlLeg;
 }
 export interface AttachPositionTpSlResponse {
-    position_id: string;
-    take_profit_order_id?: string;
-    stop_loss_order_id?: string;
+    positionId: string;
+    takeProfitOrderId?: string;
+    stopLossOrderId?: string;
     status: "SUCCESS" | "FAILED";
     message: string;
 }
 export interface ListPositionHistoryParams {
-    position_id?: string;
-    margin_account_id?: string;
-    trading_pair_id?: string;
+    positionId?: string;
+    marginAccountId?: string;
+    tradingPairId?: string;
     page?: number;
-    page_size?: number;
+    pageSize?: number;
 }
 export interface PositionHistoryEvent {
     event_id: string;
-    position_id?: string;
-    margin_account_id?: string;
-    trading_pair_id?: string;
-    event_type: string;
+    positionId?: string;
+    marginAccountId?: string;
+    tradingPairId?: string;
+    eventType: string;
     quantity?: string;
     price?: string;
-    realized_pnl?: string;
+    realizedPnl?: string;
     timestamp: string;
 }
 export interface ListPositionHistoryResponse {
     events: PositionHistoryEvent[];
     total: number;
     page: number;
-    page_size: number;
+    pageSize: number;
 }
 export interface PositionsAPI extends BaseAPI {
     listPositions(params?: ListPositionsParams): Promise<ListPositionsResponse>;
     getPosition(positionId: string): Promise<GetPositionResponse>;
     closePosition(positionId: string, request: ClosePositionRequest): Promise<ClosePositionResponse>;
+    batchCloseAllPositions(request?: BatchCloseAllRequest): Promise<BatchCloseAllResponse>;
     getPositionRisk(positionId: string): Promise<PositionRisk>;
     addPositionMargin(positionId: string, request: AddPositionMarginRequest): Promise<PositionMarginResponse>;
     reducePositionMargin(positionId: string, request: ReducePositionMarginRequest): Promise<PositionMarginResponse>;