> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alphractal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint Structure

> Endpoint categories, URL patterns, time conventions, and the stability contract.

## Endpoint categories

Each group in the API Reference maps to a data domain:

| Group | What it carries |
| - | - |
| **Market** | price, returns, volatility, valuation and growth indicators |
| **Addresses**, **Addresses Supply**, **Holder Supply**, **Supply** | address cohorts, balance bands and supply distribution |
| **Lifespan** | SOPR, realised price and other lifecycle metrics |
| **Transaction**, **Blocks**, **Fees**, **Mining** | base-layer activity, block data, fee levels and miner metrics |
| **Derivatives**, **OHLCVPerpetual**, **Liquidation Levels** | funding, open interest, positioning, perpetual candles and liquidations |
| **OHLCVSpot**, **OHLCV Metadata** | spot candles, and the venues/symbols/timeframes behind them |
| **Exchange Flow** | reserves and flows across exchange entities |
| **Cycle**, **Signals**, **Screener** | cycle indicators, computed signals and cross-asset screening |
| **Macro**, **Macro Liquidity**, **Sentiment** | macroeconomic series, liquidity aggregates and sentiment gauges |
| **Summary**, **Metadata** | asset summaries, discovery and endpoint introspection |

## Endpoint structure

Endpoints follow one of these patterns:

* **Asset-scoped metric** — the large majority of the API

  ```
  /{asset}/{category}/{metric}
  ```

  Returns a time-series for a single metric and asset, as a plain JSON array.
* **Catalog and summary**

  ```
  /assets
  /spot/symbols
  /spot/timeframes
  /summary/{AssetId}
  /screener
  ```

  Discovery and cross-asset views: which assets, symbols and timeframes exist, and
  aggregated snapshots per asset.

## Selecting a range

Metric endpoints are bounded by date, not by page:

* `startDate` and `endDate` define the window.
* `timeframe` selects the resolution, where the metric supports more than one.
* A few endpoints accept `limit` to cap the number of returned datapoints.

There is no cursor, offset or page parameter — request the window you need.

## How to read an endpoint definition

Each endpoint page in the API Reference carries:

* **Description** – what the endpoint returns
* **Data coverage** – how many assets answer for it, the date range, and the timeframes and
  venues it accepts
* **Parameters** – path and query inputs, with the accepted values listed where they are known
* **Response** – the fields returned, with a live example

If a parameter or field is not explicitly documented, treat it as unsupported.

## Time and ordering

* All timestamps are returned in **UTC**, ISO-8601.
* Aggregated series (on-chain, exchange flow, derivatives metrics) come back ordered by
  `time`.
* **Do not rely on ordering for raw OHLCV and derivatives series.** Sort by `time` on your
  side if your logic depends on it.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.