@compass-labs/api-sdk 2.2.105 → 2.2.106

package/docs/models/operations/v2riskyieldpoolsrequest.md

@@ -0,0 +1,37 @@
+# V2RiskYieldPoolsRequest
+
+## Example Usage
+
+```typescript
+import { V2RiskYieldPoolsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2RiskYieldPoolsRequest = {
+  offset: 0,
+  limit: 20,
+  chain: "robinhood",
+  pairClass: "MEME_STOCK",
+  lpEarnsFees: true,
+  lpOpen: true,
+  orderBy: "il_adjusted_apr_7d",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `offset`                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | The offset of the first item to return.                                                                                                                                                                                                         | 0                                                                                                                                                                                                                                               |
+| `limit`                                                                                                                                                                                                                                         | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | The number of items to return.                                                                                                                                                                                                                  | 20                                                                                                                                                                                                                                              |
+| `chain`                                                                                                                                                                                                                                         | [operations.V2RiskYieldPoolsChain](../../models/operations/v2riskyieldpoolschain.md)                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | robinhood                                                                                                                                                                                                                                       |
+| `pairClass`                                                                                                                                                                                                                                     | [components.PairClass](../../models/components/pairclass.md)                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | What kind of pair a pool is, which is what the product is sorted by.                                                                                                                                                                            | MEME_STOCK                                                                                                                                                                                                                                      |
+| `token`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Pools holding this token, on either side.                                                                                                                                                                                                       |                                                                                                                                                                                                                                                 |
+| `stockTicker`                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `dexVersion`                                                                                                                                                                                                                                    | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                              | Which Uniswap deployment a pool belongs to.<br/><br/>v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a<br/>shared PoolManager and may route the fee through a hook, which is where the<br/>launchpad pools' zero LP yield comes from. |                                                                                                                                                                                                                                                 |
+| `launchpad`                                                                                                                                                                                                                                     | [components.Launchpad](../../models/components/launchpad.md)                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `lpEarnsFees`                                                                                                                                                                                                                                   | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Leave unset to see everything. Set true to hide the pools whose hook keeps the fee — most of this chain's volume, and none of its yield.                                                                                                        | true                                                                                                                                                                                                                                            |
+| `lpOpen`                                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Whether liquidity may be added at all.                                                                                                                                                                                                          | true                                                                                                                                                                                                                                            |
+| `watched`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Only pools the indexer follows closely, which are the only ones with trailing metrics.                                                                                                                                                          |                                                                                                                                                                                                                                                 |
+| `minTvlUsd`                                                                                                                                                                                                                                     | *operations.V2RiskYieldPoolsMinTvlUsd*                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `minVolume24hUsd`                                                                                                                                                                                                                               | *operations.MinVolume24HUsd*                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `orderBy`                                                                                                                                                                                                                                       | [operations.PoolOrderBy](../../models/operations/poolorderby.md)                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | il_adjusted_apr_7d                                                                                                                                                                                                                              |
+| `direction`                                                                                                                                                                                                                                     | [operations.V2RiskYieldPoolsDirection](../../models/operations/v2riskyieldpoolsdirection.md)                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |

package/docs/models/operations/v2riskyieldpositionschain.md

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

package/docs/models/operations/v2riskyieldpositionsrequest.md

@@ -0,0 +1,22 @@
+# V2RiskYieldPositionsRequest
+
+## Example Usage
+
+```typescript
+import { V2RiskYieldPositionsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2RiskYieldPositionsRequest = {
+  chain: "robinhood",
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  includeClosed: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                                                                                                                                         | [operations.V2RiskYieldPositionsChain](../../models/operations/v2riskyieldpositionschain.md)                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | robinhood                                                                                                                                                                                                                                       |
+| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
+| `dexVersion`                                                                                                                                                                                                                                    | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                              | Which Uniswap deployment a pool belongs to.<br/><br/>v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a<br/>shared PoolManager and may route the fee through a hook, which is where the<br/>launchpad pools' zero LP yield comes from. |                                                                                                                                                                                                                                                 |
+| `includeClosed`                                                                                                                                                                                                                                 | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Include positions with no liquidity and nothing owed. Off by default: a closed position is history, not a holding.                                                                                                                              | false                                                                                                                                                                                                                                           |

package/docs/models/operations/v2riskyieldtokenschain.md

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

package/docs/models/operations/v2riskyieldtokensdirection.md

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

package/docs/models/operations/v2riskyieldtokensminliquidityusd.md

@@ -0,0 +1,17 @@
+# V2RiskYieldTokensMinLiquidityUsd
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/operations/v2riskyieldtokensrequest.md

@@ -0,0 +1,31 @@
+# V2RiskYieldTokensRequest
+
+## Example Usage
+
+```typescript
+import { V2RiskYieldTokensRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2RiskYieldTokensRequest = {
+  offset: 0,
+  limit: 20,
+  chain: "robinhood",
+  kind: "STOCK",
+  orderBy: "liquidity_usd",
+};
+```
+
+## Fields
+
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    | Example                                                                                        |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `offset`                                                                                       | *number*                                                                                       | :heavy_minus_sign:                                                                             | The offset of the first item to return.                                                        | 0                                                                                              |
+| `limit`                                                                                        | *number*                                                                                       | :heavy_minus_sign:                                                                             | The number of items to return.                                                                 | 20                                                                                             |
+| `chain`                                                                                        | [operations.V2RiskYieldTokensChain](../../models/operations/v2riskyieldtokenschain.md)         | :heavy_check_mark:                                                                             | N/A                                                                                            | robinhood                                                                                      |
+| `kind`                                                                                         | [components.DexTokenKind](../../models/components/dextokenkind.md)                             | :heavy_minus_sign:                                                                             | Filter to one kind of asset.                                                                   | STOCK                                                                                          |
+| `launchpad`                                                                                    | [components.Launchpad](../../models/components/launchpad.md)                                   | :heavy_minus_sign:                                                                             | N/A                                                                                            |                                                                                                |
+| `search`                                                                                       | *string*                                                                                       | :heavy_minus_sign:                                                                             | Matches symbol, name or stock ticker.                                                          |                                                                                                |
+| `hasPrice`                                                                                     | *boolean*                                                                                      | :heavy_minus_sign:                                                                             | Only tokens the indexer can currently price.                                                   |                                                                                                |
+| `stockTicker`                                                                                  | *string*                                                                                       | :heavy_minus_sign:                                                                             | N/A                                                                                            |                                                                                                |
+| `minLiquidityUsd`                                                                              | *operations.V2RiskYieldTokensMinLiquidityUsd*                                                  | :heavy_minus_sign:                                                                             | N/A                                                                                            |                                                                                                |
+| `orderBy`                                                                                      | [operations.TokenOrderBy](../../models/operations/tokenorderby.md)                             | :heavy_minus_sign:                                                                             | N/A                                                                                            | liquidity_usd                                                                                  |
+| `direction`                                                                                    | [operations.V2RiskYieldTokensDirection](../../models/operations/v2riskyieldtokensdirection.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |                                                                                                |

package/docs/models/operations/v2tokenizedassetsbalanceschain.md

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

package/docs/models/operations/v2tokenizedassetsmarketssymbolchain.md

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

package/docs/models/operations/v2tokenizedassetspositionschain.md

@@ -13,5 +13,5 @@ let value: V2TokenizedAssetsPositionsChain = "hyperevm";
 ## Values
 
 ```typescript
-"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
+"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
 ```

package/docs/models/operations/v2tokenizedassetsredemptionschain.md

@@ -13,5 +13,5 @@ let value: V2TokenizedAssetsRedemptionsChain = "bsc";
 ## Values
 
 ```typescript
-"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
+"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
 ```