API console
Pick a route of the Kuma Data Core API and fill in its parameters. The code updates as you type.
api.kumascience.com Documentation
GET /v1/health
Service health
Tells whether the API is up and which release it serves. Answers without a key.
No key JSON
GET /v1/edition
Published edition
The release served by the API, to cite with the DOI.
No key JSON
POST /v1/cles
Get a key
The key is issued immediately and shown only once.
No key JSON
GET /v1/series
Series catalogue
Paginated list of series, with filters.
Key required JSON
GET /v1/series/{code_serie}
Series measurements
Metadata and measurements of a series, as JSON or CSV.
Key required JSON or CSV
GET /v1/localites
Location register
Paginated list of the geographic reference set, from continent to town.
Key required JSON
GET /v1/localites/resolution
Location of a point
Returns the location whose grid cell contains the point.
Key required JSON
GET /v1/localites/{code}
Location detail
Record of one location, with its coordinates.
Key required JSON
GET /v1/grandeurs/poa_parametrable
Plane-of-array irradiation
Computed with the Perez (1990) model from a GHI series. Without DNI and DHI, it falls back to the Liu-Jordan model.
Key required JSON or CSV
GET /v1/grandeurs/poa_bifacial
Bifacial irradiation
Rows of bifacial modules, infinite sheds model. The location’s DNI and DHI series are required.
Key required JSON or CSV
GET /v1/grandeurs/productible_correction_thermique
PV yield, thermal correction
PV output corrected for cell temperature (NOCT, Ross 1980).
Key required JSON or CSV
GET /v1/grandeurs/productible_pr_fourni
PV yield, given PR
PV output from a performance ratio you supply, with or without temperature correction.
Key required JSON or CSV
GET /v1/grandeurs/energie_utile_ecs
Solar water heating
Useful energy at the collector, Hottel-Whillier-Bliss model. It needs a GHI series and the T2M series of the same location.
Key required JSON or CSV
GET /v1/grandeurs/degre_jour_climatisation
Cooling degree days
Monthly sum of degrees above a base temperature (Erbs 1983), from a T2M series.
Key required JSON or CSV
GET /v1/grandeurs/ghi_exceedance/{code_localite}
Annual P50 and P90
Annual irradiation exceeded one year in two and nine in ten, over 1991-2020.
Key required JSON
GET /v1/grandeurs/taux_salissure_proxy/{code_serie_source}
Soiling losses
Transmission loss estimated with the HSU model, from a PM2.5 series.
Key required JSON
GET /v1/grandeurs/pr_realiste/{code_serie_source}
Seasonal realistic PR
Effective performance ratio of the site, corrected for temperature and soiling, from a GHI series.
Key required JSON
GET /v1/grandeurs/incertitude_inter_source/{code_localite}
Cross-source uncertainty
Gap between satellite sources for one location.
Key required JSON
GET /v1/grandeurs/incertitude_inter_source
Uncertainty, all locations
Paginated list of the atlas uncertainty records.
Key required JSON
GET /v1/horaire/{localite}/{grandeur}
Hourly values
Hourly values in UTC over a date window, as JSON or CSV.
Key required JSON or CSV
GET /v1/horaire/{localite}/{grandeur}/disponibilite
Available hourly range
First and last date served for a location and quantity.
Key required JSON
GET /v1/calage
Calibration references
Published reference stations and the locations they cover.
Key required JSON
GET /v1/calage/{localite}/{grandeur}
Seasonal biases
Satellite bias against the ground for each season, with the correction factor.
Key required JSON
GET /v1/etudes/capsule
Full resource at a point
All the engine’s data for a point, in the kuma-ressource-1 format: a JSON header followed by CSV data.
Key required Text