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

package/docs/models/operations/v2tradfiopportunitiesrequest.md

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

package/docs/models/operations/v2tradfipositionsrequest.md

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