@compass-labs/api-sdk 2.2.34-rc.3 → 2.2.34-rc.5

package/docs/models/operations/traditionalinvestingsortorder.md

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

package/docs/models/operations/v2traditionalinvestingopportunitiesrequest.md

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

package/docs/models/operations/v2traditionalinvestingpositionsrequest.md

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