# Token Fear and Greed index

- Method: `GET`
- Path: `/token/{id}/fear-greed-index`
- Tier: Basic
- HTML docs: https://docs.hiddensystems.ai/nebula/reference/get-token-id-fear-greed-index/
- Interactive docs: https://docs.hiddensystems.ai/nebula/#endpoint=get-token-id-fear-greed-index

## Description

Fear and Greed index time-series for the token (0–100 scale). Diagnostics are omitted by default; pass debug=true to include model diagnostic fields.

## cURL Example

```bash
curl --request GET \
  --url 'https://nebula-api.hiddensystems.ai/api/v1/public/token/bitcoin/fear-greed-index' \
  --header 'X-API-Key: YOUR_API_KEY'
```

## Path Parameters

- `id` (string, required): Token identifier. Accepts internal token_id (integer) or coingecko_id (string, e.g. bitcoin).

## Query Parameters

- `hours` (integer, optional): Lookback window in hours.
- `granularity` (string, optional): Optional bucket size override. If provided, response is aggregated at this interval regardless of lookback window.
- `debug` (boolean, optional): Set true to include diagnostic fields in the response.

## Response

OK

- `current` (object): Latest Fear and Greed index value.
- `current.index` (number (double)): Index value (typically 0-100 scale).
- `current.label` (string): Human-readable label for the index regime.
- `debug` (object): Optional diagnostics included only when debug=true.
- `metadata` (object): Model metadata and component weights.
- `metadata.components` (array<object>): Model components contributing to the index.
- `metadata.components[].description` (string): No description provided.
- `metadata.components[].name` (string): Display name.
- `metadata.components[].weight` (number (double)): No description provided.
- `metadata.hours` (integer): Lookback window in hours used to compute the metric.
- `metadata.labels` (array<string>): Human-readable labels for index regimes.
- `metadata.scale` (string): No description provided.
- `metadata.token_id` (integer (int64)): Internal token identifier.
- `series` (array<object>): Fear and Greed index time series.
- `series[].absolute_momentum` (number (double)): Composite absolute momentum component.
- `series[].debug_mom_long` (integer): No description provided.
- `series[].debug_mom_short` (integer): No description provided.
- `series[].debug_sent_long` (integer): No description provided.
- `series[].debug_sent_short` (integer): No description provided.
- `series[].debug_vol_long` (integer): No description provided.
- `series[].debug_vol_short` (integer): No description provided.
- `series[].emotions` (number (double)): No description provided.
- `series[].immediate_momentum` (number (double)): Momentum contribution from the most recent window.
- `series[].immediate_sentiment` (number (double)): Sentiment contribution from the most recent window.
- `series[].immediate_volume` (number (double)): Volume contribution from the most recent window.
- `series[].index` (number (double)): Index value (typically 0-100 scale).
- `series[].label` (string): Human-readable label for the index regime.
- `series[].long_abs_momentum` (number (double)): Long-horizon absolute momentum component.
- `series[].long_rel_momentum` (number (double)): Long-horizon relative momentum component.
- `series[].momentum` (number (double)): No description provided.
- `series[].post_volume` (number (double)): Post volume used in the Fear and Greed index calculation.
- `series[].relative_momentum` (number (double)): Composite relative momentum component.
- `series[].relative_volume` (number (double)): Relative social or trading volume vs baseline.
- `series[].sentiment` (number (double)): No description provided.
- `series[].short_abs_momentum` (number (double)): Short-horizon absolute momentum component.
- `series[].short_rel_momentum` (number (double)): Short-horizon relative momentum component.
- `series[].social_volume_multiplier` (number (double)): Multiplier capturing how elevated social volume is vs baseline.
- `series[].time` (string (date-time)): UTC timestamp for the data point.
- `series[].volatility` (number (double)): No description provided.

Media type: `application/json`

## JSON Response

```json
{
  "current": {
    "index": 42.7,
    "label": "Fear"
  },
  "metadata": {
    "components": [
      {
        "description": "Volatility component on a 0-100 greed scale.",
        "name": "volatility",
        "weight": 0.16
      }
    ],
    "hours": 168,
    "labels": [
      "Extreme Fear (0-24)",
      "Fear (25-49)",
      "Greed (50-74)",
      "Extreme Greed (75-100)"
    ],
    "scale": "0-100",
    "token_id": 1
  },
  "series": [
    {
      "index": 42.7,
      "label": "Fear",
      "time": "2026-01-15T00:00:00Z"
    }
  ]
}
```
