@compass-labs/api-sdk 2.2.34-rc.0 → 2.2.34-rc.10

package/docs/models/components/traditionalinvestingexecuterequest.md

@@ -0,0 +1,27 @@
+# TraditionalInvestingExecuteRequest
+
+Submit a signed Hyperliquid action for execution.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingExecuteRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingExecuteRequest = {
+  action: {
+    "key": "<value>",
+    "key1": "<value>",
+  },
+  nonce: 371029,
+  signature: "<value>",
+};
+```
+
+## Fields
+
+| Field                                        | Type                                         | Required                                     | Description                                  |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| `action`                                     | Record<string, *any*>                        | :heavy_check_mark:                           | Raw Hyperliquid action from the prepare step |
+| `nonce`                                      | *number*                                     | :heavy_check_mark:                           | Nonce from the prepare step                  |
+| `signature`                                  | *string*                                     | :heavy_check_mark:                           | User's EIP-712 signature (hex, 65 bytes)     |
+| `vaultAddress`                               | *string*                                     | :heavy_minus_sign:                           | Optional vault address                       |

package/docs/models/components/traditionalinvestingexecuteresponse.md

@@ -0,0 +1,20 @@
+# TraditionalInvestingExecuteResponse
+
+Returned after submitting a signed action to the Hyperliquid exchange.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingExecuteResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingExecuteResponse = {
+  status: "<value>",
+};
+```
+
+## Fields
+
+| Field                                            | Type                                             | Required                                         | Description                                      |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| `status`                                         | *string*                                         | :heavy_check_mark:                               | 'ok' or 'error'                                  |
+| `response`                                       | Record<string, *any*>                            | :heavy_minus_sign:                               | Hyperliquid response data (order statuses, etc.) |

package/docs/models/components/{tradfilimitorderrequest.md → traditionalinvestinglimitorderrequest.md}

@@ -1,13 +1,13 @@
-# TradFiLimitOrderRequest
+# TraditionalInvestingLimitOrderRequest
 
-Request to place a limit order on a TradFi perp market.
+Request to place a limit order on a traditional investing perp market.
 
 ## Example Usage
 
 ```typescript
-import { TradFiLimitOrderRequest } from "@compass-labs/api-sdk/models/components";
+import { TraditionalInvestingLimitOrderRequest } from "@compass-labs/api-sdk/models/components";
 
-let value: TradFiLimitOrderRequest = {
+let value: TraditionalInvestingLimitOrderRequest = {
   owner: "0x01E62835dd7F52173546A325294762143eE4a882",
   asset: "AAPL",
   side: "buy",
@@ -22,7 +22,7 @@ let value: TradFiLimitOrderRequest = {
 
 | Field                                                                | Type                                                                 | Required                                                             | Description                                                          | Example                                                              |
 | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `owner`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Owner of the TradFi product account                                  | 0x01E62835dd7F52173546A325294762143eE4a882                           |
+| `owner`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Owner of the traditional investing product account                   | 0x01E62835dd7F52173546A325294762143eE4a882                           |
 | `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                                                                 |

package/docs/models/components/{tradfimarketorderrequest.md → traditionalinvestingmarketorderrequest.md}

@@ -1,13 +1,13 @@
-# TradFiMarketOrderRequest
+# TraditionalInvestingMarketOrderRequest
 
-Request to place a market order on a TradFi perp market.
+Request to place a market order on a traditional investing perp market.
 
 ## Example Usage
 
 ```typescript
-import { TradFiMarketOrderRequest } from "@compass-labs/api-sdk/models/components";
+import { TraditionalInvestingMarketOrderRequest } from "@compass-labs/api-sdk/models/components";
 
-let value: TradFiMarketOrderRequest = {
+let value: TraditionalInvestingMarketOrderRequest = {
   owner: "0x01E62835dd7F52173546A325294762143eE4a882",
   asset: "AAPL",
   side: "buy",
@@ -21,7 +21,7 @@ let value: TradFiMarketOrderRequest = {
 
 | Field                                               | Type                                                | Required                                            | Description                                         | Example                                             |
 | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
-| `owner`                                             | *string*                                            | :heavy_check_mark:                                  | Owner of the TradFi product account                 | 0x01E62835dd7F52173546A325294762143eE4a882          |
+| `owner`                                             | *string*                                            | :heavy_check_mark:                                  | Owner of the traditional investing product account  | 0x01E62835dd7F52173546A325294762143eE4a882          |
 | `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                                                |

package/docs/models/components/traditionalinvestingopportunitiesresponse.md

@@ -0,0 +1,32 @@
+# TraditionalInvestingOpportunitiesResponse
+
+List of available traditional investing perpetual futures markets.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingOpportunitiesResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingOpportunitiesResponse = {
+  opportunities: [
+    {
+      asset: "<value>",
+      assetId: 48952,
+      category: "<value>",
+      markPrice: "<value>",
+      oraclePrice: "<value>",
+      openInterest: "<value>",
+      volume24h: "<value>",
+      fundingRate: "<value>",
+      maxLeverage: 9470,
+      szDecimals: 45983,
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `opportunities`                                                                                            | [components.TraditionalInvestingOpportunity](../../models/components/traditionalinvestingopportunity.md)[] | :heavy_check_mark:                                                                                         | Available traditional investing perp markets                                                               |

package/docs/models/components/{tradfiopportunity.md → traditionalinvestingopportunity.md}

@@ -1,23 +1,23 @@
-# TradFiOpportunity
+# TraditionalInvestingOpportunity
 
-A single TradFi perpetual futures market.
+A single traditional investing perpetual futures market.
 
 ## Example Usage
 
 ```typescript
-import { TradFiOpportunity } from "@compass-labs/api-sdk/models/components";
+import { TraditionalInvestingOpportunity } from "@compass-labs/api-sdk/models/components";
 
-let value: TradFiOpportunity = {
+let value: TraditionalInvestingOpportunity = {
   asset: "<value>",
-  assetId: 533779,
+  assetId: 917799,
   category: "<value>",
   markPrice: "<value>",
   oraclePrice: "<value>",
   openInterest: "<value>",
   volume24h: "<value>",
   fundingRate: "<value>",
-  maxLeverage: 455095,
-  szDecimals: 608263,
+  maxLeverage: 325006,
+  szDecimals: 783904,
 };
 ```
 

package/docs/models/components/{tradfiposition.md → traditionalinvestingposition.md}

@@ -1,15 +1,15 @@
-# TradFiPosition
+# TraditionalInvestingPosition
 
 A single open perpetual futures position.
 
 ## Example Usage
 
 ```typescript
-import { TradFiPosition } from "@compass-labs/api-sdk/models/components";
+import { TraditionalInvestingPosition } from "@compass-labs/api-sdk/models/components";
 
-let value: TradFiPosition = {
+let value: TraditionalInvestingPosition = {
   asset: "<value>",
-  assetId: 655196,
+  assetId: 607062,
   side: "long",
   size: "<value>",
   entryPrice: "<value>",

package/docs/models/components/traditionalinvestingpositionsresponse.md

@@ -0,0 +1,23 @@
+# TraditionalInvestingPositionsResponse
+
+List of open traditional investing perp positions with account balance.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingPositionsResponse = {
+  positions: [],
+  accountValue: "0",
+  withdrawable: "0",
+};
+```
+
+## Fields
+
+| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          | Example                                                                                              |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `positions`                                                                                          | [components.TraditionalInvestingPosition](../../models/components/traditionalinvestingposition.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/traditionalinvestingsignableactionresponse.md

@@ -0,0 +1,26 @@
+# TraditionalInvestingSignableActionResponse
+
+Returned by prepare endpoints — contains EIP-712 typed data for the user to sign.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingSignableActionResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingSignableActionResponse = {
+  typedData: {},
+  action: {
+    "key": "<value>",
+    "key1": "<value>",
+  },
+  nonce: 585455,
+};
+```
+
+## 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/traditionalinvestingwithdrawrequest.md

@@ -0,0 +1,22 @@
+# TraditionalInvestingWithdrawRequest
+
+Request to withdraw USDC from HyperEVM traditional investing account to Arbitrum.
+
+## Example Usage
+
+```typescript
+import { TraditionalInvestingWithdrawRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TraditionalInvestingWithdrawRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  amount: "100.0",
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         | Example                                                             |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `owner`                                                             | *string*                                                            | :heavy_check_mark:                                                  | The user's EOA address (owner of the traditional investing account) | 0x01E62835dd7F52173546A325294762143eE4a882                          |
+| `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/traditionalinvestingsortby.md

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

package/docs/models/operations/traditionalinvestingsortorder.md

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

package/docs/models/operations/v2traditionalinvestingopportunitiesrequest.md

@@ -0,0 +1,22 @@
+# V2TraditionalInvestingOpportunitiesRequest
+
+## Example Usage
+
+```typescript
+import { V2TraditionalInvestingOpportunitiesRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2TraditionalInvestingOpportunitiesRequest = {
+  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.TraditionalInvestingCategory](../../models/components/traditionalinvestingcategory.md)   | :heavy_minus_sign:                                                                                   | Filter by asset category: stock, commodity, forex                                                    |                                                                                                      |
+| `sortBy`                                                                                             | [operations.TraditionalInvestingSortBy](../../models/operations/traditionalinvestingsortby.md)       | :heavy_minus_sign:                                                                                   | Sort results by this field                                                                           | volume_24h                                                                                           |
+| `sortOrder`                                                                                          | [operations.TraditionalInvestingSortOrder](../../models/operations/traditionalinvestingsortorder.md) | :heavy_minus_sign:                                                                                   | Sort direction                                                                                       | desc                                                                                                 |

package/docs/models/operations/v2traditionalinvestingpositionsrequest.md

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