@0xmonaco/types 0.8.16 → 0.8.18

package/dist/fees/index.d.ts

@@ -4,7 +4,7 @@
  * Types for fees operations including fee simulation.
  */
 import type { BaseAPI } from "../api/index";
-import type { SimulateFeeParams, SimulateFeeResponse } from "./responses";
+import type { GetMyFeeTierParams, GetMyFeeTierResponse, SimulateFeeParams, SimulateFeeResponse } from "./responses";
 /**
  * Fees API interface.
  * Provides methods for simulating and calculating trading fees.
@@ -34,6 +34,28 @@ export interface FeesAPI extends BaseAPI {
      * ```
      */
     simulateFees(params: SimulateFeeParams): Promise<SimulateFeeResponse>;
+    /**
+     * Get the caller's current fee tier, rolling 14-day volumes, and a pair's schedule.
+     *
+     * Returns the caller's resolved tier (1–6) and weighted 14-day volume (with the
+     * spot/perp breakdown), the volume still needed to reach the next tier, and the
+     * requested pair's six-row fee schedule (threshold plus maker/taker bps).
+     *
+     * @param params - Parameters for the lookup
+     * @param params.tradingPairId - Trading pair whose fee schedule to return
+     * @returns Promise resolving to the caller's tier and the pair's schedule
+     *
+     * @example
+     * ```typescript
+     * const tier = await feesAPI.getMyFeeTier({
+     *   tradingPairId: "123e4567-e89b-12d3-a456-426614174000",
+     * });
+     * console.log(`Current tier: ${tier.currentTierLevel}`);
+     * console.log(`14d volume: ${tier.weightedVolume14d}`);
+     * console.log(`To next tier: ${tier.volumeToNextTier ?? "already at top tier"}`);
+     * ```
+     */
+    getMyFeeTier(params: GetMyFeeTierParams): Promise<GetMyFeeTierResponse>;
 }
-export type { SimulateFeeParams, SimulateFeeResponse } from "./responses";
-export { SimulateFeeParamsSchema, SimulateFeeResponseSchema } from "./responses";
+export type { FeeTierScheduleRow, GetMyFeeTierParams, GetMyFeeTierResponse, SimulateFeeParams, SimulateFeeResponse, } from "./responses";
+export { FeeTierScheduleRowSchema, GetMyFeeTierParamsSchema, GetMyFeeTierResponseSchema, SimulateFeeParamsSchema, SimulateFeeResponseSchema, } from "./responses";

package/dist/fees/index.js

@@ -3,4 +3,4 @@
  *
  * Types for fees operations including fee simulation.
  */
-export { SimulateFeeParamsSchema, SimulateFeeResponseSchema } from "./responses";
+export { FeeTierScheduleRowSchema, GetMyFeeTierParamsSchema, GetMyFeeTierResponseSchema, SimulateFeeParamsSchema, SimulateFeeResponseSchema, } from "./responses";

package/dist/fees/responses.d.ts

@@ -52,3 +52,50 @@ export type SimulateFeeParams = z.infer<typeof SimulateFeeParamsSchema>;
  * @remarks Type is inferred from SimulateFeeResponseSchema
  */
 export type SimulateFeeResponse = z.infer<typeof SimulateFeeResponseSchema>;
+/**
+ * Zod schema for the parameters of a "my fee tier" lookup
+ */
+export declare const GetMyFeeTierParamsSchema: z.ZodObject<{
+    tradingPairId: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Zod schema for one row of a pair's fee-tier schedule
+ */
+export declare const FeeTierScheduleRowSchema: z.ZodObject<{
+    tierLevel: z.ZodNumber;
+    minVolumeThreshold: z.ZodString;
+    makerFeeBps: z.ZodString;
+    takerFeeBps: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Zod schema for the "my fee tier" response
+ */
+export declare const GetMyFeeTierResponseSchema: z.ZodObject<{
+    currentTierLevel: z.ZodNumber;
+    weightedVolume14d: z.ZodString;
+    spotVolume14d: z.ZodString;
+    perpVolume14d: z.ZodString;
+    volumeToNextTier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    nextTierLevel: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    feeSchedule: z.ZodArray<z.ZodObject<{
+        tierLevel: z.ZodNumber;
+        minVolumeThreshold: z.ZodString;
+        makerFeeBps: z.ZodString;
+        takerFeeBps: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Parameters for a "my fee tier" lookup
+ * @remarks Type is inferred from GetMyFeeTierParamsSchema
+ */
+export type GetMyFeeTierParams = z.infer<typeof GetMyFeeTierParamsSchema>;
+/**
+ * One row of a pair's fee-tier schedule
+ * @remarks Type is inferred from FeeTierScheduleRowSchema
+ */
+export type FeeTierScheduleRow = z.infer<typeof FeeTierScheduleRowSchema>;
+/**
+ * The caller's current fee tier, rolling 14-day volumes, and a pair's schedule
+ * @remarks Type is inferred from GetMyFeeTierResponseSchema
+ */
+export type GetMyFeeTierResponse = z.infer<typeof GetMyFeeTierResponseSchema>;

package/dist/fees/responses.js

@@ -84,3 +84,42 @@ export const SimulateFeeResponseSchema = z.object({
     /** Slippage tolerance used in the calculation, echoed back for MARKET orders (null for LIMIT orders) */
     slippageToleranceBps: z.number().nullable(),
 });
+/**
+ * Zod schema for the parameters of a "my fee tier" lookup
+ */
+export const GetMyFeeTierParamsSchema = z.object({
+    /** Trading pair ID whose six-row fee schedule to return */
+    tradingPairId: z.string().trim().min(1, "Trading pair ID is required and cannot be empty"),
+});
+/**
+ * Zod schema for one row of a pair's fee-tier schedule
+ */
+export const FeeTierScheduleRowSchema = z.object({
+    /** Tier level, 1 (lowest volume) through 6 (highest) */
+    tierLevel: z.number().int(),
+    /** Weighted 14-day volume floor for this tier, in quote/USD units */
+    minVolumeThreshold: z.string(),
+    /** Maker fee in human basis points; negative is a rebate */
+    makerFeeBps: z.string(),
+    /** Taker fee in human basis points */
+    takerFeeBps: z.string(),
+});
+/**
+ * Zod schema for the "my fee tier" response
+ */
+export const GetMyFeeTierResponseSchema = z.object({
+    /** Caller's resolved tier (1–6) from stored weighted 14-day volume */
+    currentTierLevel: z.number().int(),
+    /** Caller's weighted 14-day volume (perp + 2.5× spot) */
+    weightedVolume14d: z.string(),
+    /** Caller's rolling 14-day spot volume */
+    spotVolume14d: z.string(),
+    /** Caller's rolling 14-day perp volume */
+    perpVolume14d: z.string(),
+    /** Additional weighted volume needed to reach the next tier; absent at tier 6 */
+    volumeToNextTier: z.string().nullable().optional(),
+    /** Next tier level; absent when already at tier 6 */
+    nextTierLevel: z.number().int().nullable().optional(),
+    /** Six-row fee schedule for the requested pair, ascending by tier */
+    feeSchedule: z.array(FeeTierScheduleRowSchema),
+});

package/dist/wire/operations.d.ts

@@ -10,6 +10,6 @@
  * hand-written SDK surface. CI regenerates it and fails on a diff, identical to
  * the `schema.ts` wire-types tripwire (MON-1476), so it can never go stale.
  */
-export declare const OPERATION_IDS: readonly ["add_position_margin", "attach_position_tp_sl", "authenticate_backend", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_close_all_positions", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "close_position", "create_challenge", "create_delegated_session", "create_order", "create_sub_account_limit", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_candles", "get_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_parent_margin_account_movements", "get_parent_margin_account_summary", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_chart", "get_portfolio_stats", "get_position", "get_position_risk", "get_screener", "get_sub_account_limits", "get_trade_by_id", "get_trades", "get_trading_pair_by_id", "get_user_balance_by_asset", "get_user_balances", "get_user_movements", "get_user_profile", "get_user_trades", "get_withdrawal", "health_check", "initiate_withdrawal", "list_application_balances", "list_application_movements", "list_application_orders", "list_application_users", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_funding_history", "list_funding_payments", "list_margin_accounts", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "mint_tokens", "reduce_position_margin", "refresh_session", "replace_order", "revoke_delegated_agent", "revoke_session", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "submit_whitelist", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "update_sub_account_limit", "upsert_delegated_agent", "verify_signature"];
+export declare const OPERATION_IDS: readonly ["add_position_margin", "attach_position_tp_sl", "authenticate_backend", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_close_all_positions", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "close_position", "create_challenge", "create_delegated_session", "create_order", "create_sub_account_limit", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_candles", "get_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_parent_margin_account_movements", "get_parent_margin_account_summary", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_chart", "get_portfolio_stats", "get_position", "get_position_risk", "get_screener", "get_sub_account_limits", "get_trade_by_id", "get_trades", "get_trading_pair_by_id", "get_user_balance_by_asset", "get_user_balances", "get_user_movements", "get_user_profile", "get_user_trades", "get_withdrawal", "health_check", "initiate_withdrawal", "list_application_balances", "list_application_movements", "list_application_orders", "list_application_users", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_funding_history", "list_funding_payments", "list_margin_accounts", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "mint_tokens", "reduce_position_margin", "refresh_session", "replace_order", "revoke_delegated_agent", "revoke_session", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "submit_whitelist", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "update_sub_account_limit", "upsert_delegated_agent", "verify_signature"];
 /** Union of every OpenAPI operationId in the spec. */
 export type OperationId = (typeof OPERATION_IDS)[number];

package/dist/wire/operations.js

@@ -39,6 +39,7 @@ export const OPERATION_IDS = [
     "get_mark_price",
     "get_market_metadata",
     "get_market_stats",
+    "get_my_fee_tier",
     "get_open_interest",
     "get_order_by_id",
     "get_orderbook_snapshot",

package/dist/wire/schema.d.ts

@@ -704,6 +704,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/fees/tier": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get my fee tier and pair schedule
+         * @description Return the caller's current fee tier, rolling 14-day volumes, and a pair's schedule.
+         */
+        get: operations["get_my_fee_tier"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/margin/accounts": {
         parameters: {
             query?: never;
@@ -2884,6 +2904,29 @@ export interface components {
              */
             error?: string | null;
         };
+        FeeTierScheduleRow: {
+            /**
+             * Format: int32
+             * @description Tier level 1 (lowest volume) through 6 (highest)
+             * @example 1
+             */
+            tierLevel?: number | null;
+            /**
+             * @description Weighted 14-day volume floor for this tier, in quote/USD units
+             * @example 5000000
+             */
+            minVolumeThreshold?: string | null;
+            /**
+             * @description Maker fee in human basis points; negative is a rebate
+             * @example -1.15
+             */
+            makerFeeBps?: string | null;
+            /**
+             * @description Taker fee in human basis points
+             * @example 6.5
+             */
+            takerFeeBps?: string | null;
+        };
         FundingPaymentRecord: {
             /**
              * Format: uuid
@@ -3292,6 +3335,42 @@ export interface components {
              */
             totalPages?: number | null;
         };
+        GetMyFeeTierResponse: {
+            /**
+             * Format: int32
+             * @description Caller's resolved tier (1–6) from stored weighted 14-day volume
+             * @example 2
+             */
+            currentTierLevel?: number | null;
+            /**
+             * @description Caller's weighted 14-day volume (perp + 2.5× spot)
+             * @example 7500000
+             */
+            weightedVolume14d?: string | null;
+            /**
+             * @description Caller's rolling 14-day spot volume
+             * @example 1000000
+             */
+            spotVolume14d?: string | null;
+            /**
+             * @description Caller's rolling 14-day perp volume
+             * @example 5000000
+             */
+            perpVolume14d?: string | null;
+            /**
+             * @description Additional weighted volume needed to reach the next tier; omitted at tier 6
+             * @example 17500000
+             */
+            volumeToNextTier?: string | null;
+            /**
+             * Format: int32
+             * @description Next tier level when not already at 6
+             * @example 3
+             */
+            nextTierLevel?: number | null;
+            /** @description Six-row fee schedule for the requested pair, ascending by tier */
+            feeSchedule?: components["schemas"]["FeeTierScheduleRow"][] | null;
+        };
         /** @description Latest public open interest for a trading pair. */
         GetOpenInterestResponse: {
             /**
@@ -7013,6 +7092,57 @@ export interface operations {
             };
         };
     };
+    get_my_fee_tier: {
+        parameters: {
+            query?: {
+                /** @description Trading pair identifier (UUID) */
+                tradingPairId?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetMyFeeTierResponse"];
+                };
+            };
+            /** @description Bad request (invalid trading pair id) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Trading pair or fee schedule not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     list_margin_accounts: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/types",
-	"version": "0.8.16",
+	"version": "0.8.18",
 	"type": "module",
 	"repository": {
 		"type": "git",
@@ -20,7 +20,7 @@
 		"lint": "biome lint ."
 	},
 	"dependencies": {
-		"@0xmonaco/contracts": "0.8.16",
+		"@0xmonaco/contracts": "0.8.18",
 		"zod": "^4.1.12"
 	},
 	"peerDependencies": {