Skip to main content

Naming Conventions

Standard naming patterns used across Snowtrail.

Dataset Names​

Snowtrail uses flat, descriptive dataset names for signals, features, and events within each product. These names map directly to SDK methods and API endpoints.

Examples:

  • system_stress: System stress signal (GBSI-US, GBSI-EU)
  • balance_momentum: Balance momentum signal
  • grid_stress: Grid stress signal (PEMI)
  • price_context: Price context signal

In the Python SDK, these dataset names are accessed as methods on the product object:

from snowtrail import Snowtrail
client = Snowtrail(api_key="your-api-key")

df = client.gbsi_us.system_stress()
df = client.gbsi_us.balance_momentum()
df = client.glmi.marginality()

Product Codes​

CodeFull Name
gbsi_usGas Balance Stress Index - US
gbsi_euGas Balance Stress Index - EU
glmiGlobal LNG Marginality Index
pemiPower Event Market Intelligence
wrsiWeather Risk Stress Index
wssi_usWeather Storage Shock Index
note

Product codes use underscores in the API and SDK (e.g. gbsi_us). Display names use hyphens (e.g. GBSI-US).

Time Conventions​

  • All timestamps are UTC
  • Date format: YYYY-MM-DD
  • Datetime format: YYYY-MM-DDTHH:MM:SSZ