@compass-labs/api-sdk 2.2.48 → 2.2.49-rc.0

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

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

package/docs/models/components/globalmarketsperpspositionsresponse.md

@@ -0,0 +1,23 @@
+# GlobalMarketsPerpsPositionsResponse
+
+List of open global markets perps positions with account balance.
+
+## Example Usage
+
+```typescript
+import { GlobalMarketsPerpsPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: GlobalMarketsPerpsPositionsResponse = {
+  positions: [],
+  accountValue: "0",
+  withdrawable: "0",
+};
+```
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      | Example                                                                                          |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `positions`                                                                                      | [components.GlobalMarketsPerpsPosition](../../models/components/globalmarketsperpsposition.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 → globalmarketsperpssignableactionresponse.md}

@@ -1,19 +1,18 @@
-# TraditionalInvestingSignableActionResponse
+# GlobalMarketsPerpsSignableActionResponse
 
 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";
+import { GlobalMarketsPerpsSignableActionResponse } from "@compass-labs/api-sdk/models/components";
 
-let value: TraditionalInvestingSignableActionResponse = {
+let value: GlobalMarketsPerpsSignableActionResponse = {
   typedData: {},
   action: {
     "key": "<value>",
-    "key1": "<value>",
   },
-  nonce: 585455,
+  nonce: 15572,
 };
 ```
 

package/docs/models/components/globalmarketsperpswithdrawrequest.md

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

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

package/docs/models/operations/globalmarketsperpssortorder.md

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

package/docs/models/operations/v2globalmarketsperpsopportunitiesrequest.md

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

package/docs/models/operations/v2globalmarketsperpspositionsrequest.md

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