# Endpoints Overview

## Base URL

```
https://api.synthdata.co
```

All endpoints require the following header:

```
Authorization: Apikey YOUR_API_KEY
```

**Forecast Horizons:** All insight endpoints accept an optional `horizon` query parameter: `1h` , `24h`.

## Prediction Percentiles

Get probabilistic price forecasts.

| Endpoint                               | Description                                                     |
| -------------------------------------- | --------------------------------------------------------------- |
| `GET /insights/prediction-percentiles` | Price percentiles (5th, 50th, 95th, etc.) at 5-minute intervals |

## Leaderboard

Discover top-performing miners.

| Endpoint                     | Description            |
| ---------------------------- | ---------------------- |
| `GET /v2/leaderboard/latest` | Current miner rankings |

Example request:

{% code title="curl" %}

```bash
curl "https://api.synthdata.co/v2/leaderboard/latest?asset=BTC&days=14&limit=10" \
  -H "Authorization: Apikey YOUR_API_KEY"
```

{% endcode %}

## Insights

Advanced analytics derived from predictions.

| Endpoint                                  | Description                   |
| ----------------------------------------- | ----------------------------- |
| `GET /insights/volatility`                | Volatility metrics            |
| `GET /insights/option-pricing`            | Theoretical option prices     |
| `GET /insights/liquidation`               | Liquidation probabilities     |
| `GET /insights/lp-bounds`                 | LP range optimization         |
| `GET /insights/lp-probabilities`          | Price level probabilities     |
| `GET /insights/polymarket/up-down/daily`  | Daily up/down comparison      |
| `GET /insights/polymarket/up-down/hourly` | Hourly up/down comparison     |
| `GET /insights/polymarket/up-down/15min`  | 15 minutes up/down comparison |
| `GET /insights/polymarket/range`          | Polymarket range comparison   |
| `GET /insights/limitless/daily`           | Limitless above comparison    |
| `GET /insights/limitless/hourly`          | Limitless above comparison    |
| `GET /insights/limitless/`15min           | Limitless above comparison    |

## Price Predictions

Full prediction paths for advanced use cases. Contact <support@synthdata.co> for more information.

| Endpoint                                  | Description                                 |
| ----------------------------------------- | ------------------------------------------- |
| `GET /v2/prediction/best`                 | Full prediction paths from top-ranked miner |
| `GET /v2/prediction/latest`               | Full prediction paths from specific miners  |
| `GET /v2/prediction/historical`           | Historical predictions                      |
| `GET /v2/prediction/metamodel`            | Metamodel prediction                        |
| `GET /v2/prediction/metamodel/historical` | Historical predictions of the metamodel     |


---

# 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.synthdata.co/endpoints-overview.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.
