> For the complete documentation index, see [llms.txt](https://docs.synthdata.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.synthdata.co/getting-started.md).

# Getting Started

Get up and running with Synth API in minutes.

💡 **Tip:** Some insights have optional `horizon=1h` that can be requested for high frequency 1-hour predictions instead of the default 24-hour horizon.

<pre class="language-shellscript"><code class="lang-shellscript"><strong>curl "https://api.synthdata.co/insights/prediction-percentiles?asset=BTC&#x26;horizon=1h" -H "Authorization: Apikey YOUR_API_KEY"
</strong></code></pre>

## What You'll Need

{% stepper %}
{% step %}

### API Key

Get an API key from your [Synth Dashboard](https://dashboard.synthdata.co/).
{% endstep %}

{% step %}

### Make a Request

```bash
curl "https://api.synthdata.co/insights/prediction-percentiles?asset=BTC" \
  -H "Authorization: Apikey YOUR_API_KEY"
```

{% endstep %}

{% step %}

### Parse the Response

```python
import requests

response = requests.get(
    "https://api.synthdata.co/insights/prediction-percentiles",
    headers={"Authorization": "Apikey YOUR_API_KEY"},
    params={"asset": "BTC"}
)

data = response.json()
current_price = data['current_price']
percentiles = data['forecast_future']['percentiles']

# Get 24h forecast
final = percentiles[-1]
median = final['0.5']
lower = final['0.05']
upper = final['0.95']

print(f"Current: ${current_price:,.2f}")
print(f"24h Median: ${median:,.2f}")
print(f"24h 90% CI: ${lower:,.0f} - ${upper:,.0f}")
```

{% endstep %}
{% endstepper %}

## Common Parameters

| Parameter | Value                                                                                                   | Description                                                        |
| --------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `asset`   | `BTC`, `ETH`, `SOL`, `HYPE`, `XRP`, `SPYX`, `XAU`, `WTIOIL` `NVDAX`, `AAPLX`, `GOOGLX`, `TSLAX`, `SPCX` | Asset to forecast                                                  |
| `horizon` | `1h` `24h`                                                                                              | Forecast horizon, `1h` for high frequency, `24h` for low frequency |
| `days`    | `14` (default)                                                                                          | Days for meta-leaderboard ranking                                  |
| `limit`   | `10` (default)                                                                                          | Number of top miners to use                                        |