Skip to main content
POST
Daily weather forecast for a coordinate or QWeather location id. Returns a normalized Forecast.

Authorizations

Authorization
string
header
required

AgentKey API key (ak_…).

Body

application/json
days
enum<integer>
default:7

Forecast length in days (QWeather granularities).

Available options:
3,
7,
10,
15,
30
fields
string[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_raw
boolean
default:false

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

lang
string

BCP 47 language for condition / wind texts, e.g. en, zh-Hans; default is the provider's (Chinese).

lat
number

Latitude in decimal degrees. Required unless location_id is given.

Required range: -90 <= x <= 90
location_id
string

QWeather LocationID (e.g. 101010100 for Beijing) from the QWeather geo API. Give either lat / lon or location_id, not both.

lon
number

Longitude in decimal degrees. Required unless location_id is given.

Required range: -180 <= x <= 180
provider
string

Shorthand for routing.only = [provider].

routing
object

Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.

Response

Success envelope

Success envelope whose data is a Forecast.

attempts
object[]
required
credits_charged
number
required

Credits charged for this call (the method's fixed price).

data
object
required

A multi-day weather forecast for one location.

op
string
required

Method name.

op_version
integer
required

Method version that served the call.

provider
string
required

Provider that actually served the call.

request_id
string
required

Correlation id; quote it in support requests.

took_ms
integer
required
unsupported_fields
string[]
required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

raw
any

Upstream payload, only with include_raw=true. Not a stable contract.

raw_truncated
boolean