Skip to content

Attribution

Successful data responses include two headers describing data source attribution. A few endpoints that use no third-party data (for example /v1/sky/legend) and errors returned by the gateway itself carry no attribution headers.

Header Type Description
X-Pxie-Attribution JSON array Data sources used for this endpoint
X-Pxie-Attribution-Required true/false Whether you must display attribution
X-Pxie-Attribution: [{"name":"NOAA SWPC","license":"public-domain"}]
X-Pxie-Attribution-Required: false

For endpoints with CC-BY licensed sources:

X-Pxie-Attribution: [{"name":"GFZ Potsdam","license":"CC-BY-4.0","url":"https://kp.gfz-potsdam.de/"}]
X-Pxie-Attribution-Required: true
Tier Attribution Required?
Xplorer (free) Always — must credit “Pxie” + data source
Builder / Scale Only when X-Pxie-Attribution-Required: true

On the free tier, Pxie is automatically prepended as the first source in the attribution array.

License Attribution? Sources
public-domain Free tier only NOAA, NASA, USGS, EPA
CC-BY-4.0 Always GFZ Potsdam, FMI, Geoscience Australia, ISRIC SoilGrids, FAO FAOSTAT
CC-BY-3.0 Always GeoNet NZ
CC-BY Always Copernicus (CMEMS, CAMS, Sentinel-2)
copernicus-marine Always E.U. Copernicus Marine Service (bioluminescence)
OGL-Canada Always AAFC Prairie Soil Zones, Natural Resources Canada
ECCC-data-server Always Environment and Climate Change Canada weather model (sky quality, bioluminescence, aurora visibility) — credit as “Data Source: Environment and Climate Change Canada”
Statistics Canada Open Licence Always Statistics Canada tables
acknowledge Always OpenAQ, FAO ECOCROP
cited Always Published guides and studies used by the crop endpoints
computed Free tier only Pxie-derived calculations

The Attribution? column is a guide. The X-Pxie-Attribution-Required header on each response is what counts.

When X-Pxie-Attribution-Required is true, display each source’s name and link to its url (if provided). Example:

Data: GFZ Potsdam (CC-BY-4.0)

The exact format is flexible — the requirement is that users can identify the data source.