Skip to main content

OpenAPI Reference

Interactive API documentation powered by OpenAPI/Swagger.

API Specification​

The OpenAPI specification is available at:

  • https://api.snowtrail.ai/openapi.json
  • https://api.snowtrail.ai/openapi.yaml

Endpoint Pattern​

All endpoints follow the pattern /{product_id}/{dataset_name}:

GET /gbsi_us/system_stress
GET /gbsi_us/balance_momentum
GET /gbsi_us/storage_surprise
GET /gbsi_us/backtest_summary
GET /gbsi_eu/system_stress
GET /pemi/grid_stress
GET /glmi/marginality
GET /wrsi/forecast_stress
GET /wssi_us/demand_shock

Common Parameters​

ParameterTypeDescription
latestboolReturn most recent records (default: true)
date_fromstringStart date (YYYY-MM-DD)
date_tostringEnd date (YYYY-MM-DD)
limitintegerMax results (default: 200)
as_ofstringPoint-in-time date (YYYY-MM-DD)
cursorstringPagination cursor