Skip to main content
POST
Resolve coverage

Body

application/json

A bounded climate query. JSON is the default representation. The response contains data directly; no download or acquisition job is required.

Data meaning is independent of representation and delivery. JSON (default) and CSV are returned inline. Bbox order: west,south,east,north; no antimeridian crossing. Date bounds inclusive; at most 31 days and 10,000 cells; actual coverage must pass resolve. dataset_version pins reproducibility.

variables
enum<string>[]
required
Required array length: 1 element
Available options:
air_temperature_max,
air_temperature_min,
precipitation_amount
region
object
required
period
object
required
temporal_resolution
string
required
Allowed value: "daily"
spatial_resolution
string
required
Allowed value: "native"
units
object
required

Exactly one entry, for the requested variable.

data_class
string
required
Allowed value: "interpolated_observation"
missing_policy
string
required
Allowed value: "preserve"
format
enum<string>
default:json
Available options:
json,
csv
source_preference
enum<string>
default:auto

auto picks the finest source covering the region: SILO (Australia), NOAA nClimGrid-Daily (contiguous US), NOAA CPC (global).

Available options:
auto,
silo,
nclimgrid,
cpc
dataset_version
string

Pin an immutable published dataset version. Omit to choose a compatible public version.

Pattern: ^[a-zA-Z0-9_-]{1,128}$

Response

Coverage checked. available=false is a successful preflight with an unavailable reason.

available
boolean
required
reason
enum<string>
required
Available options:
available,
coverage_unavailable,
request_too_large,
no_cell_centers,
unsupported_grid
selection
object | null
required
acquisitionEnabled
boolean
required

True when POST /api/v1/data/requests can acquire this missing coverage from the source.