@0xmonaco/types 1.0.73 → 1.0.75

package/dist/api/index.d.ts

@@ -16,11 +16,4 @@ export interface BaseAPI {
      * @param credentials - Hex-encoded session keypair, or `undefined` to clear.
      */
     setSessionKeypair(credentials: SessionCredentials | undefined): void;
-    /**
-     * Set (or clear) the application secret key used for backend-authenticated
-     * requests. When set, it is sent in the `x-server-key` header.
-     *
-     * @param serverKey - The application secret key (`sk_...`), or `undefined` to clear.
-     */
-    setServerKey(serverKey: string | undefined): void;
 }

package/dist/applications/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * Applications Types
  *
- * Types for application configuration and the backend-authenticated
- * application reporting endpoints.
+ * Types for application configuration and the public application reporting
+ * endpoints.
  */
 import type { BaseAPI } from "../api";
 import type { GetAppStatsParams, ListAppBalancesParams, ListAppMovementsParams, ListAppOrdersParams, ListAppUsersParams } from "./requests";
@@ -11,9 +11,8 @@ import type { ApplicationConfigResponse, GetAppStatsResponse, ListAppBalancesRes
  * Applications API interface.
  *
  * `getApplicationConfig` is session-authenticated (signed with the session
- * key). The reporting methods are backend-authenticated: set the application's
- * secret key with {@link BaseAPI.setServerKey} before calling them — each
- * request sends it in the `x-server-key` header.
+ * key). The reporting methods are public: each selects its application by
+ * `clientId` and is rate limited per client IP.
  */
 export interface ApplicationsAPI extends BaseAPI {
     /**
@@ -26,40 +25,40 @@ export interface ApplicationsAPI extends BaseAPI {
      */
     getApplicationConfig(): Promise<ApplicationConfigResponse>;
     /**
-     * Lists orders placed by the application's users. Backend-authenticated.
+     * Lists orders placed by the application's users. Public, selected by `clientId`.
      *
      * @param params - Pagination and filter options
      * @returns Promise resolving to a paginated list of orders
      */
-    listApplicationOrders(params?: ListAppOrdersParams): Promise<ListAppOrdersResponse>;
+    listApplicationOrders(params: ListAppOrdersParams): Promise<ListAppOrdersResponse>;
     /**
-     * Lists the application's users. Backend-authenticated.
+     * Lists the application's users. Public, selected by `clientId`.
      *
      * @param params - Pagination and filter options
      * @returns Promise resolving to a paginated list of users
      */
-    listApplicationUsers(params?: ListAppUsersParams): Promise<ListAppUsersResponse>;
+    listApplicationUsers(params: ListAppUsersParams): Promise<ListAppUsersResponse>;
     /**
-     * Lists ledger movements for the application's users. Backend-authenticated.
+     * Lists ledger movements for the application's users. Public, selected by `clientId`.
      *
      * @param params - Pagination and filter options
      * @returns Promise resolving to a paginated list of movements
      */
-    listApplicationMovements(params?: ListAppMovementsParams): Promise<ListAppMovementsResponse>;
+    listApplicationMovements(params: ListAppMovementsParams): Promise<ListAppMovementsResponse>;
     /**
-     * Lists user balances held within the application. Backend-authenticated.
+     * Lists user balances held within the application. Public, selected by `clientId`.
      *
      * @param params - Pagination and filter options
      * @returns Promise resolving to a paginated list of balances
      */
-    listApplicationBalances(params?: ListAppBalancesParams): Promise<ListAppBalancesResponse>;
+    listApplicationBalances(params: ListAppBalancesParams): Promise<ListAppBalancesResponse>;
     /**
-     * Gets aggregate volume and fee stats for the application. Backend-authenticated.
+     * Gets aggregate volume and fee stats for the application. Public, selected by `clientId`.
      *
      * @param params - Optional `since` filter
      * @returns Promise resolving to the application stats
      */
-    getApplicationStats(params?: GetAppStatsParams): Promise<GetAppStatsResponse>;
+    getApplicationStats(params: GetAppStatsParams): Promise<GetAppStatsResponse>;
 }
 export type { GetAppStatsParams, ListAppBalancesParams, ListAppMovementsParams, ListAppOrdersParams, ListAppUsersParams } from "./requests";
 export type { AppBalance, ApplicationConfigResponse, AppMovement, AppOrder, AppUser, GetAppStatsResponse, ListAppBalancesResponse, ListAppMovementsResponse, ListAppOrdersResponse, ListAppUsersResponse, } from "./responses";

package/dist/applications/index.js

@@ -1,6 +1,6 @@
 /**
  * Applications Types
  *
- * Types for application configuration and the backend-authenticated
- * application reporting endpoints.
+ * Types for application configuration and the public application reporting
+ * endpoints.
  */

package/dist/applications/requests.d.ts

@@ -1,18 +1,30 @@
 /**
  * Applications Request Types
  *
- * Query parameters for the backend-authenticated application reporting
- * endpoints. Field names match the wire (snake_case) so they can be passed
- * straight through to the query string.
+ * Query parameters for the public application reporting endpoints. Each one
+ * selects its application by `clientId`.
  */
 /**
  * Query parameters for listing application orders.
  */
 export interface ListAppOrdersParams {
-    /** Page number (starts from 1, at most 10,000 — the last page the listing counts towards) */
-    page?: number;
-    /** Items per page (max 100) */
+    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    clientId: string;
+    /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2822): there is no `page`, and
+     * sending one is a `400`. The response carries no item count — follow
+     * `nextPageToken` until it comes back empty. Filters must match the request
+     * that minted the token.
+     */
+    pageToken?: string;
     /** Filter by order status (e.g. SUBMITTED, PARTIALLY_FILLED, FILLED, SETTLED, CANCELLED, EXPIRED, REJECTED) */
     status?: string;
     /** Filter by user UUID */
@@ -28,10 +40,24 @@ export interface ListAppOrdersParams {
  * Query parameters for listing application users.
  */
 export interface ListAppUsersParams {
-    /** Page number (starts from 1) */
-    page?: number;
-    /** Items per page (max 100) */
+    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    clientId: string;
+    /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2822): there is no `page`, and
+     * sending one is a `400`. Ordered by id ascending, not newest-first.
+     * `total` / `totalPages` are populated, bounded by the server count
+     * ceiling — see `totalCapped`. Filters must match the request that minted
+     * the token.
+     */
+    pageToken?: string;
     /** Filter by active status */
     isActive?: boolean;
     /** Filter by account type: master or sub */
@@ -43,10 +69,23 @@ export interface ListAppUsersParams {
  * Query parameters for listing application movements.
  */
 export interface ListAppMovementsParams {
-    /** Page number (starts from 1, at most 10,000 — the last page the listing counts towards) */
-    page?: number;
-    /** Items per page (max 100) */
+    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    clientId: string;
+    /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2822): there is no `page`, and
+     * sending one is a `400`. The response carries no item count — follow
+     * `nextPageToken` until it comes back empty. Filters must match the request
+     * that minted the token.
+     */
+    pageToken?: string;
     /** Filter by user UUID */
     userId?: string;
     /** Filter by transaction type (e.g. DEPOSIT, WITHDRAWAL, TRADE, FEE, FUNDING, LIQUIDATION, INTEREST, REWARD) */
@@ -60,10 +99,24 @@ export interface ListAppMovementsParams {
  * Query parameters for listing application balances.
  */
 export interface ListAppBalancesParams {
-    /** Page number (starts from 1) */
-    page?: number;
-    /** Items per page (max 100) */
+    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    clientId: string;
+    /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2822): there is no `page`, and
+     * sending one is a `400`. Ordered by id ascending, not newest-first.
+     * `total` / `totalPages` are populated, bounded by the server count
+     * ceiling — see `totalCapped`. Filters must match the request that minted
+     * the token.
+     */
+    pageToken?: string;
     /** Filter by user UUID */
     userId?: string;
     /** Filter by asset UUID */
@@ -73,6 +126,8 @@ export interface ListAppBalancesParams {
  * Query parameters for application stats.
  */
 export interface GetAppStatsParams {
+    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    clientId: string;
     /** ISO 8601 datetime to filter stats from (e.g. 2026-01-01T00:00:00Z). Omit for all-time. */
     since?: string;
 }

package/dist/applications/requests.js

@@ -1,7 +1,6 @@
 /**
  * Applications Request Types
  *
- * Query parameters for the backend-authenticated application reporting
- * endpoints. Field names match the wire (snake_case) so they can be passed
- * straight through to the query string.
+ * Query parameters for the public application reporting endpoints. Each one
+ * selects its application by `clientId`.
  */

package/dist/applications/responses.d.ts

@@ -2,7 +2,7 @@
  * Applications Response Types
  *
  * Response types for application configuration operations and the
- * backend-authenticated application reporting endpoints. Reporting types use
+ * public application reporting endpoints. Reporting types use
  * the wire shape (snake_case); optional fields are `null` rather than omitted.
  */
 import type { Address } from "viem";
@@ -72,16 +72,10 @@ export interface AppUser {
     username: string | null;
     /** Account type: master or sub */
     accountType: string;
-    /** Whether the user is allowed to withdraw */
-    canWithdraw: boolean;
     /** Account creation timestamp (ISO 8601) */
     createdAt: string | null;
-    /** Email address */
-    email: string | null;
     /** Whether the user account is active */
     isActive: boolean | null;
-    /** Whether the user is banned */
-    isBanned: boolean | null;
     /** Master account ID (for sub-accounts) */
     masterAccountId: string | null;
     /** Last update timestamp (ISO 8601) */
@@ -162,72 +156,74 @@ export interface AppBalance {
  */
 export interface ListAppOrdersResponse {
     orders: AppOrder[];
-    /**
-     * Matching orders. Exact up to 10,000 pages of the requested page size
-     * (`pageSize` x 10,000 rows) and saturates there, so an application with
-     * more matching orders than the listing can page through reads the cap,
-     * not its lifetime total.
-     */
-    total: number;
-    /** Current page number */
-    page: number;
     /** Items per page */
     pageSize: number;
     /**
-     * Number of pages at the requested page size. Exact up to 10,000 and
-     * saturates there, the last page this listing can reach.
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page: this listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`.
      */
-    totalPages: number;
+    nextPageToken: string;
 }
 /**
  * Paginated list of application users.
  */
 export interface ListAppUsersResponse {
     users: AppUser[];
-    /** Total number of users */
+    /** Users matching the filter, bounded by the server count ceiling. */
     total: number;
-    /** Current page number */
-    page: number;
     /** Items per page */
     pageSize: number;
-    /** Total number of pages */
+    /** Pages at this `pageSize`, bounded by the same ceiling as `total`. */
     totalPages: number;
+    /**
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page: this listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`.
+     */
+    nextPageToken: string;
+    /**
+     * `true` when MORE than the server ceiling matched, so the count stopped
+     * there and `total` / `totalPages` are a lower bound.
+     */
+    totalCapped: boolean;
 }
 /**
  * Paginated list of application movements.
  */
 export interface ListAppMovementsResponse {
     movements: AppMovement[];
-    /**
-     * Matching movements. Exact up to 10,000 pages of the requested page size
-     * (`pageSize` x 10,000 rows) and saturates there, so an application with
-     * more matching movements than the listing can page through reads the cap,
-     * not its lifetime total.
-     */
-    total: number;
-    /** Current page number */
-    page: number;
     /** Items per page */
     pageSize: number;
     /**
-     * Number of pages at the requested page size. Exact up to 10,000 and
-     * saturates there, the last page this listing can reach.
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page: this listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`.
      */
-    totalPages: number;
+    nextPageToken: string;
 }
 /**
  * Paginated list of application balances.
  */
 export interface ListAppBalancesResponse {
     balances: AppBalance[];
-    /** Total matching balances */
+    /** Balances matching the filter, bounded by the server count ceiling. */
     total: number;
-    /** Current page number */
-    page: number;
     /** Items per page */
     pageSize: number;
-    /** Total number of pages */
+    /** Pages at this `pageSize`, bounded by the same ceiling as `total`. */
     totalPages: number;
+    /**
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page: this listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`.
+     */
+    nextPageToken: string;
+    /**
+     * `true` when MORE than the server ceiling matched, so the count stopped
+     * there and `total` / `totalPages` are a lower bound.
+     */
+    totalCapped: boolean;
 }
 /**
  * Aggregate volume and fee stats for an application.

package/dist/applications/responses.js

@@ -2,6 +2,6 @@
  * Applications Response Types
  *
  * Response types for application configuration operations and the
- * backend-authenticated application reporting endpoints. Reporting types use
+ * public application reporting endpoints. Reporting types use
  * the wire shape (snake_case); optional fields are `null` rather than omitted.
  */

package/dist/buildercodes/responses.d.ts

@@ -65,9 +65,8 @@ export declare const ListBuilderFeeChangesResponseSchema: z.ZodObject<{
     nextPageToken: z.ZodString;
 }, z.core.$strip>;
 /**
- * The payout stream a BuilderCodes credit belongs to. `REVENUE_SHARE` is the
- * active frontend-revenue-share category; `BUILDER_FEE` is reserved and is not
- * currently emitted.
+ * The payout stream a BuilderCodes credit belongs to. `REVENUE_SHARE` records
+ * Monaco revenue share; `BUILDER_FEE` records builder fees charged to takers.
  */
 export declare const BuildercodePayoutKindSchema: z.ZodEnum<{
     REVENUE_SHARE: "REVENUE_SHARE";

package/dist/buildercodes/responses.js

@@ -54,9 +54,8 @@ export const ListBuilderFeeChangesResponseSchema = z.object({
     nextPageToken: z.string(),
 });
 /**
- * The payout stream a BuilderCodes credit belongs to. `REVENUE_SHARE` is the
- * active frontend-revenue-share category; `BUILDER_FEE` is reserved and is not
- * currently emitted.
+ * The payout stream a BuilderCodes credit belongs to. `REVENUE_SHARE` records
+ * Monaco revenue share; `BUILDER_FEE` records builder fees charged to takers.
  */
 export const BuildercodePayoutKindSchema = z.enum(["REVENUE_SHARE", "BUILDER_FEE"]);
 /** Pagination and filter accepted by the per-trade payout history endpoint. */

package/dist/copy-trading/index.d.ts

@@ -65,8 +65,9 @@ export interface CopyTradingAPI extends BaseAPI {
     upsertFollow(params: UpsertFollowParams): Promise<UpsertFollowResponse>;
     /**
      * Stop one of your follows: the leader's fills stop being mirrored. An exit
-     * is never gated beyond ownership, except that a delegated agent session
-     * cannot stop a follow (403).
+     * is never refused for the state of the account or the platform. Only
+     * ownership applies, a delegated agent session cannot stop a follow (403),
+     * and stops have a rate limit of their own (429 past it).
      */
     stopFollow(followId: string): Promise<StopFollowResponse>;
     /**
@@ -106,11 +107,10 @@ export interface CopyTradingAPI extends BaseAPI {
      *
      * Master account sessions only (a delegated agent or a sub-account gets
      * 403); 404 for a follow that is not yours; 409 while the follow is
-     * stopping or once it is stopped, or `COPY_TRADING_UNAVAILABLE` when copy
-     * trading is not available on the platform; 400 `COPY_TRADING_REJECTED`
-     * when the engine refuses (no isolated copy position on the pair, the
-     * position or the margin account is being liquidated, the position has
-     * lost more than its margin, more than the copy account can put in); 429
+     * stopping or once it is stopped; 400 `COPY_TRADING_REJECTED` when the add
+     * is refused (no isolated copy position on the pair, the copy position is
+     * being liquidated or is in bad debt, more than the copy account can put
+     * in); 429
      * over the movement budget withdrawals and collateral transfers share.
      *
      * Not idempotent: a retry after a timeout whose first attempt landed adds

package/dist/delegated-agents/index.d.ts

@@ -1,16 +1,22 @@
 import type { Address } from "viem";
 import type { BaseAPI } from "../api";
-export type DelegatedAgentAction = "CREATE_ORDER" | "CANCEL_ORDER" | "REPLACE_ORDER" | "create_order" | "cancel_order" | "replace_order";
+export type DelegatedAgentAction = "CREATE_ORDER" | "CANCEL_ORDER" | "REPLACE_ORDER" | "READ" | "MANAGE_RISK_BUCKETS" | "create_order" | "cancel_order" | "replace_order" | "read" | "manage_risk_buckets";
 export interface UpsertDelegatedAgentRequest {
     agentAddress: string;
     name?: string;
-    /** Delegation expiry (ISO 8601); ends reads, trading, and session refresh. */
+    /** Delegation expiry (ISO 8601); ends reads, trading, and session refresh. Omit for the default of 14 days from now; at most 180 days ahead. */
     expiresAt?: string;
-    /** Required. An empty list permits no actions. */
+    /**
+     * Required. An empty list permits no order actions. Every delegated session may read the owner's
+     * data, so a list of only `READ` (or none) is a read-only key.
+     */
     allowedActions: DelegatedAgentAction[];
-    /** Required. A matching market OR account permits an order; both scopes empty deny all orders. */
+    /** Required. Each listed scope must match: a listed market AND a listed account. Both empty deny all orders. */
     allowedTradingPairIds: string[];
-    /** Additional account scope. Omit or send [] for market-only scope, not access to every account. */
+    /**
+     * The margin accounts the agent is bound to (a sub-account's own key). Omit or send [] to leave the
+     * account unrestricted.
+     */
     allowedMarginAccountIds?: string[];
     /** Omit or send [] for unrestricted order types. */
     allowedOrderTypes?: Array<"LIMIT" | "MARKET">;
@@ -20,6 +26,8 @@ export interface UpsertDelegatedAgentRequest {
     maxOrderNotional?: string;
     /** @deprecated Unsupported: setting this field causes the server to reject the request. */
     maxOpenOrders?: number;
+    /** Up to 20 IP addresses or CIDR ranges the agent may create its delegated session from. Omit for any. */
+    ipAllowlist?: string[];
 }
 export interface DelegatedAgent {
     id: string;
@@ -38,6 +46,8 @@ export interface DelegatedAgent {
     maxOrderNotional?: string;
     /** @deprecated Legacy data only; no concurrent open-order cap is enforced. */
     maxOpenOrders?: number;
+    /** Normalized IP addresses and CIDR ranges; empty allows any address. */
+    ipAllowlist?: string[];
 }
 export interface ListDelegatedAgentsResponse {
     agents: DelegatedAgent[];

package/dist/fees/responses.js

@@ -126,7 +126,7 @@ export const FeeTierScheduleRowSchema = z.object({
  * Zod schema for the "my fee tier" response
  */
 export const GetMyFeeTierResponseSchema = z.object({
-    /** Caller's resolved tier (1–6) from their wallet's stored weighted 14-day volume */
+    /** Caller's resolved tier (1–6) from the higher of their wallet's weighted 14-day volume and any volume floor set on the wallet. A floor that is set or changed counts once it applies to the wallet's fills, usually within a minute, and likewise for an account the wallet opens in a new application; a removed or expired floor stops counting at once */
     currentTierLevel: z.number().int(),
     /** Caller's weighted 14-day volume (perp + 2.5× spot), summed across every application the wallet trades through */
     weightedVolume14d: z.string(),
@@ -134,7 +134,7 @@ export const GetMyFeeTierResponseSchema = z.object({
     spotVolume14d: z.string(),
     /** Caller's rolling 14-day perp volume, summed across every application the wallet trades through */
     perpVolume14d: z.string(),
-    /** Additional weighted volume needed to reach the next tier; absent at tier 6 */
+    /** Additional weighted volume needed to reach the next tier, counted from the volume the current tier resolved from; absent at tier 6 */
     volumeToNextTier: z.string().nullable().optional(),
     /** Next tier level; absent when already at tier 6 */
     nextTierLevel: z.number().int().nullable().optional(),