# Protocol Sustainability Index

**Implementation Details**

**Class Names**

| Model Name                  | Parameters Class                  | Data Class                 |
| --------------------------- | --------------------------------- | -------------------------- |
| ProtocolSustainabilityIndex | ProtocolSustainabilityQueryParams | ProtocolSustainabilityData |

**Import Statement**

```python
pythonCopyEditfrom satoshi_terminal.models.protocol_sustainability_index import (
    ProtocolSustainabilityIndex,
    ProtocolSustainabilityQueryParams,
    ProtocolSustainabilityData,
)
```

***

**Parameters**

| Name            | Type | Description                                                     | Default | Optional |
| --------------- | ---- | --------------------------------------------------------------- | ------- | -------- |
| protocol\_name  | str  | Name of the protocol to evaluate (e.g., Uniswap, Aave).         | None    | False    |
| metric\_weights | dict | Weights for sustainability metrics (e.g., TVL, user retention). | None    | True     |
| time\_horizon   | int  | Time window (in days) for evaluating sustainability.            | 30      | True     |

***

**Data**

| Name                  | Type     | Description                                       |
| --------------------- | -------- | ------------------------------------------------- |
| protocol\_name        | str      | Name of the protocol analyzed.                    |
| sustainability\_score | float    | Overall sustainability score (0-100).             |
| metric\_breakdown     | dict     | Contribution of each metric to the overall score. |
| timestamp             | datetime | Timestamp of the analysis.                        |

***

**Key Features**

* **Multi-Metric Evaluation:** Combines metrics like TVL, user retention, and liquidity stability to assess protocol sustainability.
* **Customizable Weighting:** Users can prioritize specific metrics to align with their analysis goals.
* **Trend Analysis:** Tracks changes in sustainability scores over time.


---

# 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.satoshiterminal.io/resources/copy-of-defi-analytics/adoption-and-ecosystem-health/protocol-sustainability-index.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.