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

package/docs/sdks/perpetualtrading/README.md

@@ -0,0 +1,1274 @@
+# PerpetualTrading
+
+## Overview
+
+### Available Operations
+
+* [perpetualTradingOpportunities](#perpetualtradingopportunities) - List perpetual trading markets
+* [perpetualTradingPositions](#perpetualtradingpositions) - List perpetual trading positions
+* [perpetualTradingCandles](#perpetualtradingcandles) - Get OHLCV candles
+* [perpetualTradingActivity](#perpetualtradingactivity) - Aggregated Hyperliquid activity for a user
+* [perpetualTradingDeposit](#perpetualtradingdeposit) - Deposit USDC to perpetual trading account
+* [perpetualTradingDepositSponsorPrepare](#perpetualtradingdepositsponsorprepare) - Build the Bridge2 deposit tx from a signed permit
+* [perpetualTradingWithdraw](#perpetualtradingwithdraw) - Withdraw USDC from perpetual trading account
+* [perpetualTradingMarketOrder](#perpetualtradingmarketorder) - Place market order
+* [perpetualTradingLimitOrder](#perpetualtradinglimitorder) - Place limit order
+* [perpetualTradingCancelOrder](#perpetualtradingcancelorder) - Cancel order
+* [perpetualTradingExecute](#perpetualtradingexecute) - Execute signed action
+* [perpetualTradingApproveBuilderFee](#perpetualtradingapprovebuilderfee) - Approve builder fee
+* [perpetualTradingEnableUnifiedAccount](#perpetualtradingenableunifiedaccount) - Enable unified account mode
+* [perpetualTradingEnsureLeverage](#perpetualtradingensureleverage) - Ensure 1x cross leverage
+* [perpetualTradingSetLeverage](#perpetualtradingsetleverage) - Set leverage (defaults to market maximum)
+
+## perpetualTradingOpportunities
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_opportunities" method="get" path="/v2/perpetual_trading/opportunities" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingOpportunities({
+    sortBy: "volume_24h",
+    sortOrder: "desc",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingOpportunities } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingOpportunities.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingOpportunities(compassApiSDK, {
+    sortBy: "volume_24h",
+    sortOrder: "desc",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingOpportunities failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2PerpetualTradingOpportunitiesRequest](../../models/operations/v2perpetualtradingopportunitiesrequest.md)                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingOpportunitiesResponse](../../models/components/perpetualtradingopportunitiesresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingPositions
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_positions" method="get" path="/v2/perpetual_trading/positions" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingPositions({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingPositions } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingPositions.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingPositions(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingPositions failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2PerpetualTradingPositionsRequest](../../models/operations/v2perpetualtradingpositionsrequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingPositionsResponse](../../models/components/perpetualtradingpositionsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingCandles
+
+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).
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_candles" method="get" path="/v2/perpetual_trading/candles" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingCandles({
+    symbol: "AAPL",
+    interval: "1h",
+    limit: 200,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingCandles } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingCandles.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingCandles(compassApiSDK, {
+    symbol: "AAPL",
+    interval: "1h",
+    limit: 200,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingCandles failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2PerpetualTradingCandlesRequest](../../models/operations/v2perpetualtradingcandlesrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingCandlesResponse](../../models/components/perpetualtradingcandlesresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingActivity
+
+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).
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_activity" method="get" path="/v2/perpetual_trading/activity" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingActivity({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingActivity } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingActivity.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingActivity(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingActivity failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2PerpetualTradingActivityRequest](../../models/operations/v2perpetualtradingactivityrequest.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingActivityResponse](../../models/components/perpetualtradingactivityresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingDeposit
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_deposit" method="post" path="/v2/perpetual_trading/deposit" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingDeposit({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amount: "100.0",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingDeposit } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingDeposit.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingDeposit(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amount: "100.0",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingDeposit failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingDepositRequest](../../models/components/perpetualtradingdepositrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingDepositResponse](../../models/components/perpetualtradingdepositresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingDepositSponsorPrepare
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_deposit_sponsor_prepare" method="post" path="/v2/perpetual_trading/deposit/sponsor_prepare" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingDepositSponsorPrepare({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amountRaw: 100000000,
+    deadline: 1747097383,
+    signature: "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+    sender: "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingDepositSponsorPrepare } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingDepositSponsorPrepare.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingDepositSponsorPrepare(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amountRaw: 100000000,
+    deadline: 1747097383,
+    signature: "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+    sender: "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingDepositSponsorPrepare failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingDepositSponsorPrepareRequest](../../models/components/perpetualtradingdepositsponsorpreparerequest.md)                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingDepositSponsorPrepareResponse](../../models/components/perpetualtradingdepositsponsorprepareresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingWithdraw
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_withdraw" method="post" path="/v2/perpetual_trading/withdraw" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingWithdraw({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amount: "100.0",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingWithdraw } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingWithdraw.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingWithdraw(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    amount: "100.0",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingWithdraw failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingWithdrawRequest](../../models/components/perpetualtradingwithdrawrequest.md)                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSignableActionResponse](../../models/components/perpetualtradingsignableactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingMarketOrder
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_market_order" method="post" path="/v2/perpetual_trading/market_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingMarketOrder({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    slippagePercent: 1,
+    reduceOnly: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingMarketOrder } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingMarketOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingMarketOrder(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    slippagePercent: 1,
+    reduceOnly: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingMarketOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingMarketOrderRequest](../../models/components/perpetualtradingmarketorderrequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSignableActionResponse](../../models/components/perpetualtradingsignableactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingLimitOrder
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_limit_order" method="post" path="/v2/perpetual_trading/limit_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingLimitOrder({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    price: "190.00",
+    timeInForce: "gtc",
+    reduceOnly: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingLimitOrder } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingLimitOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingLimitOrder(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    price: "190.00",
+    timeInForce: "gtc",
+    reduceOnly: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingLimitOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingLimitOrderRequest](../../models/components/perpetualtradinglimitorderrequest.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSignableActionResponse](../../models/components/perpetualtradingsignableactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingCancelOrder
+
+Prepare an order cancellation.
+
+Returns EIP-712 typed data for the user to sign. After signing, submit
+the signature via the /execute endpoint.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_cancel_order" method="post" path="/v2/perpetual_trading/cancel_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingCancelOrder({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    orderId: 12345,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingCancelOrder } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingCancelOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingCancelOrder(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    asset: "AAPL",
+    orderId: 12345,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingCancelOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingCancelOrderRequest](../../models/components/perpetualtradingcancelorderrequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSignableActionResponse](../../models/components/perpetualtradingsignableactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingExecute
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_execute" method="post" path="/v2/perpetual_trading/execute" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingExecute({
+    action: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
+    nonce: 449590,
+    signature: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingExecute } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingExecute.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingExecute(compassApiSDK, {
+    action: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
+    nonce: 449590,
+    signature: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingExecute failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingExecuteRequest](../../models/components/perpetualtradingexecuterequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingExecuteResponse](../../models/components/perpetualtradingexecuteresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingApproveBuilderFee
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_approve_builder_fee" method="post" path="/v2/perpetual_trading/approve_builder_fee" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingApproveBuilderFee({
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    builder: {
+      address: "0x88806A71D74AD0a510B350545C9AE490912F0888",
+      maxFeeRate: "0.01%",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingApproveBuilderFee } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingApproveBuilderFee.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingApproveBuilderFee(compassApiSDK, {
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    builder: {
+      address: "0x88806A71D74AD0a510B350545C9AE490912F0888",
+      maxFeeRate: "0.01%",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingApproveBuilderFee failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingApproveBuilderFeeRequest](../../models/components/perpetualtradingapprovebuilderfeerequest.md)                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSignableActionResponse](../../models/components/perpetualtradingsignableactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingEnableUnifiedAccount
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_enable_unified_account" method="post" path="/v2/perpetual_trading/enable_unified_account" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingEnableUnifiedAccount({
+    owner: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingEnableUnifiedAccount } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingEnableUnifiedAccount.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingEnableUnifiedAccount(compassApiSDK, {
+    owner: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingEnableUnifiedAccount failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingEnableUnifiedAccountRequest](../../models/components/perpetualtradingenableunifiedaccountrequest.md)                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingEnableUnifiedAccountResponse](../../models/components/perpetualtradingenableunifiedaccountresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingEnsureLeverage
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_ensure_leverage" method="post" path="/v2/perpetual_trading/ensure_leverage" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingEnsureLeverage({
+    owner: "<value>",
+    asset: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingEnsureLeverage } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingEnsureLeverage.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingEnsureLeverage(compassApiSDK, {
+    owner: "<value>",
+    asset: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingEnsureLeverage failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingEnsureLeverageRequest](../../models/components/perpetualtradingensureleveragerequest.md)                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingEnsureLeverageResponse](../../models/components/perpetualtradingensureleverageresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## perpetualTradingSetLeverage
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_perpetual_trading_set_leverage" method="post" path="/v2/perpetual_trading/set_leverage" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.perpetualTrading.perpetualTradingSetLeverage({
+    owner: "<value>",
+    asset: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { perpetualTradingPerpetualTradingSetLeverage } from "@compass-labs/api-sdk/funcs/perpetualTradingPerpetualTradingSetLeverage.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await perpetualTradingPerpetualTradingSetLeverage(compassApiSDK, {
+    owner: "<value>",
+    asset: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("perpetualTradingPerpetualTradingSetLeverage failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PerpetualTradingSetLeverageRequest](../../models/components/perpetualtradingsetleveragerequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.PerpetualTradingSetLeverageResponse](../../models/components/perpetualtradingsetleverageresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |