@0xmonaco/types 1.0.51 → 1.0.54

package/dist/wire/schema.d.ts

@@ -2710,7 +2710,7 @@ export interface components {
         };
         BatchCreateError: {
             /**
-             * @description Machine-readable error code
+             * @description Machine-readable error code. ORDER_SUBMISSION_CAPACITY_EXCEEDED refuses a new keyed submission when response-cache capacity is protected by pending durability or persistence. ORDER_SUBMISSION_UNAVAILABLE means the original response is temporarily unavailable or keyed admission is busy; it never authorizes duplicate execution. Retry the same key and payload; the 24-hour limit applies only to previously accepted keys.
              * @example INSUFFICIENT_BALANCE
              */
             code?: string | null;
@@ -2828,6 +2828,8 @@ export interface components {
              * @example quote-btc-1130-a
              */
             clientOrderId?: string | null;
+            /** @description Optional submission identity, distinct from clientOrderId. Use 1-64 characters from [A-Za-z0-9._:-], without whitespace. Scoped to your authenticated user/subaccount and application, shared by create and batch-create items. Retrying the same key and normalized order payload within 24 hours of the original acceptance returns the original committed submission result, even after a fill or cancellation, without executing again. A full response cache does not prevent new keyed submissions: durable responses may be evicted while exact key history remains retained. If response capacity is protected by pending durability or persistence, a new key is refused with ORDER_SUBMISSION_CAPACITY_EXCEEDED. A retry whose original response cannot currently be retrieved returns ORDER_SUBMISSION_UNAVAILABLE and never executes again. Both are HTTP 503 / gRPC UNAVAILABLE, or per-item errors in batches. Retry the same key and payload; for previously accepted keys, stay within 24 hours of the original acceptance. A capacity refusal does not accept or reserve a new key. Different payload returns IDEMPOTENCY_KEY_CONFLICT (HTTP 409 / gRPC ALREADY_EXISTS; per-item error in batches). Validation failures before acceptance do not reserve the key. The window does not extend on retries; after it expires the key may execute a new order, so never retry an unresolved submission after 24 hours. Generate a fresh key for each intended new order and retain it across transport retries. Without a key, a timeout or 5xx leaves the outcome unknown and must not be blindly retried. */
+            idempotencyKey?: string | null;
         };
         BatchCreateOrdersRequest: {
             orders: components["schemas"]["BatchCreateOrderItem"][];
@@ -3340,6 +3342,8 @@ export interface components {
              * @example quote-btc-1130-a
              */
             clientOrderId?: string | null;
+            /** @description Optional submission identity, distinct from clientOrderId. Use 1-64 characters from [A-Za-z0-9._:-], without whitespace. Scoped to your authenticated user/subaccount and application, shared by create and batch-create items. Retrying the same key and normalized order payload within 24 hours of the original acceptance returns the original committed submission result, even after a fill or cancellation, without executing again. A full response cache does not prevent new keyed submissions: durable responses may be evicted while exact key history remains retained. If response capacity is protected by pending durability or persistence, a new key is refused with ORDER_SUBMISSION_CAPACITY_EXCEEDED. A retry whose original response cannot currently be retrieved returns ORDER_SUBMISSION_UNAVAILABLE and never executes again. Both are HTTP 503 / gRPC UNAVAILABLE, or per-item errors in batches. Retry the same key and payload; for previously accepted keys, stay within 24 hours of the original acceptance. A capacity refusal does not accept or reserve a new key. Different payload returns IDEMPOTENCY_KEY_CONFLICT (HTTP 409 / gRPC ALREADY_EXISTS; per-item error in batches). Validation failures before acceptance do not reserve the key. The window does not extend on retries; after it expires the key may execute a new order, so never retry an unresolved submission after 24 hours. Generate a fresh key for each intended new order and retain it across transport retries. Without a key, a timeout or 5xx leaves the outcome unknown and must not be blindly retried. */
+            idempotencyKey?: string | null;
         };
         CreateOrderResponse: {
             /**
@@ -4202,10 +4206,11 @@ export interface components {
              */
             totalQuoteVolumeLtd?: string | null;
             /**
+             * Format: int64
              * @description Life-to-date cumulative number of trades (since market inception); 0 for a pair with no trades yet
              * @example 482931
              */
-            totalTradeCountLtd?: string | null;
+            totalTradeCountLtd?: number | null;
             /**
              * @description Quote-token (notional) volume summed over the available candles in the rolling 24h window; null when quote volume is unavailable for the window
              * @example 117845632.18
@@ -4220,10 +4225,11 @@ export interface components {
              */
             totalQuoteVolumeLtd?: string | null;
             /**
+             * Format: int64
              * @description Life-to-date cumulative number of trades summed across all trading pairs
              * @example 19284736
              */
-            totalTradeCountLtd?: string | null;
+            totalTradeCountLtd?: number | null;
         };
         GetMovementsResponse: {
             movements?: components["schemas"]["LedgerMovement"][] | null;
@@ -4816,10 +4822,22 @@ export interface components {
             unrealizedPnl?: string | null;
             realizedPnl?: string | null;
             /**
-             * @description Open rows: current isolated collateral for this position's risk bucket.
-             *      Terminal rows: total initial margin allocated across the position's
-             *      reducing executions when available — the margin basis for lifetime
-             *      realized return.
+             * @description Open ISOLATED rows: the position's current backing — its risk bucket's
+             *      allocated collateral adjusted by settled realized PnL and funding paid,
+             *      net of collateral reserved for the bucket's open orders, clamped at zero
+             *      (0XM-2558). Partial closes and partial liquidations shrink the posted
+             *      margin pro-rata while the realized loss stays in the bucket, so this,
+             *      not the posted margin, is the unrealized-return denominator. Not a hard
+             *      -100% bound: the liquidation trigger and liquidation_price measure the
+             *      bucket's whole equity, order reserves included, so with a resting order
+             *      the return can pass -100% by that order's earmark before liquidation
+             *      lands; a mark can gap past the backing before the asynchronous
+             *      liquidation; a fully drained bucket serves "0". Served from the live risk
+             *      engine; when only persisted state is reachable the value is gross of
+             *      order reserves. Open CROSS rows fall back to the position's posted
+             *      margin. Terminal rows: total initial margin allocated across the
+             *      position's reducing executions when available — the margin basis for
+             *      lifetime realized return.
              */
             isolatedMargin?: string | null;
             leverage?: string | null;
@@ -6176,6 +6194,33 @@ export interface components {
              *      reconstructable.
              */
             availableOrderCollateral?: string | null;
+            /**
+             * @description The mode this risk bucket is margined under. Always present: every row here is a risk bucket and its mode is a non-null column, unlike MarginAccountSummary.marginMode which is optional because that shape also models a parent row belonging to no bucket. Labels each row so bucket margin can be attributed to cross or isolated from this response alone, instead of resolving the opaque riskBucketId against the margin-accounts surface. It does NOT reconcile with the positions.cross / positions.isolated counts beside it: those are counted by a separate query over every margin account for the caller's user/application pair (these rows come from the single oldest, parent account), and they attribute a legacy position carrying no risk-bucket reference to CROSS whether or not a cross bucket row exists. Treat the counts as account-wide totals, not as a checksum over these rows.
+             * @example CROSS
+             * @enum {string}
+             */
+            marginMode: "ISOLATED" | "CROSS";
+            /**
+             * Format: uuid
+             * @description Trading pair UUID this bucket is scoped to. Present for ISOLATED buckets;
+             *      absent for CROSS, which spans the pairs selected into it and is scoped to
+             *      none of them individually — the same invariant the transfer-in endpoint
+             *      enforces by rejecting a `trading_pair_id` in CROSS mode. Read the cross
+             *      bucket's membership from `MarginAccountSummary.selected_trading_pair_ids`;
+             *      it is not carried here because it lives in a separate table and would cost
+             *      this endpoint an extra query per request.
+             *
+             *      These labels do NOT make this response row-for-row joinable with the
+             *      margin-accounts surface on (mode, pair). That surface emits rows this one
+             *      has no counterpart for — a provisioned-but-unfunded auto bucket, and a
+             *      parent row with no mode at all — and on a persisted-fallback read (no live
+             *      risk engine snapshot) the two surfaces attribute a legacy position
+             *      carrying no risk-bucket reference to OPPOSITE buckets: this endpoint reads
+             *      it as cross, the margin-accounts summary as isolated on pair match. Use
+             *      these fields to label and group this response, not to cross-foot it
+             *      against another.
+             */
+            tradingPairId?: string | null;
         };
         PortfolioSeriesWindow: {
             /**
@@ -6255,10 +6300,22 @@ export interface components {
             unrealizedPnl?: string | null;
             realizedPnl?: string | null;
             /**
-             * @description Open rows: current isolated collateral for this position's risk bucket.
-             *      Terminal rows: total initial margin allocated across the position's
-             *      reducing executions when available — the margin basis for lifetime
-             *      realized return.
+             * @description Open ISOLATED rows: the position's current backing — its risk bucket's
+             *      allocated collateral adjusted by settled realized PnL and funding paid,
+             *      net of collateral reserved for the bucket's open orders, clamped at zero
+             *      (0XM-2558). Partial closes and partial liquidations shrink the posted
+             *      margin pro-rata while the realized loss stays in the bucket, so this,
+             *      not the posted margin, is the unrealized-return denominator. Not a hard
+             *      -100% bound: the liquidation trigger and liquidation_price measure the
+             *      bucket's whole equity, order reserves included, so with a resting order
+             *      the return can pass -100% by that order's earmark before liquidation
+             *      lands; a mark can gap past the backing before the asynchronous
+             *      liquidation; a fully drained bucket serves "0". Served from the live risk
+             *      engine; when only persisted state is reachable the value is gross of
+             *      order reserves. Open CROSS rows fall back to the position's posted
+             *      margin. Terminal rows: total initial margin allocated across the
+             *      position's reducing executions when available — the margin basis for
+             *      lifetime realized return.
              */
             isolatedMargin?: string | null;
             leverage?: string | null;
@@ -6741,10 +6798,11 @@ export interface components {
              */
             totalQuoteVolumeLtd?: string | null;
             /**
+             * Format: int64
              * @description Life-to-date cumulative number of trades (since market inception); 0 for a pair with no trades yet
              * @example 482931
              */
-            totalTradeCountLtd?: string | null;
+            totalTradeCountLtd?: number | null;
             /**
              * @description Latest settled funding rate as a decimal fraction per funding window (the capped settled value); null for spot pairs and margin pairs with no settled funding window yet
              * @example 0.000125
@@ -6909,6 +6967,28 @@ export interface components {
             initialMarginRequiredAfter?: string | null;
             maintenanceMarginRequiredAfter?: string | null;
             freeCollateralAfter?: string | null;
+            /**
+             * @description What this order pays in fees once its WHOLE size has executed, priced by
+             *      the role each part of it plays against the book right now: the taker rate
+             *      (plus the application's additional taker fee) on the quantity that would
+             *      cross immediately, and the maker rate on the quantity that would rest and
+             *      be filled later. Both rates are the caller's own tier-resolved rates. One
+             *      figure covers both cases — an order that crosses entirely, one that rests
+             *      entirely, and every split in between.
+             *
+             *      Signed: NEGATIVE means a net rebate, which is the honest answer for a
+             *      resting order on a pair whose maker fee is negative. Populated even when
+             *      `accepted` is false, and populated for reduce-only orders — closing a
+             *      position pays fees like any other fill.
+             *
+             *      It assumes the resting part eventually fills, so it states what the order
+             *      costs if it runs to completion, not a probability-weighted figure: cancel
+             *      before the remainder fills and only the crossing part was ever charged.
+             *
+             *      ABSENT — never zero — when the engine could not price the order: it was
+             *      refused before it could be matched, or its resolved maker tier exceeds the
+             *      pair's cap. Absence means unknown, so do not render it as a free order.
+             */
             estimatedFee?: string | null;
             /**
              * @description Estimated liquidation mark-price. In ISOLATED mode, this is the
@@ -7387,7 +7467,13 @@ export interface components {
             riskBucketId?: string | null;
             /** @description Present when collateral was allocated to a risk bucket. Values: ISOLATED, CROSS. */
             marginMode?: string | null;
-            /** @description Present for cross risk-bucket transfers. */
+            /**
+             * @description The cross bucket's recorded pair scope: what trading has recorded (a pair
+             *      joins when a cross order on it fills and leaves when its positions close),
+             *      plus any pair declared before scope became derived, until it trades and
+             *      its positions close. Only on cross risk-bucket transfers, and omitted
+             *      while empty — i.e. until a cross order on the bucket has filled.
+             */
             selectedTradingPairIds?: string[] | null;
             /**
              * @description Whether the transfer was committed to a position's stored margin.
@@ -7414,9 +7500,17 @@ export interface components {
              */
             tradingPairId?: string | null;
             strategyKey?: string | null;
-            /** @description Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS. */
+            /**
+             * @description Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS. A CROSS
+             *      transfer names no pairs: the cross bucket's scope is derived from trading —
+             *      a pair joins when a cross order on it succeeds and leaves when its positions
+             *      close — so funding the bucket has nothing to declare.
+             */
             marginMode?: string | null;
-            /** @description Trading pair UUIDs selected into the cross risk bucket. Required when marginMode is CROSS. */
+            /**
+             * @deprecated
+             * @description Deprecated: accepted and ignored. Cross scope is derived from trading (a pair joins the cross bucket when a cross order on it succeeds and leaves when its positions close), so a cross transfer-in has nothing to declare and can no longer replace the scope. Rejected for ISOLATED, as before. Read the current scope from the cross bucket's row in the margin-accounts list or from this response's selectedTradingPairIds; the parent row carries no scope. Pairs declared before scope became derived stay recorded until they trade and their positions close.
+             */
             selectedTradingPairIds?: string[] | null;
             /**
              * @description What the transferred collateral becomes when the ISOLATED bucket holds an
@@ -8071,6 +8165,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Portfolio analytics reader unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     get_portfolio_assets: {
@@ -8165,6 +8266,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Portfolio analytics reader unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     get_portfolio_margin: {
@@ -9832,6 +9940,13 @@ export interface operations {
                     "application/json": components["schemas"]["TransferCollateralToMarginAccountResponse"];
                 };
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     transfer_collateral_from_margin_account: {
@@ -9862,6 +9977,13 @@ export interface operations {
                     "application/json": components["schemas"]["TransferCollateralFromMarginAccountResponse"];
                 };
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     get_margin_account_movements: {
@@ -9993,6 +10115,13 @@ export interface operations {
                     "application/json": components["schemas"]["TransferCollateralToMarginAccountResponse"];
                 };
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     transfer_collateral_from_parent_margin_account: {
@@ -10017,6 +10146,13 @@ export interface operations {
                     "application/json": components["schemas"]["TransferCollateralFromMarginAccountResponse"];
                 };
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     get_parent_margin_account_movements: {
@@ -10091,6 +10227,13 @@ export interface operations {
                     "application/json": components["schemas"]["TransferCollateralToMarginAccountResponse"];
                 };
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     simulate_risk_bucket_order_risk: {
@@ -10757,6 +10900,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Order rate limit exceeded — the per-account item-weighted budget is spent; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error or matching engine failure */
             500: {
                 headers: {
@@ -10764,6 +10914,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Keyed order submission temporarily unavailable; retry the same key and payload. For previously accepted keys, retry only within 24 hours of the original acceptance. A capacity refusal does not accept or reserve a new key. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     batch_cancel_orders: {
@@ -10802,6 +10959,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Risk-reduction rate limit exceeded — each id counts against the 2x risk-reduction budget and the whole request is rejected; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error or matching engine failure */
             500: {
                 headers: {
@@ -10925,6 +11089,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Order rate limit exceeded — each batch item counts against the per-account budget and the whole request is rejected; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -10970,6 +11141,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Order rate limit exceeded — each batch item counts against the per-account budget and the whole request is rejected; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -11022,6 +11200,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Risk-reduction rate limit exceeded — cancels draw the 2x risk-reduction budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -11104,6 +11289,13 @@ export interface operations {
                     "application/json": components["schemas"]["CancelConditionalOrderResponse"];
                 };
             };
+            /** @description Risk-reduction rate limit exceeded — cancels draw the 2x risk-reduction budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     list_twap_orders: {
@@ -11298,6 +11490,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Risk-reduction rate limit exceeded — cancels draw the 2x risk-reduction budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -11461,6 +11660,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Order rate limit exceeded — the per-account item-weighted budget is spent; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -12348,6 +12554,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Movement rate limit exceeded — withdrawals and collateral transfers share a per-user budget; retry after the interval in details.retryAfter */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Internal server error */
             500: {
                 headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/types",
-	"version": "1.0.51",
+	"version": "1.0.54",
 	"type": "module",
 	"homepage": "https://docs.0xmonaco.com/sdk/typescript",
 	"main": "./dist/index.js",
@@ -16,7 +16,7 @@
 		"lint": "biome lint ."
 	},
 	"dependencies": {
-		"@0xmonaco/contracts": "1.0.51",
+		"@0xmonaco/contracts": "1.0.54",
 		"zod": "^4.1.12"
 	},
 	"peerDependencies": {