@compass-labs/api-sdk 2.2.92 → 2.2.93-rc.0

package/dist/esm/models/operations/v2perpetualtradingopportunities.js

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+/**
+ * Sort results by this field
+ */
+export const PerpetualTradingSortBy = {
+    OpenInterest: "open_interest",
+    Volume24h: "volume_24h",
+    FundingRate: "funding_rate",
+};
+/**
+ * Sort direction
+ */
+export const PerpetualTradingSortOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};
+/** @internal */
+export const PerpetualTradingSortBy$outboundSchema = z.nativeEnum(PerpetualTradingSortBy);
+/** @internal */
+export const PerpetualTradingSortOrder$outboundSchema = z.nativeEnum(PerpetualTradingSortOrder);
+/** @internal */
+export const V2PerpetualTradingOpportunitiesRequest$outboundSchema = z.object({
+    minOpenInterest: z.nullable(z.number()).optional(),
+    minVolume24h: z.nullable(z.number()).optional(),
+    category: z.nullable(components.PerpetualTradingCategory$outboundSchema)
+        .optional(),
+    sortBy: PerpetualTradingSortBy$outboundSchema.optional(),
+    sortOrder: PerpetualTradingSortOrder$outboundSchema.optional(),
+}).transform((v) => {
+    return remap$(v, {
+        minOpenInterest: "min_open_interest",
+        minVolume24h: "min_volume_24h",
+        sortBy: "sort_by",
+        sortOrder: "sort_order",
+    });
+});
+export function v2PerpetualTradingOpportunitiesRequestToJSON(v2PerpetualTradingOpportunitiesRequest) {
+    return JSON.stringify(V2PerpetualTradingOpportunitiesRequest$outboundSchema.parse(v2PerpetualTradingOpportunitiesRequest));
+}
+//# sourceMappingURL=v2perpetualtradingopportunities.js.map

package/dist/esm/models/operations/v2perpetualtradingopportunities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2perpetualtradingopportunities.js","sourceRoot":"","sources":["../../../../src/models/operations/v2perpetualtradingopportunities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,WAAW,EAAE,cAAc;CACnB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AA+BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAE9C,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEzC,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAEjD,CAAC,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAW5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,qDAAqD,GAI9D,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,uCAAuC,CAAC;SACrE,QAAQ,EAAE;IACb,MAAM,EAAE,qCAAqC,CAAC,QAAQ,EAAE;IACxD,SAAS,EAAE,wCAAwC,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,eAAe,EAAE,mBAAmB;QACpC,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,SAAS;QACjB,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,4CAA4C,CAC1D,sCACwC;IAExC,OAAO,IAAI,CAAC,SAAS,CACnB,qDAAqD,CAAC,KAAK,CACzD,sCAAsC,CACvC,CACF,CAAC;AACJ,CAAC"}

package/dist/esm/models/operations/v2perpetualtradingpositions.d.ts

@@ -0,0 +1,20 @@
+import * as z from "zod/v3";
+export type V2PerpetualTradingPositionsRequest = {
+    /**
+     * User's EOA address (looks up their perpetual trading product account)
+     */
+    owner: string;
+    /**
+     * Filter to a specific asset ticker (e.g. AAPL)
+     */
+    asset?: string | null | undefined;
+};
+/** @internal */
+export type V2PerpetualTradingPositionsRequest$Outbound = {
+    owner: string;
+    asset?: string | null | undefined;
+};
+/** @internal */
+export declare const V2PerpetualTradingPositionsRequest$outboundSchema: z.ZodType<V2PerpetualTradingPositionsRequest$Outbound, z.ZodTypeDef, V2PerpetualTradingPositionsRequest>;
+export declare function v2PerpetualTradingPositionsRequestToJSON(v2PerpetualTradingPositionsRequest: V2PerpetualTradingPositionsRequest): string;
+//# sourceMappingURL=v2perpetualtradingpositions.d.ts.map

package/dist/esm/models/operations/v2perpetualtradingpositions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2perpetualtradingpositions.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/v2perpetualtradingpositions.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,2CAA2C,GAAG;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,OAAO,CACvE,2CAA2C,EAC3C,CAAC,CAAC,UAAU,EACZ,kCAAkC,CAIlC,CAAC;AAEH,wBAAgB,wCAAwC,CACtD,kCAAkC,EAAE,kCAAkC,GACrE,MAAM,CAMR"}

package/dist/esm/models/operations/v2perpetualtradingpositions.js

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+/** @internal */
+export const V2PerpetualTradingPositionsRequest$outboundSchema = z.object({
+    owner: z.string(),
+    asset: z.nullable(z.string()).optional(),
+});
+export function v2PerpetualTradingPositionsRequestToJSON(v2PerpetualTradingPositionsRequest) {
+    return JSON.stringify(V2PerpetualTradingPositionsRequest$outboundSchema.parse(v2PerpetualTradingPositionsRequest));
+}
+//# sourceMappingURL=v2perpetualtradingpositions.js.map

package/dist/esm/models/operations/v2perpetualtradingpositions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2perpetualtradingpositions.js","sourceRoot":"","sources":["../../../../src/models/operations/v2perpetualtradingpositions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAmB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,iDAAiD,GAI1D,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,wCAAwC,CACtD,kCAAsE;IAEtE,OAAO,IAAI,CAAC,SAAS,CACnB,iDAAiD,CAAC,KAAK,CACrD,kCAAkC,CACnC,CACF,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/perpetualtrading.d.ts

@@ -0,0 +1,188 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+export declare class PerpetualTrading extends ClientSDK {
+    /**
+     * List perpetual trading markets
+     *
+     * @remarks
+     * List available perpetual trading markets with key metrics.
+     *
+     * Returns perp markets (stocks, commodities, forex) with open interest,
+     * 24h volume, funding rate, and max leverage. Supports filtering by category,
+     * minimum OI/volume, and sorting.
+     *
+     * Only perpetual trading assets are returned — crypto perps are excluded.
+     */
+    perpetualTradingOpportunities(request: operations.V2PerpetualTradingOpportunitiesRequest, options?: RequestOptions): Promise<components.PerpetualTradingOpportunitiesResponse>;
+    /**
+     * List perpetual trading positions
+     *
+     * @remarks
+     * List open perpetual futures positions for a user.
+     *
+     * Returns position data including size, entry price, mark price, PnL, liquidation price,
+     * leverage, and cumulative funding. Optionally filter by asset ticker.
+     * Returns an empty list if no positions are open.
+     */
+    perpetualTradingPositions(request: operations.V2PerpetualTradingPositionsRequest, options?: RequestOptions): Promise<components.PerpetualTradingPositionsResponse>;
+    /**
+     * Get OHLCV candles
+     *
+     * @remarks
+     * Return OHLCV candles for a single asset and interval.
+     *
+     * Wraps Hyperliquid's ``candleSnapshot`` info type and adds the xyz: HIP-3 DEX
+     * prefix server-side so the SDK only needs the bare ticker (e.g. ``AAPL``).
+     * Candle ``time`` is returned in unix seconds, ready for TradingView
+     * lightweight-charts. Cached for 15 seconds per (symbol, interval, window).
+     */
+    perpetualTradingCandles(request: operations.V2PerpetualTradingCandlesRequest, options?: RequestOptions): Promise<components.PerpetualTradingCandlesResponse>;
+    /**
+     * Aggregated Hyperliquid activity for a user
+     *
+     * @remarks
+     * Return positions, fills, open orders, and (optionally) builder approval
+     * state for an end-user in one normalized payload.
+     *
+     * Each section is fetched in parallel from the Hyperliquid `info` API.
+     * If a single upstream call fails the corresponding section returns ``null``
+     * and an entry is added to ``partial_errors``; if every section fails the
+     * endpoint responds with 502.
+     *
+     * Pass ``builder`` to additionally include the user's current approved max
+     * fee rate for that builder (used by dashboards to decide whether to prompt
+     * the user to sign an `approveBuilderFee` action).
+     */
+    perpetualTradingActivity(request: operations.V2PerpetualTradingActivityRequest, options?: RequestOptions): Promise<components.PerpetualTradingActivityResponse>;
+    /**
+     * Deposit USDC to perpetual trading account
+     *
+     * @remarks
+     * Prepare a USDC deposit from Arbitrum via EIP-2612 Permit.
+     *
+     * Returns EIP-712 typed data for the user to sign off-chain (no gas needed).
+     * Compass does NOT broadcast the bridge tx — the integrator's own sponsor
+     * wallet calls batchedDepositWithPermit on the HL Bridge2 contract on
+     * Arbitrum after the user signs. See api_docs/v2/Products/Perpetual-Trading.mdx
+     * "Deposit USDC" section for the bridge-broadcast code.
+     */
+    perpetualTradingDeposit(request: components.PerpetualTradingDepositRequest, options?: RequestOptions): Promise<components.PerpetualTradingDepositResponse>;
+    /**
+     * Build the Bridge2 deposit tx from a signed permit
+     *
+     * @remarks
+     * Build the Arbitrum tx that completes a USDC deposit to HL.
+     *
+     * Takes the EIP-2612 permit signature returned by /deposit and returns
+     * a fully-encoded `Bridge2.batchedDepositWithPermit` call. The integrator's
+     * sponsor wallet (`sender`) broadcasts the returned tx — Compass does not
+     * broadcast and does not hold gas keys.
+     */
+    perpetualTradingDepositSponsorPrepare(request: components.PerpetualTradingDepositSponsorPrepareRequest, options?: RequestOptions): Promise<components.PerpetualTradingDepositSponsorPrepareResponse>;
+    /**
+     * Withdraw USDC from perpetual trading account
+     *
+     * @remarks
+     * Prepare a USDC withdrawal from Hyperliquid to Arbitrum.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Withdrawal processing takes
+     * minutes to hours depending on bridge conditions.
+     */
+    perpetualTradingWithdraw(request: components.PerpetualTradingWithdrawRequest, options?: RequestOptions): Promise<components.PerpetualTradingSignableActionResponse>;
+    /**
+     * Place market order
+     *
+     * @remarks
+     * Prepare a market order on a perpetual trading market.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Executes as an IOC order at the
+     * current mark price with slippage protection.
+     */
+    perpetualTradingMarketOrder(request: components.PerpetualTradingMarketOrderRequest, options?: RequestOptions): Promise<components.PerpetualTradingSignableActionResponse>;
+    /**
+     * Place limit order
+     *
+     * @remarks
+     * Prepare a limit order on a perpetual trading market.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Supports GTC and ALO time-in-force.
+     */
+    perpetualTradingLimitOrder(request: components.PerpetualTradingLimitOrderRequest, options?: RequestOptions): Promise<components.PerpetualTradingSignableActionResponse>;
+    /**
+     * Cancel order
+     *
+     * @remarks
+     * Prepare an order cancellation.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    perpetualTradingCancelOrder(request: components.PerpetualTradingCancelOrderRequest, options?: RequestOptions): Promise<components.PerpetualTradingSignableActionResponse>;
+    /**
+     * Execute signed action
+     *
+     * @remarks
+     * Submit a signed Hyperliquid action for execution.
+     *
+     * Accepts the signature from any prepare endpoint (market_order, limit_order,
+     * cancel_order, withdraw, approve_builder_fee) and POSTs it to the Hyperliquid
+     * exchange API.
+     *
+     * The caller must have already hit a prepare endpoint, so no compass_account
+     * registration is performed here.
+     */
+    perpetualTradingExecute(request: components.PerpetualTradingExecuteRequest, options?: RequestOptions): Promise<components.PerpetualTradingExecuteResponse>;
+    /**
+     * Approve builder fee
+     *
+     * @remarks
+     * Prepare builder fee approval for the perpetual trading DEX.
+     *
+     * This is a one-time action required before placing the first trade.
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    perpetualTradingApproveBuilderFee(request: components.PerpetualTradingApproveBuilderFeeRequest, options?: RequestOptions): Promise<components.PerpetualTradingSignableActionResponse>;
+    /**
+     * Enable unified account mode
+     *
+     * @remarks
+     * Check account mode and prepare the enable-unified-account action if needed.
+     *
+     * If the account is already in unified mode (or portfolio margin), returns
+     * the current mode with null typed_data — no signing needed. Otherwise,
+     * returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    perpetualTradingEnableUnifiedAccount(request: components.PerpetualTradingEnableUnifiedAccountRequest, options?: RequestOptions): Promise<components.PerpetualTradingEnableUnifiedAccountResponse>;
+    /**
+     * Ensure 1x cross leverage
+     *
+     * @remarks
+     * Check leverage and prepare an updateLeverage action if not 1x cross.
+     *
+     * If the asset is already at 1x cross leverage, returns leverage_ok=true
+     * with null typed_data — no signing needed. Otherwise, returns EIP-712
+     * typed data for the user to sign. After signing, submit the signature
+     * via the /execute endpoint.
+     */
+    perpetualTradingEnsureLeverage(request: components.PerpetualTradingEnsureLeverageRequest, options?: RequestOptions): Promise<components.PerpetualTradingEnsureLeverageResponse>;
+    /**
+     * Set leverage (defaults to market maximum)
+     *
+     * @remarks
+     * Check leverage and prepare an updateLeverage action to the requested value.
+     *
+     * If `leverage` is omitted, targets the asset's maximum leverage for that
+     * market. If the asset is already at the requested leverage, returns
+     * leverage_ok=true with null typed_data — no signing needed. Otherwise,
+     * returns EIP-712 typed data for the user to sign. After signing, submit the
+     * signature via the /execute endpoint.
+     */
+    perpetualTradingSetLeverage(request: components.PerpetualTradingSetLeverageRequest, options?: RequestOptions): Promise<components.PerpetualTradingSetLeverageResponse>;
+}
+//# sourceMappingURL=perpetualtrading.d.ts.map

package/dist/esm/sdk/perpetualtrading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpetualtrading.d.ts","sourceRoot":"","sources":["../../../src/sdk/perpetualtrading.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C;;;;;;;;;;;OAWG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,sCAAsC,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;;;;;OASG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;;;;;;OAUG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,gCAAgC,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;;;;;;;OAWG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;;;;;;OAUG;IACG,qCAAqC,CACzC,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IAQpE;;;;;;;;;OASG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;;OASG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;OAQG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;;;;;OASG;IACG,iCAAiC,CACrC,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;;;OAUG;IACG,oCAAoC,CACxC,OAAO,EAAE,UAAU,CAAC,2CAA2C,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4CAA4C,CAAC;IAQnE;;;;;;;;;;OAUG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;;;;OAWG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAO3D"}

package/dist/esm/sdk/perpetualtrading.js

@@ -0,0 +1,235 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { perpetualTradingPerpetualTradingActivity } from "../funcs/perpetualTradingPerpetualTradingActivity.js";
+import { perpetualTradingPerpetualTradingApproveBuilderFee } from "../funcs/perpetualTradingPerpetualTradingApproveBuilderFee.js";
+import { perpetualTradingPerpetualTradingCancelOrder } from "../funcs/perpetualTradingPerpetualTradingCancelOrder.js";
+import { perpetualTradingPerpetualTradingCandles } from "../funcs/perpetualTradingPerpetualTradingCandles.js";
+import { perpetualTradingPerpetualTradingDeposit } from "../funcs/perpetualTradingPerpetualTradingDeposit.js";
+import { perpetualTradingPerpetualTradingDepositSponsorPrepare } from "../funcs/perpetualTradingPerpetualTradingDepositSponsorPrepare.js";
+import { perpetualTradingPerpetualTradingEnableUnifiedAccount } from "../funcs/perpetualTradingPerpetualTradingEnableUnifiedAccount.js";
+import { perpetualTradingPerpetualTradingEnsureLeverage } from "../funcs/perpetualTradingPerpetualTradingEnsureLeverage.js";
+import { perpetualTradingPerpetualTradingExecute } from "../funcs/perpetualTradingPerpetualTradingExecute.js";
+import { perpetualTradingPerpetualTradingLimitOrder } from "../funcs/perpetualTradingPerpetualTradingLimitOrder.js";
+import { perpetualTradingPerpetualTradingMarketOrder } from "../funcs/perpetualTradingPerpetualTradingMarketOrder.js";
+import { perpetualTradingPerpetualTradingOpportunities } from "../funcs/perpetualTradingPerpetualTradingOpportunities.js";
+import { perpetualTradingPerpetualTradingPositions } from "../funcs/perpetualTradingPerpetualTradingPositions.js";
+import { perpetualTradingPerpetualTradingSetLeverage } from "../funcs/perpetualTradingPerpetualTradingSetLeverage.js";
+import { perpetualTradingPerpetualTradingWithdraw } from "../funcs/perpetualTradingPerpetualTradingWithdraw.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export class PerpetualTrading extends ClientSDK {
+    /**
+     * List perpetual trading markets
+     *
+     * @remarks
+     * List available perpetual trading markets with key metrics.
+     *
+     * Returns perp markets (stocks, commodities, forex) with open interest,
+     * 24h volume, funding rate, and max leverage. Supports filtering by category,
+     * minimum OI/volume, and sorting.
+     *
+     * Only perpetual trading assets are returned — crypto perps are excluded.
+     */
+    async perpetualTradingOpportunities(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingOpportunities(this, request, options));
+    }
+    /**
+     * List perpetual trading positions
+     *
+     * @remarks
+     * List open perpetual futures positions for a user.
+     *
+     * Returns position data including size, entry price, mark price, PnL, liquidation price,
+     * leverage, and cumulative funding. Optionally filter by asset ticker.
+     * Returns an empty list if no positions are open.
+     */
+    async perpetualTradingPositions(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingPositions(this, request, options));
+    }
+    /**
+     * Get OHLCV candles
+     *
+     * @remarks
+     * Return OHLCV candles for a single asset and interval.
+     *
+     * Wraps Hyperliquid's ``candleSnapshot`` info type and adds the xyz: HIP-3 DEX
+     * prefix server-side so the SDK only needs the bare ticker (e.g. ``AAPL``).
+     * Candle ``time`` is returned in unix seconds, ready for TradingView
+     * lightweight-charts. Cached for 15 seconds per (symbol, interval, window).
+     */
+    async perpetualTradingCandles(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingCandles(this, request, options));
+    }
+    /**
+     * Aggregated Hyperliquid activity for a user
+     *
+     * @remarks
+     * Return positions, fills, open orders, and (optionally) builder approval
+     * state for an end-user in one normalized payload.
+     *
+     * Each section is fetched in parallel from the Hyperliquid `info` API.
+     * If a single upstream call fails the corresponding section returns ``null``
+     * and an entry is added to ``partial_errors``; if every section fails the
+     * endpoint responds with 502.
+     *
+     * Pass ``builder`` to additionally include the user's current approved max
+     * fee rate for that builder (used by dashboards to decide whether to prompt
+     * the user to sign an `approveBuilderFee` action).
+     */
+    async perpetualTradingActivity(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingActivity(this, request, options));
+    }
+    /**
+     * Deposit USDC to perpetual trading account
+     *
+     * @remarks
+     * Prepare a USDC deposit from Arbitrum via EIP-2612 Permit.
+     *
+     * Returns EIP-712 typed data for the user to sign off-chain (no gas needed).
+     * Compass does NOT broadcast the bridge tx — the integrator's own sponsor
+     * wallet calls batchedDepositWithPermit on the HL Bridge2 contract on
+     * Arbitrum after the user signs. See api_docs/v2/Products/Perpetual-Trading.mdx
+     * "Deposit USDC" section for the bridge-broadcast code.
+     */
+    async perpetualTradingDeposit(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingDeposit(this, request, options));
+    }
+    /**
+     * Build the Bridge2 deposit tx from a signed permit
+     *
+     * @remarks
+     * Build the Arbitrum tx that completes a USDC deposit to HL.
+     *
+     * Takes the EIP-2612 permit signature returned by /deposit and returns
+     * a fully-encoded `Bridge2.batchedDepositWithPermit` call. The integrator's
+     * sponsor wallet (`sender`) broadcasts the returned tx — Compass does not
+     * broadcast and does not hold gas keys.
+     */
+    async perpetualTradingDepositSponsorPrepare(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingDepositSponsorPrepare(this, request, options));
+    }
+    /**
+     * Withdraw USDC from perpetual trading account
+     *
+     * @remarks
+     * Prepare a USDC withdrawal from Hyperliquid to Arbitrum.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Withdrawal processing takes
+     * minutes to hours depending on bridge conditions.
+     */
+    async perpetualTradingWithdraw(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingWithdraw(this, request, options));
+    }
+    /**
+     * Place market order
+     *
+     * @remarks
+     * Prepare a market order on a perpetual trading market.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Executes as an IOC order at the
+     * current mark price with slippage protection.
+     */
+    async perpetualTradingMarketOrder(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingMarketOrder(this, request, options));
+    }
+    /**
+     * Place limit order
+     *
+     * @remarks
+     * Prepare a limit order on a perpetual trading market.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint. Supports GTC and ALO time-in-force.
+     */
+    async perpetualTradingLimitOrder(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingLimitOrder(this, request, options));
+    }
+    /**
+     * Cancel order
+     *
+     * @remarks
+     * Prepare an order cancellation.
+     *
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    async perpetualTradingCancelOrder(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingCancelOrder(this, request, options));
+    }
+    /**
+     * Execute signed action
+     *
+     * @remarks
+     * Submit a signed Hyperliquid action for execution.
+     *
+     * Accepts the signature from any prepare endpoint (market_order, limit_order,
+     * cancel_order, withdraw, approve_builder_fee) and POSTs it to the Hyperliquid
+     * exchange API.
+     *
+     * The caller must have already hit a prepare endpoint, so no compass_account
+     * registration is performed here.
+     */
+    async perpetualTradingExecute(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingExecute(this, request, options));
+    }
+    /**
+     * Approve builder fee
+     *
+     * @remarks
+     * Prepare builder fee approval for the perpetual trading DEX.
+     *
+     * This is a one-time action required before placing the first trade.
+     * Returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    async perpetualTradingApproveBuilderFee(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingApproveBuilderFee(this, request, options));
+    }
+    /**
+     * Enable unified account mode
+     *
+     * @remarks
+     * Check account mode and prepare the enable-unified-account action if needed.
+     *
+     * If the account is already in unified mode (or portfolio margin), returns
+     * the current mode with null typed_data — no signing needed. Otherwise,
+     * returns EIP-712 typed data for the user to sign. After signing, submit
+     * the signature via the /execute endpoint.
+     */
+    async perpetualTradingEnableUnifiedAccount(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingEnableUnifiedAccount(this, request, options));
+    }
+    /**
+     * Ensure 1x cross leverage
+     *
+     * @remarks
+     * Check leverage and prepare an updateLeverage action if not 1x cross.
+     *
+     * If the asset is already at 1x cross leverage, returns leverage_ok=true
+     * with null typed_data — no signing needed. Otherwise, returns EIP-712
+     * typed data for the user to sign. After signing, submit the signature
+     * via the /execute endpoint.
+     */
+    async perpetualTradingEnsureLeverage(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingEnsureLeverage(this, request, options));
+    }
+    /**
+     * Set leverage (defaults to market maximum)
+     *
+     * @remarks
+     * Check leverage and prepare an updateLeverage action to the requested value.
+     *
+     * If `leverage` is omitted, targets the asset's maximum leverage for that
+     * market. If the asset is already at the requested leverage, returns
+     * leverage_ok=true with null typed_data — no signing needed. Otherwise,
+     * returns EIP-712 typed data for the user to sign. After signing, submit the
+     * signature via the /execute endpoint.
+     */
+    async perpetualTradingSetLeverage(request, options) {
+        return unwrapAsync(perpetualTradingPerpetualTradingSetLeverage(this, request, options));
+    }
+}
+//# sourceMappingURL=perpetualtrading.js.map

package/dist/esm/sdk/perpetualtrading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpetualtrading.js","sourceRoot":"","sources":["../../../src/sdk/perpetualtrading.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,wCAAwC,EAAE,MAAM,sDAAsD,CAAC;AAChH,OAAO,EAAE,iDAAiD,EAAE,MAAM,+DAA+D,CAAC;AAClI,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,qDAAqD,EAAE,MAAM,mEAAmE,CAAC;AAC1I,OAAO,EAAE,oDAAoD,EAAE,MAAM,kEAAkE,CAAC;AACxI,OAAO,EAAE,8CAA8C,EAAE,MAAM,4DAA4D,CAAC;AAC5H,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,0CAA0C,EAAE,MAAM,wDAAwD,CAAC;AACpH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,6CAA6C,EAAE,MAAM,2DAA2D,CAAC;AAC1H,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,wCAAwC,EAAE,MAAM,sDAAsD,CAAC;AAChH,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,gBAAiB,SAAQ,SAAS;IAC7C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0D,EAC1D,OAAwB;QAExB,OAAO,WAAW,CAAC,6CAA6C,CAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,wCAAwC,CACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,qCAAqC,CACzC,OAAgE,EAChE,OAAwB;QAExB,OAAO,WAAW,CAAC,qDAAqD,CACtE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,wCAAwC,CACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,0CAA0C,CAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iCAAiC,CACrC,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,iDAAiD,CAClE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oCAAoC,CACxC,OAA+D,EAC/D,OAAwB;QAExB,OAAO,WAAW,CAAC,oDAAoD,CACrE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,8CAA8C,CAC/D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/sdk.d.ts

@@ -7,10 +7,10 @@ import { Earn } from "./earn.js";
 import { Erc4626Vaults } from "./erc4626vaults.js";
 import { Ethena } from "./ethena.js";
 import { GasSponsorship } from "./gassponsorship.js";
-import { GlobalMarketsPerps } from "./globalmarketsperps.js";
 import { Morpho } from "./morpho.js";
 import { Onramp } from "./onramp.js";
 import { Pendle } from "./pendle.js";
+import { PerpetualTrading } from "./perpetualtrading.js";
 import { Sky } from "./sky.js";
 import { SmartAccount } from "./smartaccount.js";
 import { Swap } from "./swap.js";
@@ -57,8 +57,8 @@ export declare class CompassApiSDK extends ClientSDK {
     get bridge(): Bridge;
     private _credit?;
     get credit(): Credit;
-    private _globalMarketsPerps?;
-    get globalMarketsPerps(): GlobalMarketsPerps;
+    private _perpetualTrading?;
+    get perpetualTrading(): PerpetualTrading;
     private _tokenizedAssets?;
     get tokenizedAssets(): TokenizedAssets;
     private _onramp?;

package/dist/esm/sdk/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,IAAI,GAAG,IAAI,GAAG,CAEb;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;CACF"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,IAAI,GAAG,IAAI,GAAG,CAEb;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,IAAI,gBAAgB,IAAI,gBAAgB,CAEvC;IAED,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;CACF"}

package/dist/esm/sdk/sdk.js

@@ -10,10 +10,10 @@ import { Earn } from "./earn.js";
 import { Erc4626Vaults } from "./erc4626vaults.js";
 import { Ethena } from "./ethena.js";
 import { GasSponsorship } from "./gassponsorship.js";
-import { GlobalMarketsPerps } from "./globalmarketsperps.js";
 import { Morpho } from "./morpho.js";
 import { Onramp } from "./onramp.js";
 import { Pendle } from "./pendle.js";
+import { PerpetualTrading } from "./perpetualtrading.js";
 import { Sky } from "./sky.js";
 import { SmartAccount } from "./smartaccount.js";
 import { Swap } from "./swap.js";
@@ -78,8 +78,8 @@ export class CompassApiSDK extends ClientSDK {
     get credit() {
         return (this._credit ?? (this._credit = new Credit(this._options)));
     }
-    get globalMarketsPerps() {
-        return (this._globalMarketsPerps ?? (this._globalMarketsPerps = new GlobalMarketsPerps(this._options)));
+    get perpetualTrading() {
+        return (this._perpetualTrading ?? (this._perpetualTrading = new PerpetualTrading(this._options)));
     }
     get tokenizedAssets() {
         return (this._tokenizedAssets ?? (this._tokenizedAssets = new TokenizedAssets(this._options)));

package/dist/esm/sdk/sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,aAAc,SAAQ,SAAS;IAE1C,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,GAAG;QACL,OAAO,CAAC,IAAI,CAAC,IAAI,KAAT,IAAI,CAAC,IAAI,GAAK,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChD,CAAC;IAGD,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpD,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,kBAAkB;QACpB,OAAO,CAAC,IAAI,CAAC,mBAAmB,KAAxB,IAAI,CAAC,mBAAmB,GAAK,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9E,CAAC;IAGD,IAAI,YAAY;QACd,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClE,CAAC;IAGD,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,OAAO;QACT,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxD,CAAC;IAGD,IAAI,cAAc;QAChB,OAAO,CAAC,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtE,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,kBAAkB;QACpB,OAAO,CAAC,IAAI,CAAC,mBAAmB,KAAxB,IAAI,CAAC,mBAAmB,GAAK,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9E,CAAC;IAGD,IAAI,eAAe;QACjB,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;CACF"}
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,aAAc,SAAQ,SAAS;IAE1C,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,GAAG;QACL,OAAO,CAAC,IAAI,CAAC,IAAI,KAAT,IAAI,CAAC,IAAI,GAAK,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChD,CAAC;IAGD,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpD,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,kBAAkB;QACpB,OAAO,CAAC,IAAI,CAAC,mBAAmB,KAAxB,IAAI,CAAC,mBAAmB,GAAK,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9E,CAAC;IAGD,IAAI,YAAY;QACd,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClE,CAAC;IAGD,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,OAAO;QACT,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxD,CAAC;IAGD,IAAI,cAAc;QAChB,OAAO,CAAC,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtE,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,gBAAgB;QAClB,OAAO,CAAC,IAAI,CAAC,iBAAiB,KAAtB,IAAI,CAAC,iBAAiB,GAAK,IAAI,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1E,CAAC;IAGD,IAAI,eAAe;QACjB,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;CACF"}

package/docs/models/components/perpetualtradingactivitypartialerror.md

@@ -0,0 +1,21 @@
+# PerpetualTradingActivityPartialError
+
+One section of /activity failed to load.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingActivityPartialError } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingActivityPartialError = {
+  section: "positions",
+  message: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `section`                                                | [components.Section](../../models/components/section.md) | :heavy_check_mark:                                       | N/A                                                      |
+| `message`                                                | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |