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

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

@@ -0,0 +1 @@
+{"version":3,"file":"tradfi.d.ts","sourceRoot":"","sources":["../../../src/sdk/tradfi.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;OAWG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;;;OAWG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;OAUG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;OAUG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;OAYG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;OAWG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;OAQG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAO3C"}

package/dist/esm/sdk/tradfi.js

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { tradFiTradfiCancelOrder } from "../funcs/tradFiTradfiCancelOrder.js";
+import { tradFiTradfiCreateAccount } from "../funcs/tradFiTradfiCreateAccount.js";
+import { tradFiTradfiDeposit } from "../funcs/tradFiTradfiDeposit.js";
+import { tradFiTradfiLimitOrder } from "../funcs/tradFiTradfiLimitOrder.js";
+import { tradFiTradfiMarketOrder } from "../funcs/tradFiTradfiMarketOrder.js";
+import { tradFiTradfiOpportunities } from "../funcs/tradFiTradfiOpportunities.js";
+import { tradFiTradfiPositions } from "../funcs/tradFiTradfiPositions.js";
+import { tradFiTradfiWithdraw } from "../funcs/tradFiTradfiWithdraw.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export class TradFi extends ClientSDK {
+    /**
+     * List TradFi perp markets
+     *
+     * @remarks
+     * List available TradFi perpetual futures markets with key metrics.
+     *
+     * Returns tradfi perp markets (stocks, commodities, forex) with open interest,
+     * 24h volume, funding rate, and max leverage. Supports filtering by category,
+     * minimum OI/volume, and sorting.
+     *
+     * Only tradfi assets are returned — crypto perps are excluded.
+     */
+    async tradfiOpportunities(request, options) {
+        return unwrapAsync(tradFiTradfiOpportunities(this, request, options));
+    }
+    /**
+     * List TradFi positions
+     *
+     * @remarks
+     * List open perpetual futures positions for a user's TradFi account.
+     *
+     * Returns position data including size, entry price, mark price, PnL, liquidation price,
+     * leverage, and cumulative funding. Optionally filter by asset ticker.
+     *
+     * Returns 404 if the user has no TradFi product account.
+     * Returns an empty list if no positions are open.
+     */
+    async tradfiPositions(request, options) {
+        return unwrapAsync(tradFiTradfiPositions(this, request, options));
+    }
+    /**
+     * Create TradFi account
+     *
+     * @remarks
+     * Create a TradFi product account on HyperEVM.
+     *
+     * Before trading perpetual futures or depositing USDC, the owner must create a TradFi
+     * product account. Each wallet address has one TradFi account.
+     *
+     * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts
+     * this transaction on HyperEVM (gas paid in HYPE).
+     */
+    async tradfiCreateAccount(request, options) {
+        return unwrapAsync(tradFiTradfiCreateAccount(this, request, options));
+    }
+    /**
+     * Deposit USDC to TradFi account
+     *
+     * @remarks
+     * Bridge USDC from Arbitrum to the TradFi account on HyperEVM.
+     *
+     * Returns unsigned Arbitrum transactions: USDC approval (if current allowance is insufficient)
+     * followed by a bridge deposit to the Hyperliquid Arbitrum bridge contract.
+     *
+     * After the bridge deposit confirms, USDC lands on HyperCore and can be used for trading.
+     */
+    async tradfiDeposit(request, options) {
+        return unwrapAsync(tradFiTradfiDeposit(this, request, options));
+    }
+    /**
+     * Withdraw USDC from TradFi account
+     *
+     * @remarks
+     * Withdraw USDC from HyperEVM Safe back to Arbitrum.
+     *
+     * Returns unsigned HyperEVM transactions to transfer USDC from the Safe to HyperCore,
+     * then initiate a withdrawal to the destination address on Arbitrum.
+     *
+     * Withdrawal processing takes minutes to hours depending on bridge conditions.
+     */
+    async tradfiWithdraw(request, options) {
+        return unwrapAsync(tradFiTradfiWithdraw(this, request, options));
+    }
+    /**
+     * Place market order
+     *
+     * @remarks
+     * Place a market order on a TradFi perpetual futures market.
+     *
+     * Executes as an IOC (Immediate or Cancel) order at the current mark price with
+     * slippage protection. The transaction is a Safe execTransaction wrapping a
+     * CoreWriter call on HyperEVM.
+     *
+     * Orders are asynchronous — execution confirms a few seconds after the transaction,
+     * not atomically.
+     */
+    async tradfiMarketOrder(request, options) {
+        return unwrapAsync(tradFiTradfiMarketOrder(this, request, options));
+    }
+    /**
+     * Place limit order
+     *
+     * @remarks
+     * Place a limit order on a TradFi perpetual futures market.
+     *
+     * Supports GTC (Good Til Cancel) and ALO (Add Liquidity Only) time-in-force types.
+     * The transaction is a Safe execTransaction wrapping a CoreWriter call on HyperEVM.
+     *
+     * Orders are asynchronous — execution confirms a few seconds after the transaction,
+     * not atomically.
+     */
+    async tradfiLimitOrder(request, options) {
+        return unwrapAsync(tradFiTradfiLimitOrder(this, request, options));
+    }
+    /**
+     * Cancel order
+     *
+     * @remarks
+     * Cancel an open order on a TradFi perpetual futures market.
+     *
+     * Cancel by either Hyperliquid order ID or client order ID. The transaction is a
+     * Safe execTransaction wrapping a CoreWriter call on HyperEVM.
+     */
+    async tradfiCancelOrder(request, options) {
+        return unwrapAsync(tradFiTradfiCancelOrder(this, request, options));
+    }
+}
+//# sourceMappingURL=tradfi.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tradfi.js","sourceRoot":"","sources":["../../../src/sdk/tradfi.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/models/components/chain.md

@@ -7,11 +7,11 @@ The chain to use.
 ```typescript
 import { Chain } from "@compass-labs/api-sdk/models/components";
 
-let value: Chain = "base";
+let value: Chain = "ethereum";
 ```
 
 ## Values
 
 ```typescript
-"base" | "ethereum" | "arbitrum"
+"base" | "ethereum" | "arbitrum" | "hyperevm"
 ```

package/docs/models/components/createtradfiaccountrequest.md

@@ -0,0 +1,24 @@
+# CreateTradFiAccountRequest
+
+Request to create a TradFi product account on HyperEVM.
+
+## Example Usage
+
+```typescript
+import { CreateTradFiAccountRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateTradFiAccountRequest = {
+  chain: "hyperevm",
+  sender: "0x01E62835dd7F52173546A325294762143eE4a882",
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                      | [components.CreateTradFiAccountRequestChain](../../models/components/createtradfiaccountrequestchain.md)                     | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          | hyperevm                                                                                                                     |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                   |
+| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |
+| `owner`                                                                                                                      | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address that will own and control the product account                                                                    | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                   |

package/docs/models/components/createtradfiaccountrequestchain.md

@@ -0,0 +1,15 @@
+# CreateTradFiAccountRequestChain
+
+## Example Usage
+
+```typescript
+import { CreateTradFiAccountRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateTradFiAccountRequestChain = "hyperevm";
+```
+
+## Values
+
+```typescript
+"hyperevm"
+```

package/docs/models/components/createtradfiaccountresponse.md

@@ -0,0 +1,21 @@
+# CreateTradFiAccountResponse
+
+Response containing unsigned transaction to create a TradFi product account.
+
+## Example Usage
+
+```typescript
+import { CreateTradFiAccountResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateTradFiAccountResponse = {
+  transaction: null,
+  tradfiAccountAddress: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | Transaction to create the product account (None if already deployed)             |
+| `tradfiAccountAddress`                                                           | *string*                                                                         | :heavy_check_mark:                                                               | Predicted address of the product account that will be deployed on HyperEVM       |

package/docs/models/components/side.md

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

package/docs/models/components/tradficancelorderrequest.md

@@ -0,0 +1,24 @@
+# TradFiCancelOrderRequest
+
+Request to cancel an open order on a TradFi perp market.
+
+## Example Usage
+
+```typescript
+import { TradFiCancelOrderRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiCancelOrderRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  asset: "AAPL",
+  orderId: 12345,
+};
+```
+
+## Fields
+
+| Field                                               | Type                                                | Required                                            | Description                                         | Example                                             |
+| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
+| `owner`                                             | *string*                                            | :heavy_check_mark:                                  | Owner of the TradFi product account                 | 0x01E62835dd7F52173546A325294762143eE4a882          |
+| `asset`                                             | *string*                                            | :heavy_check_mark:                                  | Asset ticker symbol (e.g. AAPL, GOLD, EUR)          | AAPL                                                |
+| `orderId`                                           | *number*                                            | :heavy_minus_sign:                                  | Hyperliquid order ID to cancel                      | 12345                                               |
+| `clientOrderId`                                     | *number*                                            | :heavy_minus_sign:                                  | Client order ID to cancel (alternative to order_id) |                                                     |

package/docs/models/components/tradficategory.md

@@ -0,0 +1,15 @@
+# TradFiCategory
+
+## Example Usage
+
+```typescript
+import { TradFiCategory } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiCategory = "commodity";
+```
+
+## Values
+
+```typescript
+"stock" | "commodity" | "forex"
+```

package/docs/models/components/tradfidepositrequest.md

@@ -0,0 +1,21 @@
+# TradFiDepositRequest
+
+Request to deposit USDC from Arbitrum into the user's TradFi account.
+
+## Example Usage
+
+```typescript
+import { TradFiDepositRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiDepositRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  amount: "100.0",
+};
+```
+
+## Fields
+
+| Field                                                  | Type                                                   | Required                                               | Description                                            | Example                                                |
+| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
+| `owner`                                                | *string*                                               | :heavy_check_mark:                                     | The user's EOA address on Arbitrum                     | 0x01E62835dd7F52173546A325294762143eE4a882             |
+| `amount`                                               | *string*                                               | :heavy_check_mark:                                     | USDC amount to deposit (human-readable, e.g. '1000.0') | 100.0                                                  |

package/docs/models/components/tradfidepositresponse.md

@@ -0,0 +1,19 @@
+# TradFiDepositResponse
+
+Response containing unsigned Arbitrum transactions for USDC deposit.
+
+## Example Usage
+
+```typescript
+import { TradFiDepositResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiDepositResponse = {
+  transactions: [],
+};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `transactions`                                                                     | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)[] | :heavy_check_mark:                                                                 | Unsigned Arbitrum transactions: USDC approval (if needed) + bridge deposit         |

package/docs/models/components/tradfilimitorderrequest.md

@@ -0,0 +1,32 @@
+# TradFiLimitOrderRequest
+
+Request to place a limit order on a TradFi perp market.
+
+## Example Usage
+
+```typescript
+import { TradFiLimitOrderRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiLimitOrderRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  asset: "AAPL",
+  side: "buy",
+  size: "10.0",
+  price: "190.00",
+  timeInForce: "gtc",
+  reduceOnly: false,
+};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          | Example                                                              |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `owner`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Owner of the TradFi 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                                                                 |
+| `price`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Limit price (human-readable)                                         | 190.00                                                               |
+| `timeInForce`                                                        | *string*                                                             | :heavy_minus_sign:                                                   | Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only) | gtc                                                                  |
+| `reduceOnly`                                                         | *boolean*                                                            | :heavy_minus_sign:                                                   | If true, order can only reduce an existing position                  | false                                                                |
+| `clientOrderId`                                                      | *number*                                                             | :heavy_minus_sign:                                                   | Optional client order ID for idempotency (uint128)                   |                                                                      |

package/docs/models/components/tradfimarketorderrequest.md

@@ -0,0 +1,29 @@
+# TradFiMarketOrderRequest
+
+Request to place a market order on a TradFi perp market.
+
+## Example Usage
+
+```typescript
+import { TradFiMarketOrderRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiMarketOrderRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  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 TradFi 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                                                |
+| `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                                               |

package/docs/models/components/tradfiopportunitiesresponse.md

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

package/docs/models/components/tradfiopportunity.md

@@ -0,0 +1,37 @@
+# TradFiOpportunity
+
+A single TradFi perpetual futures market.
+
+## Example Usage
+
+```typescript
+import { TradFiOpportunity } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiOpportunity = {
+  asset: "<value>",
+  assetId: 533779,
+  category: "<value>",
+  markPrice: "<value>",
+  oraclePrice: "<value>",
+  openInterest: "<value>",
+  volume24h: "<value>",
+  fundingRate: "<value>",
+  maxLeverage: 455095,
+  szDecimals: 608263,
+};
+```
+
+## 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/tradfiorderresponse.md

@@ -0,0 +1,29 @@
+# TradFiOrderResponse
+
+Response containing an unsigned HyperEVM transaction for an order operation.
+
+## Example Usage
+
+```typescript
+import { TradFiOrderResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiOrderResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | N/A                                                                              |

package/docs/models/components/tradfiposition.md

@@ -0,0 +1,38 @@
+# TradFiPosition
+
+A single open perpetual futures position.
+
+## Example Usage
+
+```typescript
+import { TradFiPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiPosition = {
+  asset: "<value>",
+  assetId: 655196,
+  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.Side](../../models/components/side.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/tradfipositionsresponse.md

@@ -0,0 +1,19 @@
+# TradFiPositionsResponse
+
+List of open TradFi perp positions.
+
+## Example Usage
+
+```typescript
+import { TradFiPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiPositionsResponse = {
+  positions: [],
+};
+```
+
+## Fields
+
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `positions`                                                              | [components.TradFiPosition](../../models/components/tradfiposition.md)[] | :heavy_check_mark:                                                       | Open perpetual futures positions                                         |

package/docs/models/components/tradfiwithdrawrequest.md

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

@@ -0,0 +1,19 @@
+# TradFiWithdrawResponse
+
+Response containing unsigned HyperEVM transactions for USDC withdrawal.
+
+## Example Usage
+
+```typescript
+import { TradFiWithdrawResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: TradFiWithdrawResponse = {
+  transactions: [],
+};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `transactions`                                                                     | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)[] | :heavy_check_mark:                                                                 | Unsigned HyperEVM transactions to withdraw USDC to Arbitrum                        |

package/docs/models/operations/tradfisortby.md

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

package/docs/models/operations/tradfisortorder.md

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