Skip to main content

Weather Forecast API

GET Hourly Weather Forecast

GET /v1/forecast to retrieve hourly weather forecast data.

Data Source: Multi-source fusion weather forecast with 1km grid accuracy globally

Forecast Duration: Up to 16 days in the future (supports querying past 3 months of forecast data)

Spatial Resolution: 1km * 1km

Temporal Resolution: Hourly

Update Frequency: Updated every 3 hours

Request Parameters

NameLocationTypeRequiredDescription
longitudequerynumberyesLongitude in numerical format
latitudequerynumberyesLatitude in numerical format
start_datequerystringyesStart date
end_datequerystringyesEnd date
timezonequerystringyesTimezone
hourlyqueryarray[string]yesList of hourly forecast attributes
elevationquerynumbernoElevation
apikeyquerystringyesGenerated after account registration

Sample Response

Success

{
"latitude": 30.25,
"longitude": 120.1875,
"generationtime_ms": 0.03802776336669922,
"utc_offset_seconds": 28800,
"timezone": "Asia/Shanghai",
"timezone_abbreviation": "CST",
"elevation": 5,
"hourly_units": {
"time": "iso8601",
"temperature_2m": "°C",
"relative_humidity_2m": "%"
},
"hourly": {
"time": [
"2024-04-16T00:00",
"2024-04-16T01:00",
......
"2024-04-16T23:00"
],
"temperature_2m": [
16.8,
16.5,
......
16.6
],
"relative_humidity_2m": [
97,
98,
......
99
]
}
}

Bad Request

{
"errors": [
"invalid parameter: longitude must be a number"
]
}

Response Structure

Status CodeStatus MeaningDescriptionData Model
200OKSuccessInline
400Bad RequestBad RequestInline

Response Data Structure

Status Code 400

| Name | Type | Required | Constraints | Description | | --- | --- | --- | --- | --- | --- | | » errors | [string] | true | none | | none |

Example Call

curl --location --request GET 'http://weather-api.xm-opt.com/v1/forecast?longitude=120.21&latitude=30.25&hourly=temperature_2m,relative_humidity_2m&start_date=2024-04-16&end_date=2024-04-16&timezone=Asia/Shanghai&apikey=your-apikey'

{"latitude":30.25,"longitude":120.1875,"utc_offset_seconds":28800,"timezone":"Asia/Shanghai","timezone_abbreviation":"CST","elevation":5.0,"hourly_units":{"time":"iso8601","temperature_2m":"°C","relative_humidity_2m":"%"},"hourly":{"time":["2024-04-16T00:00","2024-04-16T01:00","2024-04-16T02:00","2024-04-16T03:00","2024-04-16T04:00","2024-04-16T05:00","2024-04-16T06:00","2024-04-16T07:00","2024-04-16T08:00","2024-04-16T09:00","2024-04-16T10:00","2024-04-16T11:00","2024-04-16T12:00","2024-04-16T13:00","2024-04-16T14:00","2024-04-16T15:00","2024-04-16T16:00","2024-04-16T17:00","2024-04-16T18:00","2024-04-16T19:00","2024-04-16T20:00","2024-04-16T21:00","2024-04-16T22:00","2024-04-16T23:00"],"temperature_2m":[16.8,16.5,16.4,16.3,15.9,16.2,16.0,16.2,16.3,16.6,17.2,20.6,23.1,24.9,25.0,24.0,23.6,20.2,18.3,17.6,17.2,16.6,16.2,16.4],"relative_humidity_2m":[97,98,99,99,99,99,99,99,99,99,99,88,81,75,74,77,77,93,98,99,99,99,99,98]}}

Hourly Forecast Attribute List

::: temperature_2m,relative_humidity_2m,dew_point_2m,apparent_temperature,precipitation_probability,precipitation,rain,showers,snowfall,snow_depth,weather_code,pressure_msl,surface_pressure,cloud_cover,cloud_cover_low,cloud_cover_mid,cloud_cover_high,visibility,evapotranspiration,et0_fao_evapotranspiration,vapour_pressure_deficit,wind_speed_10m,wind_speed_80m,wind_speed_120m,wind_speed_180m,wind_direction_10m,wind_direction_80m,wind_direction_120m,wind_direction_180m,wind_gusts_10m,temperature_80m,temperature_120m,temperature_180m,soil_temperature_0cm,soil_temperature_6cm,soil_temperature_18cm,soil_temperature_54cm,soil_moisture_0_to_1cm,soil_moisture_1_to_3cm,soil_moisture_3_to_9cm,soil_moisture_9_to_27cm,soil_moisture_27_to_81cm,uv_index,uv_index_clear_sky,is_day,cape,freezing_level_height,sunshine_duration,shortwave_radiation,direct_radiation,diffuse_radiation,direct_normal_irradiance,global_tilted_irradiance,terrestrial_radiation,shortwave_radiation_instant,direct_radiation_instant,diffuse_radiation_instant,direct_normal_irradiance_instant,global_tilted_irradiance_instant,terrestrial_radiation_instant :::

For detailed information, refer to Hourly Forecast Weather Attribute Description

GET 15-Minute Weather Forecast

GET /v1/forecast15Minutes to retrieve 15-minute weather forecast data.

Data Source: Multi-source fusion weather forecast with 1km grid accuracy globally

Forecast Duration: Up to 16 days in the future (supports querying past 3 months of forecast data)

Spatial Resolution: 1km * 1km

Temporal Resolution: 15-minute intervals

Update Frequency: Updated every 3 hours

Request Parameters

NameLocationTypeRequiredDescription
longitudequerynumberyesLongitude in numerical format
latitudequerynumberyesLatitude in numerical format
start_datequerystringyesStart date
end_datequerystringyesEnd date
timezonequerystringyesTimezone
minutely_15queryarray[string]yesList of 15-minute forecast attributes
apikeyquerystringyesGenerated after account registration

Sample Response

Success

{
"latitude": 30.25,
"longitude": 120.1875,
"generationtime_ms": 0.05900859832763672,
"utc_offset_seconds": 28800,
"timezone": "Asia/Shanghai",
"timezone_abbreviation": "CST",
"elevation": 5,
"minutely_15_units": {
"time": "iso8601",
"temperature_2m": "°C",
"relative_humidity_2m": "%"
},
"minutely_15": {
"time": [
"2024-04-17T00:00",
"2024-04-17T00:15",
......
"2024-04-17T23:45"
],
"temperature_2m": [
16.2,
16.1,
......
12.4
],
"relative_humidity_2m": [
98,
98,
......
91
]
}
}

Bad Request

{
"errors": [
"invalid parameter: longitude must be a number"
]
}

Response Structure

Status CodeStatus MeaningDescriptionData Model
200OKSuccessInline
400Bad RequestBad RequestInline

Response Data Structure

Status Code 400

NameTypeRequiredConstraintsDescription
» errors[string]truenone

15-Minute Forecast Attribute List

::: temperature_2m,relative_humidity_2m,dew_point_2m,apparent_temperature,precipitation,rain,snowfall,snow_depth,freezing_level_height,sunshine_duration,weather_code,wind_speed_10m,wind_speed_80m,wind_direction_10m,wind_direction_80m,wind_gusts_10m,visibility,cape,is_day,shortwave_radiation,direct_radiation,diffuse_radiation,direct_normal_irradiance,global_tilted_irradiance,terrestrial_radiation,shortwave_radiation_instant,direct_radiation_instant,diffuse_radiation_instant,direct_normal_irradiance_instant,global_tilted_irradiance_instant,terrestrial_radiation_instant :::

For detailed information, refer to 15-Minute Forecast Weather Attribute Description

GET Daily Weather Forecast

GET /v1/forecastDaily to retrieve daily weather forecast data.

Data Source: Multi-source fusion weather forecast with 1km grid accuracy globally

Forecast Duration: Up to 16 days in the future (supports querying past 3 months of forecast data)

Spatial Resolution: 1km * 1km

Temporal Resolution: Daily

Update Frequency: Updated every 3 hours

Request Parameters

NameLocationTypeRequiredDescription
longitudequerynumberyesLongitude in numerical format
latitudequerynumberyesLatitude in numerical format
start_datequerystringyesStart date
end_datequerystringyesEnd date
timezonequerystringyesTimezone
dailyqueryarray[string]yesList of daily forecast attributes
apikeyquerystringyesGenerated after account registration

Sample Response

Success

{
"latitude": 30.25,
"longitude": 120.1875,
"generationtime_ms": 0.04398822784423828,
"utc_offset_seconds": 28800,
"timezone": "Asia/Shanghai",
"timezone_abbreviation": "CST",
"elevation": 5,
"daily_units":