# Yield Aggregator

**Key Tables**:

* **Pools**: Information about vault pools, including underlying tokens, pool address, and receipt tokens.
* **Position Snapshot**: Snapshot of user positions, detailing underlying tokens and their value.
* **Pool Snapshot**: Snapshot of individuals pools, tracking TVL, fees, and other high-level metrics.
* **Events**: Tracks user interactions such as deposits, withdrawals, and changes to positions.Pools

{% tabs %}
{% tab title="Pools" %}

| Property                    | Description                                                                     | Type   |
| --------------------------- | ------------------------------------------------------------------------------- | ------ |
| chain\_id                   | The standard chain id.                                                          | number |
| timestamp                   | The timestamp this pool was created.                                            | number |
| creation\_block\_number     | The block number that this pool was created.                                    | number |
| underlying\_token\_address  | The contract address of the underlying token or deposited token.                | string |
| underlying\_token\_index    | The index of the underlying token in the smart contract, default 0.             | number |
| underlying\_token\_symbol   | The symbol of the underlying token token.                                       | string |
| underlying\_token\_decimals | The decimal amount of the underlying token.                                     | number |
| receipt\_token\_address     | The contract address of the output or receipt token of this pool, if available. | string |
| receipt\_token\_symbol      | The symbol of the receipt token.                                                | string |
| receipt\_token\_decimals    | The symbol decimal amount for the receipt token.                                | number |
| pool\_address               | The smart contract address of the pool.                                         | string |
| pool\_symbol                | The symbol of the pool.                                                         | string |
| {% endtab %}                |                                                                                 |        |

{% tab title="Position Snapshot" %}

| Property                       | Description                                                                                                       | Type   |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- | ------ |
| timestamp                      | The timestamp of the snapshot.                                                                                    | number |
| block\_date                    | The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots). | date   |
| chain\_id                      | The standard chain id.                                                                                            | number |
| pool\_address                  | The address of the pool this user has a position in.                                                              | string |
| user\_address                  | The address of the user who has a position in the pool.                                                           | string |
| underlying\_token\_address     | The address of the supplied underlying token.                                                                     | string |
| underlying\_token\_index       | The index in the smart contract of this underlying token, default 0.                                              | number |
| underlying\_token\_amount      | The amount of the underlying token that the user deposited, decimal normalized.                                   | number |
| underlying\_token\_amount\_usd | The amount of underlying tokens supplied, in USD.                                                                 | number |
| total\_fees\_usd               | The total amount of revenue and fees paid in this pool in the given snapshot, in USD.                             | number |
| {% endtab %}                   |                                                                                                                   |        |

{% tab title="Pool Snapshot" %}

| Property                       | Description                                                                                                       | Type   |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- | ------ |
| timestamp                      | The timestamp of the snapshot.                                                                                    | number |
| block\_date                    | The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots). | date   |
| chain\_id                      | The standard chain id.                                                                                            | number |
| underlying\_token\_address     | The contract address of the underlying token or deposited token.                                                  | string |
| underlying\_token\_index       | The index of the underlying token in the smart contract, default 0.                                               | number |
| pool\_address                  | The address of the pool.                                                                                          | string |
| underlying\_token\_amount      | The amount of underlying token supplied in this pool, decimal normalized.                                         | number |
| underlying\_token\_amount\_usd | The amount of underlying tokens supplied in this pool, in USD.                                                    | number |
| total\_fees\_usd               | The total amount of revenue and fees paid in this pool in the given snapshot, in USD.                             | number |
| {% endtab %}                   |                                                                                                                   |        |

{% tab title="Events" %}

| Property                   | Description                                                                                     | Type   |
| -------------------------- | ----------------------------------------------------------------------------------------------- | ------ |
| timestamp                  | The timestamp of the transaction.                                                               | number |
| chain\_id                  | The standard id of the chain.                                                                   | number |
| block\_number              | The block number of the trade.                                                                  | number |
| log\_index                 | The event log. For transactions that don't emit event, create arbitrary index starting from 0.  | number |
| transaction\_hash          | The hash of the transaction.                                                                    | string |
| user\_address              | The address that initiates the transaction (ie, the transaction signer).                        | string |
| taker\_address             | The address that owns the position (ie, most of the time, it is the same as the user\_address). | string |
| pool\_address              | The smart contract address of the pool.                                                         | string |
| underlying\_token\_address | The contract address of the underlying token or deposited token.                                | string |
| amount                     | The amount of token transacted, decimal normalized.                                             | number |
| amount\_usd                | The amount of token transacted, in USD.                                                         | number |
| event\_type                | The type of event, corresponds to the action taken by the user (ie, deposit, withdrawal).       | string |
| {% endtab %}               |                                                                                                 |        |
| {% endtabs %}              |                                                                                                 |        |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.openblocklabs.com/data-offering/defi-canonical-data/yield-aggregator.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
