Skip to main content
POST
weather.solar.irradiance

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
latitude
number
required

Latitude, from -90 to 90.

Required range: -90 <= x <= 90
longitude
number
required

Longitude, from -180 to 180.

Required range: -180 <= x <= 180
date
string<date>
required

Calendar date, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
interval
enum<string>
default:1h

Period for each sample.

Available options:
1h,
15m
model
enum<string>
default:all-sky

Solar radiation model.

Available options:
all-sky,
clear-sky
sampling
enum<string>
default:instant

Instantaneous measurement or period mean.

Available options:
instant,
mean
allowPaid
boolean
default:false

Explicitly allow the estimated $0.15 per-date solar source.

utcOffset
string

Fixed time offset, for example +03:00; this is not an IANA zone.

Pattern: ^[+-](?:0\d|1[0-4]):[0-5]\d$
limit
integer
default:10

Maximum records in this page, 1 to 50.

Required range: 1 <= x <= 50
cursor
string

Neutral continuation returned by the previous page.

Maximum string length: 400
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

results
object[]
required

Requested records in this page.

Maximum array length: 50
nextCursor
string

Continuation for the next page.

Required string length: 1 - 400