@compass-labs/api-sdk 2.2.105 → 2.2.106

package/docs/models/components/baseusdmovepct.md

@@ -0,0 +1,19 @@
+# BaseUsdMovePct
+
+How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/bothsidesdeposit.md

@@ -0,0 +1,23 @@
+# BothSidesDeposit
+
+Explicit amounts of each token.
+
+## Example Usage
+
+```typescript
+import { BothSidesDeposit } from "@compass-labs/api-sdk/models/components";
+
+let value: BothSidesDeposit = {
+  type: "both",
+  amount0: "<value>",
+  amount1: "<value>",
+};
+```
+
+## Fields
+
+| Field                | Type                 | Required             | Description          | Example              |
+| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
+| `type`               | *"both"*             | :heavy_check_mark:   | N/A                  | both                 |
+| `amount0`            | *components.Amount0* | :heavy_check_mark:   | N/A                  |                      |
+| `amount1`            | *components.Amount1* | :heavy_check_mark:   | N/A                  |                      |

package/docs/models/components/chain.md

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

package/docs/models/components/costbasis.md

@@ -0,0 +1,28 @@
+# CostBasis
+
+What the position cost to open.
+
+Not readable from the chain: a position reports its liquidity, never the
+amounts that bought it. This comes from recorded events, and when there are
+none the PnL fields are null rather than guessed — an invented cost basis
+would make every number derived from it quietly wrong.
+
+## Example Usage
+
+```typescript
+import { CostBasis } from "@compass-labs/api-sdk/models/components";
+
+let value: CostBasis = {
+  source: "onchain_logs",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `source`                                                                                      | [components.CostBasisSource](../../models/components/costbasissource.md)                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `amount0`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `amount1`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `valueUsd`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `openedAt`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/models/components/costbasissource.md

@@ -0,0 +1,15 @@
+# CostBasisSource
+
+## Example Usage
+
+```typescript
+import { CostBasisSource } from "@compass-labs/api-sdk/models/components";
+
+let value: CostBasisSource = "unavailable";
+```
+
+## Values
+
+```typescript
+"indexed" | "onchain_logs" | "unavailable"
+```

package/docs/models/components/createriskyieldaccountrequest.md

@@ -0,0 +1,23 @@
+# CreateRiskYieldAccountRequest
+
+Create the Safe that will hold the owner's LP positions.
+
+## Example Usage
+
+```typescript
+import { CreateRiskYieldAccountRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateRiskYieldAccountRequest = {
+  sender: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
+  owner: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
+};
+```
+
+## Fields
+
+| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    | Example                                                                                                        |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `sender`                                                                                                       | *string*                                                                                                       | :heavy_check_mark:                                                                                             | The address that signs and broadcasts this transaction.                                                        | 0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6                                                                     |
+| `owner`                                                                                                        | *string*                                                                                                       | :heavy_check_mark:                                                                                             | The address that will own and control the Risk Yield Account.                                                  | 0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6                                                                     |
+| `chain`                                                                                                        | [components.CreateRiskYieldAccountRequestChain](../../models/components/createriskyieldaccountrequestchain.md) | :heavy_minus_sign:                                                                                             | Risk Yield is available on Robinhood Chain only.                                                               | robinhood                                                                                                      |
+| `estimateGas`                                                                                                  | *boolean*                                                                                                      | :heavy_minus_sign:                                                                                             | Estimate gas, which also proves the transaction can execute.                                                   | true                                                                                                           |

package/docs/models/components/createriskyieldaccountrequestchain.md

@@ -0,0 +1,17 @@
+# CreateRiskYieldAccountRequestChain
+
+Risk Yield is available on Robinhood Chain only.
+
+## Example Usage
+
+```typescript
+import { CreateRiskYieldAccountRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateRiskYieldAccountRequestChain = "robinhood";
+```
+
+## Values
+
+```typescript
+"robinhood"
+```

package/docs/models/components/createriskyieldaccountresponse.md

@@ -0,0 +1,29 @@
+# CreateRiskYieldAccountResponse
+
+## Example Usage
+
+```typescript
+import { CreateRiskYieldAccountResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateRiskYieldAccountResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+  riskYieldAccountAddress: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                           |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                                                                                                                                                                         | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                    | The transaction that deploys the account, or null when it already exists — calling this twice is safe.                                                                                                                                                                |
+| `riskYieldAccountAddress`                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                                    | Where the account is, or will be. Deterministic from the owner, so it is known before the transaction is sent. This is the same address as the owner's Earn Account on this chain: one Safe holds both, and funds moved in through either product are the same funds. |

package/docs/models/components/depositplan.md

@@ -0,0 +1,34 @@
+# DepositPlan
+
+What will actually be deposited, and what is left over.
+
+A range fixes the ratio of the two assets, so a deposit rarely uses all of
+both. The leftovers are reported rather than silently swept: they stay in
+the account, and a caller who expected them to be used should know.
+
+## Example Usage
+
+```typescript
+import { DepositPlan } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositPlan = {
+  amount0Desired: "<value>",
+  amount1Desired: "<value>",
+  amount0Min: "<value>",
+  amount1Min: "<value>",
+  leftover0: "0",
+  leftover1: "0",
+};
+```
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                | Example                                                    |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `amount0Desired`                                           | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
+| `amount1Desired`                                           | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
+| `amount0Min`                                               | *string*                                                   | :heavy_check_mark:                                         | The floor the transaction enforces after slippage.         |                                                            |
+| `amount1Min`                                               | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
+| `leftover0`                                                | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        | 0                                                          |
+| `leftover1`                                                | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        | 0                                                          |
+| `swap`                                                     | [components.SwapPlan](../../models/components/swapplan.md) | :heavy_minus_sign:                                         | Present when one asset had to be traded for the other.     |                                                            |

package/docs/models/components/dexpooldetailresponse.md

@@ -0,0 +1,59 @@
+# DexPoolDetailResponse
+
+## Example Usage
+
+```typescript
+import { DexPoolDetailResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: DexPoolDetailResponse = {
+  pool: {
+    poolId: 31641,
+    dexVersion: "V4",
+    poolKey: "<value>",
+    token0: {
+      address: "707 Lesch Meadow",
+      kind: "STOCK",
+    },
+    token1: {
+      address: "96147 King Street",
+      kind: "STOCK",
+    },
+    feePpm: 556358,
+    feePct: "<value>",
+    pairClass: "MEME_STOCK",
+    watched: true,
+    lpOpen: true,
+    lpEarnsFees: false,
+    ranked: true,
+  },
+  liquidityDistribution: [
+    {
+      tickLower: 874443,
+      tickUpper: 352786,
+      liquidity: "<value>",
+      isCurrent: false,
+    },
+  ],
+  hourly: [
+    {
+      hourStart: new Date("2025-10-01T10:34:46.351Z"),
+      swapCount: 0,
+    },
+  ],
+  stockReference: {
+    ticker: "<value>",
+    referenceIsStale: false,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `pool`                                                                     | [components.DexPoolInfo](../../models/components/dexpoolinfo.md)           | :heavy_check_mark:                                                         | N/A                                                                        |
+| `onChain`                                                                  | [components.PoolOnChainState](../../models/components/poolonchainstate.md) | :heavy_minus_sign:                                                         | N/A                                                                        |
+| `liquidityDistribution`                                                    | [components.LiquidityBucket](../../models/components/liquiditybucket.md)[] | :heavy_minus_sign:                                                         | N/A                                                                        |
+| `hourly`                                                                   | [components.PoolHourlyPoint](../../models/components/poolhourlypoint.md)[] | :heavy_minus_sign:                                                         | N/A                                                                        |
+| `stockReference`                                                           | [components.StockReference](../../models/components/stockreference.md)     | :heavy_minus_sign:                                                         | N/A                                                                        |
+| `warnings`                                                                 | *string*[]                                                                 | :heavy_minus_sign:                                                         | Things worth knowing before providing liquidity here.                      |

package/docs/models/components/dexpoolinfo.md

@@ -0,0 +1,73 @@
+# DexPoolInfo
+
+## Example Usage
+
+```typescript
+import { DexPoolInfo } from "@compass-labs/api-sdk/models/components";
+
+let value: DexPoolInfo = {
+  poolId: 911299,
+  dexVersion: "V3",
+  poolKey: "<value>",
+  token0: {
+    address: "707 Lesch Meadow",
+    kind: "STOCK",
+  },
+  token1: {
+    address: "96147 King Street",
+    kind: "STOCK",
+  },
+  feePpm: 2827,
+  feePct: "<value>",
+  pairClass: "MEME_STOCK",
+  watched: true,
+  lpOpen: true,
+  lpEarnsFees: false,
+  ranked: true,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `poolId`                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `dexVersion`                                                                                                                                                                                                                                    | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                                              | 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. |                                                                                                                                                                                                                                                 |
+| `address`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | v3 pools have their own address; v4 pools share a manager.                                                                                                                                                                                      |                                                                                                                                                                                                                                                 |
+| `poolKey`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The v4 PoolId, or the v3 pool address. Unique per chain.                                                                                                                                                                                        |                                                                                                                                                                                                                                                 |
+| `token0`                                                                                                                                                                                                                                        | [components.DexTokenRef](../../models/components/dextokenref.md)                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                              | A token as every Risk Yield response describes it.                                                                                                                                                                                              |                                                                                                                                                                                                                                                 |
+| `token1`                                                                                                                                                                                                                                        | [components.DexTokenRef](../../models/components/dextokenref.md)                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                              | A token as every Risk Yield response describes it.                                                                                                                                                                                              |                                                                                                                                                                                                                                                 |
+| `feePpm`                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `feePct`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `tickSpacing`                                                                                                                                                                                                                                   | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `hooks`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `pairClass`                                                                                                                                                                                                                                     | [components.PairClass](../../models/components/pairclass.md)                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                              | What kind of pair a pool is, which is what the product is sorted by.                                                                                                                                                                            | MEME_STOCK                                                                                                                                                                                                                                      |
+| `stockToken`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `memeToken`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `stockTicker`                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `launchpadOrigin`                                                                                                                                                                                                                               | [components.Launchpad](../../models/components/launchpad.md)                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `watched`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                              | Whether the indexer follows this pool closely. Unwatched pools carry a price but no trailing metrics.                                                                                                                                           |                                                                                                                                                                                                                                                 |
+| `lpOpen`                                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                              | Whether anyone may add liquidity, or a hook forbids it.                                                                                                                                                                                         |                                                                                                                                                                                                                                                 |
+| `lpEarnsFees`                                                                                                                                                                                                                                   | *boolean*                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                              | Whether an external liquidity provider receives the swap fee. **False for every launchpad-graduated pool on this chain**, whose hook takes the fee for the protocol and the creator. Those pools trade heavily and pay you nothing.             |                                                                                                                                                                                                                                                 |
+| `lpFeeNote`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Why, in a sentence, when `lp_earns_fees` is false.                                                                                                                                                                                              |                                                                                                                                                                                                                                                 |
+| `tvlUsd`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `tvlConfidence`                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `volume24hUsd`                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `volume7dUsd`                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `fees24hUsd`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `fees7dUsd`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `swaps24h`                                                                                                                                                                                                                                      | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `feeApr24h`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Percent. Exactly 0 when LPs earn no fees.                                                                                                                                                                                                       |                                                                                                                                                                                                                                                 |
+| `feeApr7d`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `feeAprFullRange24h`                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Percent, and the honest one: what a *new* full-range dollar would have earned, rather than the return on liquidity already concentrated where the price happens to be.                                                                          |                                                                                                                                                                                                                                                 |
+| `realizedVol24h`                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Annualized standard deviation, in percent.                                                                                                                                                                                                      |                                                                                                                                                                                                                                                 |
+| `realizedVol7d`                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `ilAdjustedApr7d`                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Fee APR less the expected impermanent-loss drag, `sigma^2/8` annualized. The number to sort by: a pool paying 200% on an asset that moves 400% is not a better position than one paying 20% on an asset that moves 30%.                         |                                                                                                                                                                                                                                                 |
+| `price`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | token1 per token0, decimals-adjusted.                                                                                                                                                                                                           |                                                                                                                                                                                                                                                 |
+| `priceChange24hPct`                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `lockedShare`                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Fraction of the liquidity that can never be withdrawn — a launchpad's graduation position. It will not leave when the price moves, and it is not depth anyone chose to provide.                                                                 |                                                                                                                                                                                                                                                 |
+| `memeFdvUsd`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `ranked`                                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | False when the pool is too thin for its APR to mean anything (under 20 swaps in 24h or $1,000 of TVL). Such pools sort last.                                                                                                                    | true                                                                                                                                                                                                                                            |
+| `createdAt`                                                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `lastSwapAt`                                                                                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| `statsUpdatedAt`                                                                                                                                                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |

package/docs/models/components/dexpoolsresponse.md

@@ -0,0 +1,44 @@
+# DexPoolsResponse
+
+## Example Usage
+
+```typescript
+import { DexPoolsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: DexPoolsResponse = {
+  total: 763330,
+  offset: 636055,
+  limit: 142612,
+  pools: [
+    {
+      poolId: 51811,
+      dexVersion: "V3",
+      poolKey: "<value>",
+      token0: {
+        address: "707 Lesch Meadow",
+        kind: "STOCK",
+      },
+      token1: {
+        address: "96147 King Street",
+        kind: "STOCK",
+      },
+      feePpm: 228274,
+      feePct: "<value>",
+      pairClass: "MEME_STOCK",
+      watched: true,
+      lpOpen: false,
+      lpEarnsFees: true,
+      ranked: true,
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                              | Type                                                               | Required                                                           | Description                                                        |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `total`                                                            | *number*                                                           | :heavy_check_mark:                                                 | N/A                                                                |
+| `offset`                                                           | *number*                                                           | :heavy_check_mark:                                                 | N/A                                                                |
+| `limit`                                                            | *number*                                                           | :heavy_check_mark:                                                 | N/A                                                                |
+| `pools`                                                            | [components.DexPoolInfo](../../models/components/dexpoolinfo.md)[] | :heavy_check_mark:                                                 | N/A                                                                |

package/docs/models/components/dextokeninfo.md

@@ -0,0 +1,37 @@
+# DexTokenInfo
+
+## Example Usage
+
+```typescript
+import { DexTokenInfo } from "@compass-labs/api-sdk/models/components";
+
+let value: DexTokenInfo = {
+  address: "596 The Causeway",
+  kind: "STOCK",
+  poolCount: 0,
+  isSuspicious: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                              | Type                                                                                                                               | Required                                                                                                                           | Description                                                                                                                        | Example                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `address`                                                                                                                          | *string*                                                                                                                           | :heavy_check_mark:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `symbol`                                                                                                                           | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `name`                                                                                                                             | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `decimals`                                                                                                                         | *number*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | Null until read on chain. Never assume 18 here: the settlement stablecoin has six.                                                 |                                                                                                                                    |
+| `kind`                                                                                                                             | [components.DexTokenKind](../../models/components/dextokenkind.md)                                                                 | :heavy_check_mark:                                                                                                                 | N/A                                                                                                                                | STOCK                                                                                                                              |
+| `priceUsd`                                                                                                                         | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `priceSource`                                                                                                                      | [components.PriceSource](../../models/components/pricesource.md)                                                                   | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `priceConfidence`                                                                                                                  | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | 0-1. Below 0.6 every USD figure derived from this token is indicative: it came from a pool shallow enough that one trade moves it. |                                                                                                                                    |
+| `priceUpdatedAt`                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                      | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `stock`                                                                                                                            | [components.StockMetadata](../../models/components/stockmetadata.md)                                                               | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `launchpad`                                                                                                                        | [components.LaunchpadMetadata](../../models/components/launchpadmetadata.md)                                                       | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `liquidityUsd`                                                                                                                     | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | Total TVL of the watched pools holding this token.                                                                                 |                                                                                                                                    |
+| `volume24hUsd`                                                                                                                     | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `marketCapUsd`                                                                                                                     | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `fdvUsd`                                                                                                                           | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `priceChange24hPct`                                                                                                                | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |                                                                                                                                    |
+| `poolCount`                                                                                                                        | *number*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                | 0                                                                                                                                  |
+| `isSuspicious`                                                                                                                     | *boolean*                                                                                                                          | :heavy_minus_sign:                                                                                                                 | The token failed a basic sanity check (an unreadable ERC-20).                                                                      | false                                                                                                                              |

package/docs/models/components/dextokenkind.md

@@ -0,0 +1,15 @@
+# DexTokenKind
+
+## Example Usage
+
+```typescript
+import { DexTokenKind } from "@compass-labs/api-sdk/models/components";
+
+let value: DexTokenKind = "STOCK";
+```
+
+## Values
+
+```typescript
+"STOCK" | "STABLE" | "NATIVE" | "WRAPPED_NATIVE" | "MAJOR" | "LAUNCHPAD_MEME" | "OTHER"
+```

package/docs/models/components/dextokenref.md

@@ -0,0 +1,28 @@
+# DexTokenRef
+
+A token as every Risk Yield response describes it.
+
+## Example Usage
+
+```typescript
+import { DexTokenRef } from "@compass-labs/api-sdk/models/components";
+
+let value: DexTokenRef = {
+  address: "89690 Mack Valleys",
+  kind: "STOCK",
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         | Example                                                             |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `address`                                                           | *string*                                                            | :heavy_check_mark:                                                  | N/A                                                                 |                                                                     |
+| `symbol`                                                            | *string*                                                            | :heavy_minus_sign:                                                  | N/A                                                                 |                                                                     |
+| `name`                                                              | *string*                                                            | :heavy_minus_sign:                                                  | N/A                                                                 |                                                                     |
+| `decimals`                                                          | *number*                                                            | :heavy_minus_sign:                                                  | Null until read on chain; never assume 18 on this chain.            |                                                                     |
+| `kind`                                                              | [components.DexTokenKind](../../models/components/dextokenkind.md)  | :heavy_minus_sign:                                                  | N/A                                                                 | STOCK                                                               |
+| `priceUsd`                                                          | *string*                                                            | :heavy_minus_sign:                                                  | N/A                                                                 |                                                                     |
+| `priceSource`                                                       | [components.PriceSource](../../models/components/pricesource.md)    | :heavy_minus_sign:                                                  | N/A                                                                 |                                                                     |
+| `priceConfidence`                                                   | *string*                                                            | :heavy_minus_sign:                                                  | 0-1. Below 0.6 the USD figures derived from it are indicative only. |                                                                     |
+| `stockTicker`                                                       | *string*                                                            | :heavy_minus_sign:                                                  | N/A                                                                 |                                                                     |