Surpl Developer API

Access normalised solar generation data for members who explicitly authorise your organisation. Consent is enforced at the database level and revocable at any time.

Authentication

Send your secret key as a bearer token. Keys are shown once at creation and stored only as a hash.

curl https://api.surpl.ie/v1/summaries \
  -H "Authorization: Bearer sk_surpl_xxxx_xxxxxxxx"

Endpoints

GET

/v1/readings

Latest normalised readings for consented members.

GET

/v1/summaries

Daily generation summaries.

GET

/v1/devices

Connected inverters (no credentials).

GET

/v1/solarcast/national

All-island probabilistic solar (MW).

GET

/v1/solarcast/zone/{zoneId}

Transmission zone aggregate forecast.

GET

/v1/solarcast/substation/{id}

Substation net-load forecast.

Full machine-readable spec: OpenAPI 3.1

Rate limits

Limits scale with your plan (Starter 60/min up to Enterprise 5,000/min), plus a monthly call quota. Exceeding a limit returns 429.