Skip to main content
POST
weather.timeline.get

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
start
string<date-time>
required

Date and time with an explicit UTC offset.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
end
string<date-time>
required

Date and time with an explicit UTC offset.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
metrics
object[]
required

Up to 50 typed quantities; archives allow 10.

Required array length: 1 - 50 elements
latitude
number

Latitude, from -90 to 90.

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

Longitude, from -180 to 180.

Required range: -180 <= x <= 180
geometry
object

Bounded geographic shape, using longitude then latitude.

advanced
boolean
default:false

Explicitly allow advanced paid weather layers or area calculations.

timezone
string

IANA time zone, for example Europe/London.

Maximum string length: 100
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_-]+$
resolution
enum<string>
default:1h

Time step between records.

Available options:
current,
1m,
15m,
1h,
1d
archive
boolean
default:false

Select paid historical archive explicitly.

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