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

package/docs/sdks/tradfi/README.md

@@ -0,0 +1,686 @@
+# TradFi
+
+## Overview
+
+### Available Operations
+
+* [tradfiOpportunities](#tradfiopportunities) - List TradFi perp markets
+* [tradfiPositions](#tradfipositions) - List TradFi positions
+* [tradfiCreateAccount](#tradficreateaccount) - Create TradFi account
+* [tradfiDeposit](#tradfideposit) - Deposit USDC to TradFi account
+* [tradfiWithdraw](#tradfiwithdraw) - Withdraw USDC from TradFi account
+* [tradfiMarketOrder](#tradfimarketorder) - Place market order
+* [tradfiLimitOrder](#tradfilimitorder) - Place limit order
+* [tradfiCancelOrder](#tradficancelorder) - Cancel order
+
+## tradfiOpportunities
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_opportunities" method="get" path="/v2/tradfi/opportunities" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiOpportunities({
+    sortBy: "volume_24h",
+    sortOrder: "desc",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiOpportunities } from "@compass-labs/api-sdk/funcs/tradFiTradfiOpportunities.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiOpportunities(compassApiSDK, {
+    sortBy: "volume_24h",
+    sortOrder: "desc",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiOpportunities failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2TradfiOpportunitiesRequest](../../models/operations/v2tradfiopportunitiesrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiOpportunitiesResponse](../../models/components/tradfiopportunitiesresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiPositions
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_positions" method="get" path="/v2/tradfi/positions" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiPositions({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiPositions } from "@compass-labs/api-sdk/funcs/tradFiTradfiPositions.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiPositions(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiPositions failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2TradfiPositionsRequest](../../models/operations/v2tradfipositionsrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiPositionsResponse](../../models/components/tradfipositionsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiCreateAccount
+
+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).
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_create_account" method="post" path="/v2/tradfi/create_account" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiCreateAccount({
+    chain: "hyperevm",
+    sender: "0x01E62835dd7F52173546A325294762143eE4a882",
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiCreateAccount } from "@compass-labs/api-sdk/funcs/tradFiTradfiCreateAccount.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiCreateAccount(compassApiSDK, {
+    chain: "hyperevm",
+    sender: "0x01E62835dd7F52173546A325294762143eE4a882",
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiCreateAccount failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.CreateTradFiAccountRequest](../../models/components/createtradfiaccountrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.CreateTradFiAccountResponse](../../models/components/createtradfiaccountresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiDeposit
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_deposit" method="post" path="/v2/tradfi/deposit" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiDeposit({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    amount: "100.0",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiDeposit } from "@compass-labs/api-sdk/funcs/tradFiTradfiDeposit.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiDeposit(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    amount: "100.0",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiDeposit failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.TradFiDepositRequest](../../models/components/tradfidepositrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiDepositResponse](../../models/components/tradfidepositresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiWithdraw
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_withdraw" method="post" path="/v2/tradfi/withdraw" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiWithdraw({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    amount: "100.0",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiWithdraw } from "@compass-labs/api-sdk/funcs/tradFiTradfiWithdraw.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiWithdraw(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    amount: "100.0",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiWithdraw failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.TradFiWithdrawRequest](../../models/components/tradfiwithdrawrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiWithdrawResponse](../../models/components/tradfiwithdrawresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiMarketOrder
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_market_order" method="post" path="/v2/tradfi/market_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiMarketOrder({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    slippagePercent: 1,
+    reduceOnly: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiMarketOrder } from "@compass-labs/api-sdk/funcs/tradFiTradfiMarketOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiMarketOrder(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    slippagePercent: 1,
+    reduceOnly: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiMarketOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.TradFiMarketOrderRequest](../../models/components/tradfimarketorderrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiOrderResponse](../../models/components/tradfiorderresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiLimitOrder
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_limit_order" method="post" path="/v2/tradfi/limit_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiLimitOrder({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    price: "190.00",
+    timeInForce: "gtc",
+    reduceOnly: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiLimitOrder } from "@compass-labs/api-sdk/funcs/tradFiTradfiLimitOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiLimitOrder(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    side: "buy",
+    size: "10.0",
+    price: "190.00",
+    timeInForce: "gtc",
+    reduceOnly: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiLimitOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.TradFiLimitOrderRequest](../../models/components/tradfilimitorderrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiOrderResponse](../../models/components/tradfiorderresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## tradfiCancelOrder
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tradfi_cancel_order" method="post" path="/v2/tradfi/cancel_order" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tradFi.tradfiCancelOrder({
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    orderId: 12345,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tradFiTradfiCancelOrder } from "@compass-labs/api-sdk/funcs/tradFiTradfiCancelOrder.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await tradFiTradfiCancelOrder(compassApiSDK, {
+    owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+    asset: "AAPL",
+    orderId: 12345,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tradFiTradfiCancelOrder failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.TradFiCancelOrderRequest](../../models/components/tradficancelorderrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TradFiOrderResponse](../../models/components/tradfiorderresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |