@compass-labs/api-sdk 2.2.92 → 2.2.93

package/docs/models/components/perpetualtradingmarketorderrequest.md

@@ -0,0 +1,30 @@
+# PerpetualTradingMarketOrderRequest
+
+Request to place a market order on a perpetual trading market.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingMarketOrderRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingMarketOrderRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  asset: "AAPL",
+  side: "buy",
+  size: "10.0",
+  slippagePercent: 1,
+  reduceOnly: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Owner of the perpetual trading product account                                                                                                                                                                                                                  | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                                      |
+| `asset`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Asset ticker symbol (e.g. AAPL, GOLD, EUR)                                                                                                                                                                                                                      | AAPL                                                                                                                                                                                                                                                            |
+| `side`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Order side: 'buy' or 'sell'                                                                                                                                                                                                                                     | buy                                                                                                                                                                                                                                                             |
+| `size`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Number of contracts (human-readable)                                                                                                                                                                                                                            | 10.0                                                                                                                                                                                                                                                            |
+| `slippagePercent`                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Max slippage percentage for price protection                                                                                                                                                                                                                    | 1                                                                                                                                                                                                                                                               |
+| `reduceOnly`                                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                              | If true, order can only reduce an existing position                                                                                                                                                                                                             | false                                                                                                                                                                                                                                                           |
+| `builder`                                                                                                                                                                                                                                                       | [components.Builder](../../models/components/builder.md)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Optional builder fee. When provided, the order action carries the builder address and fee — the end-user must have already approved this builder via /approve_builder_fee up to at least this rate. Omit (or pass null) to place the order with no builder fee. |                                                                                                                                                                                                                                                                 |

package/docs/models/components/perpetualtradingopenorder.md

@@ -0,0 +1,31 @@
+# PerpetualTradingOpenOrder
+
+A single resting order from HL `openOrders`.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingOpenOrder } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingOpenOrder = {
+  asset: "<value>",
+  side: "sell",
+  limitPrice: "<value>",
+  size: "<value>",
+  orderId: 532786,
+  timeMs: 605048,
+  reduceOnly: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `asset`                                                                                              | *string*                                                                                             | :heavy_check_mark:                                                                                   | Asset ticker symbol (xyz prefix stripped)                                                            |
+| `side`                                                                                               | [components.PerpetualTradingOpenOrderSide](../../models/components/perpetualtradingopenorderside.md) | :heavy_check_mark:                                                                                   | Order side                                                                                           |
+| `limitPrice`                                                                                         | *string*                                                                                             | :heavy_check_mark:                                                                                   | Limit price                                                                                          |
+| `size`                                                                                               | *string*                                                                                             | :heavy_check_mark:                                                                                   | Order size in contracts                                                                              |
+| `orderId`                                                                                            | *number*                                                                                             | :heavy_check_mark:                                                                                   | HL order id (oid)                                                                                    |
+| `timeMs`                                                                                             | *number*                                                                                             | :heavy_check_mark:                                                                                   | Order timestamp (ms since epoch)                                                                     |
+| `reduceOnly`                                                                                         | *boolean*                                                                                            | :heavy_check_mark:                                                                                   | True if order can only reduce position                                                               |

package/docs/models/components/perpetualtradingopenorderside.md

@@ -0,0 +1,17 @@
+# PerpetualTradingOpenOrderSide
+
+Order side
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingOpenOrderSide } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingOpenOrderSide = "buy";
+```
+
+## Values
+
+```typescript
+"buy" | "sell"
+```

package/docs/models/components/perpetualtradingopportunitiesresponse.md

@@ -0,0 +1,19 @@
+# PerpetualTradingOpportunitiesResponse
+
+List of available perpetual trading markets.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingOpportunitiesResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingOpportunitiesResponse = {
+  opportunities: [],
+};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `opportunities`                                                                                    | [components.PerpetualTradingOpportunity](../../models/components/perpetualtradingopportunity.md)[] | :heavy_check_mark:                                                                                 | Available perpetual trading markets                                                                |

package/docs/models/components/perpetualtradingopportunity.md

@@ -0,0 +1,37 @@
+# PerpetualTradingOpportunity
+
+A single perpetual trading market.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingOpportunity } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingOpportunity = {
+  asset: "<value>",
+  assetId: 644289,
+  category: "<value>",
+  markPrice: "<value>",
+  oraclePrice: "<value>",
+  openInterest: "<value>",
+  volume24h: "<value>",
+  fundingRate: "<value>",
+  maxLeverage: 979895,
+  szDecimals: 788739,
+};
+```
+
+## Fields
+
+| Field                                      | Type                                       | Required                                   | Description                                |
+| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
+| `asset`                                    | *string*                                   | :heavy_check_mark:                         | Asset ticker symbol (e.g. AAPL, GOLD, EUR) |
+| `assetId`                                  | *number*                                   | :heavy_check_mark:                         | Hyperliquid asset index                    |
+| `category`                                 | *string*                                   | :heavy_check_mark:                         | Asset category: stock, commodity, forex    |
+| `markPrice`                                | *string*                                   | :heavy_check_mark:                         | Current mark price                         |
+| `oraclePrice`                              | *string*                                   | :heavy_check_mark:                         | Oracle reference price                     |
+| `openInterest`                             | *string*                                   | :heavy_check_mark:                         | Open interest in USD                       |
+| `volume24h`                                | *string*                                   | :heavy_check_mark:                         | 24-hour trading volume in USD              |
+| `fundingRate`                              | *string*                                   | :heavy_check_mark:                         | Current hourly funding rate                |
+| `maxLeverage`                              | *number*                                   | :heavy_check_mark:                         | Maximum allowed leverage                   |
+| `szDecimals`                               | *number*                                   | :heavy_check_mark:                         | Size decimal places for order quantities   |

package/docs/models/components/perpetualtradingposition.md

@@ -0,0 +1,38 @@
+# PerpetualTradingPosition
+
+A single open perpetual futures position.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingPosition = {
+  asset: "<value>",
+  assetId: 6010,
+  side: "long",
+  size: "<value>",
+  entryPrice: "<value>",
+  markPrice: "<value>",
+  unrealizedPnl: "<value>",
+  leverage: "<value>",
+  marginUsed: "<value>",
+  fundingAccrued: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `asset`                                                                                            | *string*                                                                                           | :heavy_check_mark:                                                                                 | Asset ticker symbol                                                                                |
+| `assetId`                                                                                          | *number*                                                                                           | :heavy_check_mark:                                                                                 | Hyperliquid asset index                                                                            |
+| `side`                                                                                             | [components.PerpetualTradingPositionSide](../../models/components/perpetualtradingpositionside.md) | :heavy_check_mark:                                                                                 | Position side: 'long' or 'short'                                                                   |
+| `size`                                                                                             | *string*                                                                                           | :heavy_check_mark:                                                                                 | Position size in contracts                                                                         |
+| `entryPrice`                                                                                       | *string*                                                                                           | :heavy_check_mark:                                                                                 | Average entry price                                                                                |
+| `markPrice`                                                                                        | *string*                                                                                           | :heavy_check_mark:                                                                                 | Current mark price                                                                                 |
+| `liquidationPrice`                                                                                 | *string*                                                                                           | :heavy_minus_sign:                                                                                 | Estimated liquidation price                                                                        |
+| `unrealizedPnl`                                                                                    | *string*                                                                                           | :heavy_check_mark:                                                                                 | Unrealized PnL in USD                                                                              |
+| `leverage`                                                                                         | *string*                                                                                           | :heavy_check_mark:                                                                                 | Current leverage                                                                                   |
+| `marginUsed`                                                                                       | *string*                                                                                           | :heavy_check_mark:                                                                                 | Margin used for this position in USD                                                               |
+| `fundingAccrued`                                                                                   | *string*                                                                                           | :heavy_check_mark:                                                                                 | Cumulative funding payments (negative = paid)                                                      |

package/docs/models/components/perpetualtradingpositionside.md

@@ -0,0 +1,17 @@
+# PerpetualTradingPositionSide
+
+Position side: 'long' or 'short'
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingPositionSide } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingPositionSide = "short";
+```
+
+## Values
+
+```typescript
+"long" | "short"
+```

package/docs/models/components/perpetualtradingpositionsresponse.md

@@ -0,0 +1,36 @@
+# PerpetualTradingPositionsResponse
+
+List of open perpetual trading positions with account balance.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingPositionsResponse = {
+  positions: [
+    {
+      asset: "<value>",
+      assetId: 860534,
+      side: "short",
+      size: "<value>",
+      entryPrice: "<value>",
+      markPrice: "<value>",
+      unrealizedPnl: "<value>",
+      leverage: "<value>",
+      marginUsed: "<value>",
+      fundingAccrued: "<value>",
+    },
+  ],
+  accountValue: "0",
+  withdrawable: "0",
+};
+```
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  | Example                                                                                      |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `positions`                                                                                  | [components.PerpetualTradingPosition](../../models/components/perpetualtradingposition.md)[] | :heavy_check_mark:                                                                           | Open perpetual futures positions                                                             |                                                                                              |
+| `accountValue`                                                                               | *string*                                                                                     | :heavy_minus_sign:                                                                           | Total account value in USD (margin + unrealized PnL)                                         | 0                                                                                            |
+| `withdrawable`                                                                               | *string*                                                                                     | :heavy_minus_sign:                                                                           | Available USDC balance (withdrawable margin)                                                 | 0                                                                                            |

package/docs/models/components/perpetualtradingsetleveragerequest.md

@@ -0,0 +1,24 @@
+# PerpetualTradingSetLeverageRequest
+
+Request to set leverage on a perpetual trading asset.
+
+Omit ``leverage`` (or pass null) to target the asset's maximum leverage.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingSetLeverageRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingSetLeverageRequest = {
+  owner: "<value>",
+  asset: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                       | Type                                                                                                                                                                                                        | Required                                                                                                                                                                                                    | Description                                                                                                                                                                                                 |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                          | User's EOA address                                                                                                                                                                                          |
+| `asset`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                          | Asset ticker (e.g. 'AAPL', 'CL')                                                                                                                                                                            |
+| `leverage`                                                                                                                                                                                                  | *number*                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                          | Target leverage as a whole-number multiplier. Omit (or pass null) to use the asset's maximum leverage. Must be between 1 and the asset's max leverage, which is available from the /opportunities endpoint. |

package/docs/models/components/perpetualtradingsetleverageresponse.md

@@ -0,0 +1,25 @@
+# PerpetualTradingSetLeverageResponse
+
+Returned by the set_leverage endpoint.
+
+If the asset is already at the requested leverage, typed_data/action/nonce
+are null. If not, they contain the EIP-712 payload the user must sign.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingSetLeverageResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingSetLeverageResponse = {
+  leverageOk: true,
+};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `leverageOk`                                                                       | *boolean*                                                                          | :heavy_check_mark:                                                                 | True if leverage already matches the requested value, false if an update is needed |
+| `typedData`                                                                        | Record<string, *any*>                                                              | :heavy_minus_sign:                                                                 | EIP-712 typed data for wallet signing, or null if no change is needed              |
+| `action`                                                                           | Record<string, *any*>                                                              | :heavy_minus_sign:                                                                 | Raw Hyperliquid action (passed back to the execute endpoint), or null              |
+| `nonce`                                                                            | *number*                                                                           | :heavy_minus_sign:                                                                 | Timestamp-based nonce, or null if no action needed                                 |

package/docs/models/components/perpetualtradingsignableactionresponse.md

@@ -0,0 +1,26 @@
+# PerpetualTradingSignableActionResponse
+
+Returned by prepare endpoints — contains EIP-712 typed data for the user to sign.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingSignableActionResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingSignableActionResponse = {
+  typedData: {},
+  action: {
+    "key": "<value>",
+    "key1": "<value>",
+  },
+  nonce: 425323,
+};
+```
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `typedData`                                                                 | Record<string, *any*>                                                       | :heavy_check_mark:                                                          | EIP-712 typed data for wallet signing (domain, types, primaryType, message) |
+| `action`                                                                    | Record<string, *any*>                                                       | :heavy_check_mark:                                                          | Raw Hyperliquid action (passed back to the execute endpoint)                |
+| `nonce`                                                                     | *number*                                                                    | :heavy_check_mark:                                                          | Timestamp-based nonce used during signing                                   |

package/docs/models/components/perpetualtradingwithdrawrequest.md

@@ -0,0 +1,22 @@
+# PerpetualTradingWithdrawRequest
+
+Request to withdraw USDC from HyperEVM perpetual trading account to Arbitrum.
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingWithdrawRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: PerpetualTradingWithdrawRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  amount: "100.0",
+};
+```
+
+## Fields
+
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       | Example                                                           |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `owner`                                                           | *string*                                                          | :heavy_check_mark:                                                | The user's EOA address (owner of the perpetual trading account)   | 0x06A9aF046187895AcFc7258450B15397CAc67400                        |
+| `amount`                                                          | *string*                                                          | :heavy_check_mark:                                                | USDC amount to withdraw (human-readable, e.g. '500.0')            | 100.0                                                             |
+| `destination`                                                     | *string*                                                          | :heavy_minus_sign:                                                | Arbitrum destination address (defaults to owner if not specified) |                                                                   |

package/docs/models/operations/perpetualtradingsortby.md

@@ -0,0 +1,17 @@
+# PerpetualTradingSortBy
+
+Sort results by this field
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingSortBy } from "@compass-labs/api-sdk/models/operations";
+
+let value: PerpetualTradingSortBy = "volume_24h";
+```
+
+## Values
+
+```typescript
+"open_interest" | "volume_24h" | "funding_rate"
+```

package/docs/models/operations/perpetualtradingsortorder.md

@@ -0,0 +1,17 @@
+# PerpetualTradingSortOrder
+
+Sort direction
+
+## Example Usage
+
+```typescript
+import { PerpetualTradingSortOrder } from "@compass-labs/api-sdk/models/operations";
+
+let value: PerpetualTradingSortOrder = "desc";
+```
+
+## Values
+
+```typescript
+"asc" | "desc"
+```

package/docs/models/operations/v2perpetualtradingactivityrequest.md

@@ -0,0 +1,18 @@
+# V2PerpetualTradingActivityRequest
+
+## Example Usage
+
+```typescript
+import { V2PerpetualTradingActivityRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2PerpetualTradingActivityRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                 | Type                                                                                                                                  | Required                                                                                                                              | Description                                                                                                                           | Example                                                                                                                               |
+| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                               | *string*                                                                                                                              | :heavy_check_mark:                                                                                                                    | End-user EOA whose activity should be fetched.                                                                                        | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                            |
+| `builder`                                                                                                                             | *string*                                                                                                                              | :heavy_minus_sign:                                                                                                                    | Optional builder address. When provided, the response includes the current builder-fee approval state for this (owner, builder) pair. |                                                                                                                                       |

package/docs/models/operations/v2perpetualtradingcandlesrequest.md

@@ -0,0 +1,23 @@
+# V2PerpetualTradingCandlesRequest
+
+## Example Usage
+
+```typescript
+import { V2PerpetualTradingCandlesRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2PerpetualTradingCandlesRequest = {
+  symbol: "AAPL",
+  interval: "1h",
+  limit: 200,
+};
+```
+
+## Fields
+
+| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    | Example                                                                                                        |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `symbol`                                                                                                       | *string*                                                                                                       | :heavy_check_mark:                                                                                             | Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.    | AAPL                                                                                                           |
+| `interval`                                                                                                     | [operations.CandleInterval](../../models/operations/candleinterval.md)                                         | :heavy_check_mark:                                                                                             | Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w                                                                   | 1h                                                                                                             |
+| `limit`                                                                                                        | *number*                                                                                                       | :heavy_minus_sign:                                                                                             | Number of candles to return (max 5000, capped by Hyperliquid).                                                 | 200                                                                                                            |
+| `startTime`                                                                                                    | *number*                                                                                                       | :heavy_minus_sign:                                                                                             | Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval. |                                                                                                                |
+| `endTime`                                                                                                      | *number*                                                                                                       | :heavy_minus_sign:                                                                                             | Optional end of the candle window in unix milliseconds. Defaults to now.                                       |                                                                                                                |

package/docs/models/operations/v2perpetualtradingopportunitiesrequest.md

@@ -0,0 +1,22 @@
+# V2PerpetualTradingOpportunitiesRequest
+
+## Example Usage
+
+```typescript
+import { V2PerpetualTradingOpportunitiesRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2PerpetualTradingOpportunitiesRequest = {
+  sortBy: "volume_24h",
+  sortOrder: "desc",
+};
+```
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  | Example                                                                                      |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `minOpenInterest`                                                                            | *number*                                                                                     | :heavy_minus_sign:                                                                           | Filter by minimum open interest in USD                                                       |                                                                                              |
+| `minVolume24h`                                                                               | *number*                                                                                     | :heavy_minus_sign:                                                                           | Filter by minimum 24h volume in USD                                                          |                                                                                              |
+| `category`                                                                                   | [components.PerpetualTradingCategory](../../models/components/perpetualtradingcategory.md)   | :heavy_minus_sign:                                                                           | Filter by asset category: stock, commodity, forex                                            |                                                                                              |
+| `sortBy`                                                                                     | [operations.PerpetualTradingSortBy](../../models/operations/perpetualtradingsortby.md)       | :heavy_minus_sign:                                                                           | Sort results by this field                                                                   | volume_24h                                                                                   |
+| `sortOrder`                                                                                  | [operations.PerpetualTradingSortOrder](../../models/operations/perpetualtradingsortorder.md) | :heavy_minus_sign:                                                                           | Sort direction                                                                               | desc                                                                                         |

package/docs/models/operations/v2perpetualtradingpositionsrequest.md

@@ -0,0 +1,18 @@
+# V2PerpetualTradingPositionsRequest
+
+## Example Usage
+
+```typescript
+import { V2PerpetualTradingPositionsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2PerpetualTradingPositionsRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           | Example                                                               |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `owner`                                                               | *string*                                                              | :heavy_check_mark:                                                    | User's EOA address (looks up their perpetual trading product account) | 0x06A9aF046187895AcFc7258450B15397CAc67400                            |
+| `asset`                                                               | *string*                                                              | :heavy_minus_sign:                                                    | Filter to a specific asset ticker (e.g. AAPL)                         |                                                                       |