@compass-labs/api-sdk 2.2.105-rc.0 → 2.2.106

package/docs/models/components/scenarioinput.md

@@ -0,0 +1,28 @@
+# ScenarioInput
+
+One hypothetical.
+
+The two moves are deliberately separate. On a meme-against-stock pair the
+ratio between them is what causes impermanent loss, while the stock's own
+dollar move scales the whole position without touching the ratio — so "NVDA
+drops 10%" and "the memecoin drops 10% against NVDA" are different
+questions with different answers, and one number cannot ask both.
+
+## Example Usage
+
+```typescript
+import { ScenarioInput } from "@compass-labs/api-sdk/models/components";
+
+let value: ScenarioInput = {
+  quoteUsdMovePct: "0",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            | Example                                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`                                                                                                                                                                 | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | What to call this row.                                                                                                                                                 |                                                                                                                                                                        |
+| `ratioMovePct`                                                                                                                                                         | *components.RatioMovePct*                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                     | How far the pair's ratio moves. This is what drives loss.                                                                                                              |                                                                                                                                                                        |
+| `baseUsdMovePct`                                                                                                                                                       | *components.BaseUsdMovePct*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                     | How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.                                                                              |                                                                                                                                                                        |
+| `quoteUsdMovePct`                                                                                                                                                      | *components.QuoteUsdMovePct*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                     | How far token1 — the stock, on a meme x stock pair — moves in dollars. On its own this changes what the position is worth without causing any impermanent loss at all. | 0                                                                                                                                                                      |

package/docs/models/components/scenarioresult.md

@@ -0,0 +1,39 @@
+# ScenarioResult
+
+## Example Usage
+
+```typescript
+import { ScenarioResult } from "@compass-labs/api-sdk/models/components";
+
+let value: ScenarioResult = {
+  name: "<value>",
+  priceRatio: "<value>",
+  endPrice: "<value>",
+  inRangeAtEnd: true,
+  positionValueUsd: "<value>",
+  holdValueUsd: "<value>",
+  ilUsd: "<value>",
+  ilPct: "<value>",
+  holdPnlUsd: "<value>",
+  expectedFeesUsd: "<value>",
+  netPnlUsd: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                      | Type                                                                                                                                                       | Required                                                                                                                                                   | Description                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`                                                                                                                                                     | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `priceRatio`                                                                                                                                               | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `endPrice`                                                                                                                                                 | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `inRangeAtEnd`                                                                                                                                             | *boolean*                                                                                                                                                  | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `positionValueUsd`                                                                                                                                         | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `holdValueUsd`                                                                                                                                             | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `ilUsd`                                                                                                                                                    | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `ilPct`                                                                                                                                                    | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `holdPnlUsd`                                                                                                                                               | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `expectedFeesUsd`                                                                                                                                          | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
+| `netPnlUsd`                                                                                                                                                | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | Hold profit, plus the impermanent loss, plus the fees.                                                                                                     |
+| `breakevenFeeAprPct`                                                                                                                                       | *string*                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                         | What this position would have to earn, annualized, for the loss to be worth taking. The number to compare against the pool's actual fee APR.               |
+| `daysOfFeesToRecoverIl`                                                                                                                                    | *string*                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                         | How long the pool's current fee rate would take to earn the loss back. Null when the pool pays liquidity providers nothing, which no amount of time fixes. |

package/docs/models/components/simulation.md

@@ -0,0 +1,25 @@
+# Simulation
+
+The result of executing the transaction against current state.
+
+Meme tokens on this chain carry transfer taxes, blacklists and pause
+switches, none of which are visible from a pool's parameters. Simulating is
+the only way to find out before the owner signs.
+
+## Example Usage
+
+```typescript
+import { Simulation } from "@compass-labs/api-sdk/models/components";
+
+let value: Simulation = {
+  ok: true,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |
+| `error`            | *string*           | :heavy_minus_sign: | N/A                |
+| `gasUsed`          | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/singlesideddeposit.md

@@ -0,0 +1,26 @@
+# SingleSidedDeposit
+
+One token, split to fit the range.
+
+A range needs both assets in a ratio the range itself determines, so this
+asks the API to solve for that ratio and swap the difference.
+
+## Example Usage
+
+```typescript
+import { SingleSidedDeposit } from "@compass-labs/api-sdk/models/components";
+
+let value: SingleSidedDeposit = {
+  type: "single",
+  token: "<value>",
+  amount: "272.85",
+};
+```
+
+## Fields
+
+| Field                                 | Type                                  | Required                              | Description                           | Example                               |
+| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
+| `type`                                | *"single"*                            | :heavy_check_mark:                    | N/A                                   | single                                |
+| `token`                               | *string*                              | :heavy_check_mark:                    | N/A                                   |                                       |
+| `amount`                              | *components.SingleSidedDepositAmount* | :heavy_check_mark:                    | N/A                                   |                                       |

package/docs/models/components/singlesideddepositamount.md

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

package/docs/models/components/stockmetadata.md

@@ -0,0 +1,31 @@
+# StockMetadata
+
+The issuer's side of a tokenized stock.
+
+`ui_multiplier` is the ERC-8056 corporate-action factor. It matters because
+balances do **not** rebase on a split: the token count stays put and this
+number changes, so a price quoted for the underlying has to be multiplied by
+it to mean anything about the token a pool holds.
+
+## Example Usage
+
+```typescript
+import { StockMetadata } from "@compass-labs/api-sdk/models/components";
+
+let value: StockMetadata = {
+  ticker: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `ticker`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `uiMultiplier`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pendingUiMultiplier`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pendingEffectiveAt`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `chainlinkFeed`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `tokenPaused`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `logoUrl`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/models/components/stockreference.md

@@ -0,0 +1,31 @@
+# StockReference
+
+The pool price against the stock's own reference price.
+
+A tokenized stock trades in its pool around the clock while the underlying
+trades in a session. The gap between them is real information — it is what
+an LP is quoting against overnight — and it is not visible from either
+number alone.
+
+## Example Usage
+
+```typescript
+import { StockReference } from "@compass-labs/api-sdk/models/components";
+
+let value: StockReference = {
+  ticker: "<value>",
+  referenceIsStale: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                             | Type                                                                                                                              | Required                                                                                                                          | Description                                                                                                                       | Example                                                                                                                           |
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `ticker`                                                                                                                          | *string*                                                                                                                          | :heavy_check_mark:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
+| `referencePriceUsd`                                                                                                               | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | From the Chainlink feed, multiplier applied.                                                                                      |                                                                                                                                   |
+| `referenceSource`                                                                                                                 | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
+| `referenceUpdatedAt`                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                     | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
+| `poolImpliedPriceUsd`                                                                                                             | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
+| `premiumPct`                                                                                                                      | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | How far above (or below) the reference the pool is trading.                                                                       |                                                                                                                                   |
+| `referenceIsStale`                                                                                                                | *boolean*                                                                                                                         | :heavy_minus_sign:                                                                                                                | True when the feed has not posted for over two heartbeats — normal over a weekend, when the stock is not trading and the pool is. | false                                                                                                                             |

package/docs/models/components/swapplan.md

@@ -0,0 +1,29 @@
+# SwapPlan
+
+The swap leg of an entry or a rebalance.
+
+## Example Usage
+
+```typescript
+import { SwapPlan } from "@compass-labs/api-sdk/models/components";
+
+let value: SwapPlan = {
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: "<value>",
+  amountOutQuoted: "<value>",
+  amountOutMin: "<value>",
+};
+```
+
+## Fields
+
+| Field                                               | Type                                                | Required                                            | Description                                         |
+| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
+| `tokenIn`                                           | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
+| `tokenOut`                                          | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
+| `amountIn`                                          | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
+| `amountOutQuoted`                                   | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
+| `amountOutMin`                                      | *string*                                            | :heavy_check_mark:                                  | The floor the transaction enforces, after slippage. |
+| `priceImpactPct`                                    | *string*                                            | :heavy_minus_sign:                                  | N/A                                                 |
+| `poolFeePpm`                                        | *number*                                            | :heavy_minus_sign:                                  | N/A                                                 |

package/docs/models/components/symmetricrange.md

@@ -0,0 +1,24 @@
+# SymmetricRange
+
+A range centred on the current price, given as a percentage either side.
+
+The usual way to ask for a position: narrow earns more fees per dollar while
+the price stays inside it, and stops earning entirely when it leaves.
+
+## Example Usage
+
+```typescript
+import { SymmetricRange } from "@compass-labs/api-sdk/models/components";
+
+let value: SymmetricRange = {
+  type: "symmetric_pct",
+  widthPct: "30",
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              | Example                                                  |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `type`                                                   | *"symmetric_pct"*                                        | :heavy_check_mark:                                       | N/A                                                      | symmetric_pct                                            |
+| `widthPct`                                               | *components.SymmetricRangeWidthPct*                      | :heavy_check_mark:                                       | Half-width either side of the current price, in percent. |                                                          |

package/docs/models/components/symmetricrangewidthpct.md

@@ -0,0 +1,19 @@
+# SymmetricRangeWidthPct
+
+Half-width either side of the current price, in percent.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/tickrange.md

@@ -0,0 +1,23 @@
+# TickRange
+
+Exact tick bounds, for a caller who has already done the maths.
+
+## Example Usage
+
+```typescript
+import { TickRange } from "@compass-labs/api-sdk/models/components";
+
+let value: TickRange = {
+  type: "ticks",
+  tickLower: 494824,
+  tickUpper: 250131,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        | Example            |
+| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *"ticks"*          | :heavy_check_mark: | N/A                | ticks              |
+| `tickLower`        | *number*           | :heavy_check_mark: | N/A                |                    |
+| `tickUpper`        | *number*           | :heavy_check_mark: | N/A                |                    |

package/docs/models/components/usddeposit.md

@@ -0,0 +1,24 @@
+# UsdDeposit
+
+A dollar figure, for analytics only.
+
+Enough to answer "what would this look like", not enough to build a
+transaction — the API will not choose which of your tokens to spend.
+
+## Example Usage
+
+```typescript
+import { UsdDeposit } from "@compass-labs/api-sdk/models/components";
+
+let value: UsdDeposit = {
+  type: "usd",
+  valueUsd: "1000",
+};
+```
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           | Example               |
+| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
+| `type`                | *"usd"*               | :heavy_check_mark:    | N/A                   | usd                   |
+| `valueUsd`            | *components.ValueUsd* | :heavy_check_mark:    | N/A                   |                       |

package/docs/models/components/valueusd.md

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

package/docs/models/components/voloverridepct.md

@@ -0,0 +1,19 @@
+# VolOverridePct
+
+Assume this annualized volatility instead of the pair's measured one. Needed for a pool too new to have measured any.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/operations/minvolume24husd.md

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

package/docs/models/operations/poolhistory.md

@@ -0,0 +1,15 @@
+# PoolHistory
+
+## Example Usage
+
+```typescript
+import { PoolHistory } from "@compass-labs/api-sdk/models/operations";
+
+let value: PoolHistory = "7d";
+```
+
+## Values
+
+```typescript
+"24h" | "7d" | "30d"
+```

package/docs/models/operations/poolorderby.md

@@ -0,0 +1,15 @@
+# PoolOrderBy
+
+## Example Usage
+
+```typescript
+import { PoolOrderBy } from "@compass-labs/api-sdk/models/operations";
+
+let value: PoolOrderBy = "il_adjusted_apr_7d";
+```
+
+## Values
+
+```typescript
+"il_adjusted_apr_7d" | "fee_apr_24h" | "fee_apr_7d" | "tvl_usd" | "volume_24h_usd" | "volume_7d_usd" | "realized_vol_24h" | "realized_vol_7d" | "created_at"
+```

package/docs/models/operations/tokenorderby.md

@@ -0,0 +1,15 @@
+# TokenOrderBy
+
+## Example Usage
+
+```typescript
+import { TokenOrderBy } from "@compass-labs/api-sdk/models/operations";
+
+let value: TokenOrderBy = "liquidity_usd";
+```
+
+## Values
+
+```typescript
+"liquidity_usd" | "volume_24h_usd" | "market_cap_usd" | "price_change_24h_pct" | "created_at"
+```

package/docs/models/operations/v2earnswapquotechain.md

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

package/docs/models/operations/{minliquidityusd.md → v2earnvaultsminliquidityusd.md}

@@ -1,4 +1,4 @@
-# MinLiquidityUsd
+# V2EarnVaultsMinLiquidityUsd
 
 Minimum available liquidity in USD. Vaults below this are excluded.
 

package/docs/models/operations/v2earnvaultsrequest.md

@@ -24,5 +24,5 @@ let value: V2EarnVaultsRequest = {
 | `chain`                                                                                             | [components.Chain](../../models/components/chain.md)                                                | :heavy_minus_sign:                                                                                  | Optional chain filter. If not provided, returns vaults for all chains.                              |                                                                                                     |
 | `assetSymbol`                                                                                       | *string*                                                                                            | :heavy_minus_sign:                                                                                  | Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').                                    |                                                                                                     |
 | `minTvlUsd`                                                                                         | *operations.V2EarnVaultsMinTvlUsd*                                                                  | :heavy_minus_sign:                                                                                  | Minimum TVL in USD. Vaults with TVL below this value will be excluded.                              |                                                                                                     |
-| `minLiquidityUsd`                                                                                   | *operations.MinLiquidityUsd*                                                                        | :heavy_minus_sign:                                                                                  | Minimum available liquidity in USD. Vaults below this are excluded.                                 |                                                                                                     |
+| `minLiquidityUsd`                                                                                   | *operations.V2EarnVaultsMinLiquidityUsd*                                                            | :heavy_minus_sign:                                                                                  | Minimum available liquidity in USD. Vaults below this are excluded.                                 |                                                                                                     |
 | `minDepositCapUsd`                                                                                  | *operations.MinDepositCapUsd*                                                                       | :heavy_minus_sign:                                                                                  | Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to exclude paused vaults. |                                                                                                     |

package/docs/models/operations/v2riskyieldpoolschain.md

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

package/docs/models/operations/v2riskyieldpoolsdirection.md

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

package/docs/models/operations/v2riskyieldpoolsmintvlusd.md

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

package/docs/models/operations/v2riskyieldpoolspoolidchain.md

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

package/docs/models/operations/v2riskyieldpoolspoolidrequest.md

@@ -0,0 +1,23 @@
+# V2RiskYieldPoolsPoolIdRequest
+
+## Example Usage
+
+```typescript
+import { V2RiskYieldPoolsPoolIdRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2RiskYieldPoolsPoolIdRequest = {
+  poolId: 776123,
+  chain: "robinhood",
+  depthWords: 4,
+  history: "7d",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                         | Type                                                                                                                                          | Required                                                                                                                                      | Description                                                                                                                                   | Example                                                                                                                                       |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `poolId`                                                                                                                                      | *number*                                                                                                                                      | :heavy_check_mark:                                                                                                                            | The pool id, as returned by `GET /pools`.                                                                                                     |                                                                                                                                               |
+| `chain`                                                                                                                                       | [operations.V2RiskYieldPoolsPoolIdChain](../../models/operations/v2riskyieldpoolspoolidchain.md)                                              | :heavy_check_mark:                                                                                                                            | N/A                                                                                                                                           | robinhood                                                                                                                                     |
+| `depthWords`                                                                                                                                  | *number*                                                                                                                                      | :heavy_minus_sign:                                                                                                                            | How many 256-tick words either side of the current price to read for the liquidity distribution. More is a wider picture and more node calls. | 4                                                                                                                                             |
+| `history`                                                                                                                                     | [operations.PoolHistory](../../models/operations/poolhistory.md)                                                                              | :heavy_minus_sign:                                                                                                                            | N/A                                                                                                                                           | 7d                                                                                                                                            |