> For the complete documentation index, see [llms.txt](https://docs.satoshiterminal.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.satoshiterminal.io/resources/copy-of-defi-analytics/adoption-and-ecosystem-health/protocol-sustainability-index.md).

# 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.