API Reference
Complete reference documentation for the Snowtrail API.
Try the API
Explore the live API with interactive documentation at api.snowtrail.ai/docs
Base URL
https://api.snowtrail.ai/
Authentication
All requests must include your API key in the x-api-key header:
x-api-key: your-api-key
Products & Endpoints
All data access is through typed product endpoints. The endpoint pattern is:
GET /{product_id}/{dataset_name}
The following products are available:
| Product | Endpoint Prefix | Description |
|---|---|---|
| GBSI-US | /gbsi_us/ | Gas Balance Stress Index - US |
| GBSI-EU | /gbsi_eu/ | Gas Balance Stress Index - EU |
| PEMI | /pemi/ | Power Event Market Intelligence |
| GLMI | /glmi/ | Global LNG Marginality Index |
| WRSI | /wrsi/ | Weather Risk Stress Index |
| WSSI-US | /wssi_us/ | Weather Storage Shock Index |
Each product exposes named dataset endpoints. For example:
GET /gbsi_us/system_stress
GET /gbsi_us/balance_momentum
GET /gbsi_us/storage_surprise
GET /gbsi_eu/system_stress?country=DE
GET /pemi/grid_stress?bidding_zone=DE-LU
GET /glmi/marginality?basin=EU
GET /wrsi/forecast_stress?geography=CONUS
GET /wssi_us/demand_shock?region_id=CONUS
GET /gbsi_us/backtest_summary
Query Parameters
The following query parameters are available on all product endpoints:
| Parameter | Type | Default | Description |
|---|---|---|---|
latest | bool | true | Return most recent records |
date_from | date (YYYY-MM-DD) | n/a | Filter from date (overrides latest) |
date_to | date (YYYY-MM-DD) | n/a | Filter to date |
limit | int | 200 | Maximum number of rows to return |
cursor | string | n/a | Pagination cursor from a previous response |
as_of | date (YYYY-MM-DD) | n/a | Point-in-time date. Returns, per key, the version Snowtrail held on this date (str_observed_at and str_effective_at both on or before it), under the current model. Each product has an effective start; an earlier as_of is not clamped or rejected and can return no rows or earlier-model rows. See Point-in-Time Integrity |
Product-Specific Filters
Some products accept additional filter parameters:
| Product | Parameter | Type | Example | Description |
|---|---|---|---|---|
| GBSI-EU | country | string | DE, FR, NL | Filter by country |
| PEMI | bidding_zone | string | Filter by bidding zone | |
| GLMI | basin | string | EU, ASIA_PAC, US, MENA, AFRICA | Filter by LNG basin |
| WRSI | geography | string | CONUS | Filter by geography |
| WRSI | region_type | string | Filter by region type | |
| WSSI-US | region_id | string | Filter by region identifier | |
| WSSI-US | region_type | string | Filter by region type |
Example Request
curl -H "x-api-key: your-api-key" \
"https://api.snowtrail.ai/gbsi_eu/system_stress?date_from=2026-07-01&date_to=2026-09-30&as_of=2026-09-28&limit=50"
Pagination
When a response contains more rows than the limit, the has_more field will be true and next_cursor will contain a cursor token. Pass it as the cursor parameter in the next request to retrieve the following page:
curl -H "x-api-key: your-api-key" \
"https://api.snowtrail.ai/gbsi_us/system_stress?date_from=2024-01-01&limit=50&cursor=eyJsYXN0X2lkIjogNTB9"
Response Format
{
"product_id": "gbsi_us",
"count": 100,
"has_more": true,
"next_cursor": "eyJsYXN0X2lkIjogMTAwfQ",
"data": [...],
"metadata": {
"retrieved_at": "2026-01-24T15:00:00Z",
"total_count": 250,
"record_id": "req_abc123",
"data_latest_date": "2026-01-24",
"data_age_hours": 0.5
}
}
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized (missing or invalid API key) |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limit Exceeded |
| 500 | Internal Server Error |