API

Every openweathermap.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Air Pollution

current

airPollution.current Get current air pollution data for a latitude/longitude pair Risk: read

await corsair.openweathermap.api.airPollution.current({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude
`lon`	`number`	Yes	Longitude

Output

Name	Type	Required	Description
`coord`	`object`	No	—
`list`	`object[]`	No	—

coord full type

tuple | {
}

list full type

{
  dt: number,
  main?: {
    aqi: number
  },
  components?: {
    co?: number,
    no?: number,
    no2?: number,
    o3?: number,
    so2?: number,
    pm2_5?: number,
    pm10?: number,
    nh3?: number
  }
}[]

forecast

airPollution.forecast Get forecasted air pollution data for a latitude/longitude pair Risk: read

await corsair.openweathermap.api.airPollution.forecast({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude
`lon`	`number`	Yes	Longitude

Output

Name	Type	Required	Description
`coord`	`object`	No	—
`list`	`object[]`	No	—

coord full type

tuple | {
}

list full type

{
  dt: number,
  main?: {
    aqi: number
  },
  components?: {
    co?: number,
    no?: number,
    no2?: number,
    o3?: number,
    so2?: number,
    pm2_5?: number,
    pm10?: number,
    nh3?: number
  }
}[]

history

airPollution.history Get historical air pollution data for a latitude/longitude pair and time range Risk: read

await corsair.openweathermap.api.airPollution.history({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude
`lon`	`number`	Yes	Longitude
`start`	`number`	Yes	Start UNIX timestamp (UTC)
`end`	`number`	Yes	End UNIX timestamp (UTC)

Output

Name	Type	Required	Description
`coord`	`object`	No	—
`list`	`object[]`	No	—

coord full type

tuple | {
}

list full type

{
  dt: number,
  main?: {
    aqi: number
  },
  components?: {
    co?: number,
    no?: number,
    no2?: number,
    o3?: number,
    so2?: number,
    pm2_5?: number,
    pm10?: number,
    nh3?: number
  }
}[]

Geocoding

byZip

geocoding.byZip Convert a zip/post code into geographic coordinates Risk: read

await corsair.openweathermap.api.geocoding.byZip({});

Input

Name	Type	Required	Description
`zip`	`string`	Yes	Zip/post code and country code (e.g. E14,GB)

Output

Name	Type	Required	Description
`zip`	`string`	No	—
`name`	`string`	No	—
`lat`	`number`	Yes	—
`lon`	`number`	Yes	—
`country`	`string`	No	—

direct

geocoding.direct Convert a location name into geographic coordinates Risk: read

await corsair.openweathermap.api.geocoding.direct({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	City name, state code, and country code (e.g. London,UK)
`limit`	`number`	No	Max number of results (1-5)

Output: object[]

Output full type

{
  name?: string,
  local_names?: {
  },
  lat: number,
  lon: number,
  country?: string,
  state?: string
}[]

reverse

geocoding.reverse Convert geographic coordinates into location names Risk: read

await corsair.openweathermap.api.geocoding.reverse({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude
`lon`	`number`	Yes	Longitude
`limit`	`number`	No	Max number of results (1-5)

Output: object[]

Output full type

{
  name?: string,
  local_names?: {
  },
  lat: number,
  lon: number,
  country?: string,
  state?: string
}[]

History

timeMachine

history.timeMachine Get historical weather data for a specific timestamp (available from 1979-01-01) Risk: read

await corsair.openweathermap.api.history.timeMachine({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude of the location
`lon`	`number`	Yes	Longitude of the location
`dt`	`number`	Yes	Unix timestamp (UTC) for the requested historical date
`units`	`standard \| metric \| imperial`	No	Units: standard (Kelvin), metric (Celsius), imperial (Fahrenheit)
`lang`	`string`	No	Language code for weather descriptions

Output

Name	Type	Required	Description
`lat`	`number`	Yes	—
`lon`	`number`	Yes	—
`timezone`	`string`	Yes	—
`timezone_offset`	`number`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  dt: number,
  sunrise: number,
  sunset: number,
  temp: number,
  feels_like: number,
  pressure: number,
  humidity: number,
  dew_point: number,
  uvi?: number,
  clouds: number,
  visibility?: number,
  wind_speed: number,
  wind_deg: number,
  wind_gust?: number,
  weather: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  rain?: {
    1h: number
  },
  snow?: {
    1h: number
  }
}[]

Maps

weatherMapTile

maps.weatherMapTile Fetch a Weather Maps 2.0 tile image for a layer and coordinates Risk: read

await corsair.openweathermap.api.maps.weatherMapTile({});

Input

Name	Type	Required	Description
`layer`	`PAC0 \| PR0 \| PA0 \| PAR0 \| PAS0 \| SD0 \| WS10 \| WND \| APM \| TA2 \| TD2 \| TS0 \| TS10 \| HRD0 \| CL`	Yes	Weather map layer code (Maps 2.0 op parameter)
`z`	`number`	Yes	Zoom level
`x`	`number`	Yes	Tile X coordinate
`y`	`number`	Yes	Tile Y coordinate
`date`	`number`	No	Unix timestamp for forecast/historical tile
`opacity`	`number`	No	—
`palette`	`string`	No	—
`fill_bound`	`boolean`	No	—
`arrow_step`	`number`	No	—
`use_norm`	`boolean`	No	—

Output

Name	Type	Required	Description
`contentType`	`image/png`	Yes	—
`dataBase64`	`string`	Yes	—

Stations

create

stations.create Register a new personal weather station with OpenWeather Risk: write

await corsair.openweathermap.api.stations.create({});

Input

Name	Type	Required	Description
`external_id`	`string`	Yes	Your external station identifier
`name`	`string`	Yes	Station name
`latitude`	`number`	Yes	Station latitude
`longitude`	`number`	Yes	Station longitude
`altitude`	`number`	Yes	Station altitude in meters

Output: unknown

get

stations.get Get details for a registered weather station by ID Risk: read

await corsair.openweathermap.api.stations.get({});

Input

Name	Type	Required	Description
`station_id`	`string`	Yes	Internal OpenWeather station ID

Output

Name	Type	Required	Description
`id`	`string`	No	—
`external_id`	`string`	No	—
`name`	`string`	No	—
`latitude`	`number`	No	—
`longitude`	`number`	No	—
`altitude`	`number`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`rank`	`number`	No	—

getMeasurements

stations.getMeasurements Get aggregated measurements from a registered station (minute/hour/day intervals) Risk: read

await corsair.openweathermap.api.stations.getMeasurements({});

Input

Name	Type	Required	Description
`station_id`	`string`	Yes	Internal OpenWeather station ID
`type`	`m \| h \| d`	Yes	Aggregation interval: m, h, or d
`from`	`number`	Yes	Start of interval (Unix timestamp)
`to`	`number`	Yes	End of interval (Unix timestamp)
`limit`	`number`	Yes	Maximum number of records to return

Output: object[]

Output full type

{
  station_id?: string,
  dt?: number,
  date?: number,
  temperature?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  temp?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  wind_speed?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  wind_gust?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  wind_deg?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  pressure?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  humidity?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  },
  precipitation?: number | {
    min?: number,
    max?: number,
    average?: number,
    weight?: number
  }
}[]

list

stations.list List all weather stations registered to your OpenWeather account Risk: read

await corsair.openweathermap.api.stations.list({});

Input: empty object Output: object[]

Output full type

{
  id?: string,
  external_id?: string,
  name?: string,
  latitude?: number,
  longitude?: number,
  altitude?: number,
  created_at?: string,
  updated_at?: string,
  rank?: number
}[]

remove

stations.remove Delete a registered weather station from your account [DESTRUCTIVE] Risk: destructive

await corsair.openweathermap.api.stations.remove({});

Input

Name	Type	Required	Description
`station_id`	`string`	Yes	Internal OpenWeather station ID

Output

Name	Type	Required	Description
`success`	`true`	Yes	—

submitMeasurements

stations.submitMeasurements Submit weather measurements from a registered station Risk: write

await corsair.openweathermap.api.stations.submitMeasurements({});

Input

Name	Type	Required	Description
`measurements`	`object[]`	Yes	Measurement records to submit

measurements full type

{
  station_id: string,
  dt: number,
  temperature?: number,
  wind_speed?: number,
  wind_gust?: number,
  wind_deg?: number,
  pressure?: number,
  humidity?: number,
  precipitation?: number,
  rain_1h?: number,
  snow_1h?: number
}[]

Output

Name	Type	Required	Description
`success`	`true`	Yes	—

update

stations.update Update a registered weather station name, location, or external ID Risk: write

await corsair.openweathermap.api.stations.update({});

Input

Name	Type	Required	Description
`station_id`	`string`	Yes	Internal OpenWeather station ID
`name`	`string`	No	—
`external_id`	`string`	No	—
`latitude`	`number`	No	—
`longitude`	`number`	No	—
`altitude`	`number`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`external_id`	`string`	No	—
`name`	`string`	No	—
`latitude`	`number`	No	—
`longitude`	`number`	No	—
`altitude`	`number`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`rank`	`number`	No	—

Summary

daySummary

summary.daySummary Get aggregated weather summary for a specific date (temperature, wind, precipitation) Risk: read

await corsair.openweathermap.api.summary.daySummary({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude of the location
`lon`	`number`	Yes	Longitude of the location
`date`	`string`	Yes	Date in YYYY-MM-DD format
`units`	`standard \| metric \| imperial`	No	Units: standard (Kelvin), metric (Celsius), imperial (Fahrenheit)
`lang`	`string`	No	Language code for weather descriptions
`tz`	`string`	No	Timezone offset in ±XX:XX format (e.g. +05:30)

Output

Name	Type	Required	Description
`lat`	`number`	Yes	—
`lon`	`number`	Yes	—
`tz`	`string`	Yes	—
`date`	`string`	Yes	—
`units`	`string`	Yes	—
`cloud_cover`	`object`	Yes	—
`humidity`	`object`	Yes	—
`precipitation`	`object`	Yes	—
`temperature`	`object`	Yes	—
`pressure`	`object`	Yes	—
`wind`	`object`	Yes	—

cloud_cover full type

{
  afternoon: number
}

humidity full type

{
  afternoon: number
}

precipitation full type

{
  total: number
}

temperature full type

{
  min: number,
  max: number,
  afternoon: number,
  night: number,
  evening: number,
  morning: number
}

pressure full type

{
  afternoon: number
}

wind full type

{
  max: {
    speed: number,
    direction: number
  }
}

overview

summary.overview Get a human-readable weather overview text for a location and date Risk: read

await corsair.openweathermap.api.summary.overview({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude of the location
`lon`	`number`	Yes	Longitude of the location
`date`	`string`	No	Date in YYYY-MM-DD format (defaults to today)
`units`	`standard \| metric \| imperial`	No	Units: standard (Kelvin), metric (Celsius), imperial (Fahrenheit)

Output

Name	Type	Required	Description
`lat`	`number`	Yes	—
`lon`	`number`	Yes	—
`tz`	`string`	Yes	—
`date`	`string`	Yes	—
`units`	`string`	Yes	—
`weather_overview`	`string`	Yes	—

Weather

circleCity

weather.circleCity Get current weather for cities within a circle around a geographic point Risk: read

await corsair.openweathermap.api.weather.circleCity({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude of circle center
`lon`	`number`	Yes	Longitude of circle center
`cnt`	`number`	No	Number of cities to return (1-50, default 10)
`units`	`standard \| metric \| imperial`	No	—
`lang`	`string`	No	—

Output

Name	Type	Required	Description
`cod`	`string`	No	—
`count`	`number`	No	—
`list`	`object[]`	No	—

list full type

{
  coord?: {
    lon: number,
    lat: number
  },
  weather?: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  main?: {
    temp: number,
    feels_like?: number,
    temp_min?: number,
    temp_max?: number,
    pressure?: number,
    humidity?: number
  },
  wind?: {
    speed: number,
    deg?: number,
    gust?: number
  },
  clouds?: {
    all: number
  },
  dt?: number,
  sys?: {
    country?: string,
    sunrise?: number,
    sunset?: number
  },
  timezone?: number,
  id?: number,
  name?: string,
  cod?: number
}[]

current

weather.current Get current weather for a location by city name, city ID, zip code, or coordinates Risk: read

await corsair.openweathermap.api.weather.current({});

Input

Name	Type	Required	Description
`q`	`string`	No	City name, state code, country code
`id`	`number`	No	OpenWeatherMap city ID
`zip`	`string`	No	Zip/post code with country code
`lat`	`number`	No	Latitude
`lon`	`number`	No	Longitude
`units`	`standard \| metric \| imperial`	No	—
`lang`	`string`	No	—

Output

Name	Type	Required	Description
`coord`	`object`	No	—
`weather`	`object[]`	No	—
`main`	`object`	No	—
`wind`	`object`	No	—
`clouds`	`object`	No	—
`dt`	`number`	No	—
`sys`	`object`	No	—
`timezone`	`number`	No	—
`id`	`number`	No	—
`name`	`string`	No	—
`cod`	`number`	No	—

coord full type

{
  lon: number,
  lat: number
}

weather full type

{
  id: number,
  main: string,
  description: string,
  icon: string
}[]

main full type

{
  temp: number,
  feels_like?: number,
  temp_min?: number,
  temp_max?: number,
  pressure?: number,
  humidity?: number
}

wind full type

{
  speed: number,
  deg?: number,
  gust?: number
}

clouds full type

{
  all: number
}

sys full type

{
  country?: string,
  sunrise?: number,
  sunset?: number
}

forecast5Day

weather.forecast5Day Get 5-day forecast in 3-hour steps (up to 40 timestamps) for a location Risk: read

await corsair.openweathermap.api.weather.forecast5Day({});

Input

Name	Type	Required	Description
`q`	`string`	No	City name, state code, country code
`id`	`number`	No	OpenWeatherMap city ID
`zip`	`string`	No	Zip/post code with country code
`lat`	`number`	No	Latitude
`lon`	`number`	No	Longitude
`units`	`standard \| metric \| imperial`	No	—
`lang`	`string`	No	—
`cnt`	`number`	No	Number of timestamps to return (1-40)

Output

Name	Type	Required	Description
`cod`	`string`	No	—
`message`	`number`	No	—
`cnt`	`number`	No	—
`list`	`object[]`	No	—
`city`	`object`	No	—

list full type

{
  dt: number,
  main?: {
  },
  weather?: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  clouds?: {
  },
  wind?: {
  },
  pop?: number,
  rain?: {
  },
  snow?: {
  },
  sys?: {
  },
  dt_txt?: string
}[]

city full type

{
  id?: number,
  name?: string,
  coord?: {
  },
  country?: string,
  population?: number,
  timezone?: number,
  sunrise?: number,
  sunset?: number
}

oneCall

weather.oneCall Get current weather, minutely/hourly/daily forecasts, and weather alerts for a location Risk: read

await corsair.openweathermap.api.weather.oneCall({});

Input

Name	Type	Required	Description
`lat`	`number`	Yes	Latitude of the location
`lon`	`number`	Yes	Longitude of the location
`exclude`	`current \| minutely \| hourly \| daily \| alerts[]`	No	Parts to exclude from the response: current, minutely, hourly, daily, alerts
`units`	`standard \| metric \| imperial`	No	Units: standard (Kelvin), metric (Celsius), imperial (Fahrenheit)
`lang`	`string`	No	Language code for weather descriptions

Output

Name	Type	Required	Description
`lat`	`number`	Yes	—
`lon`	`number`	Yes	—
`timezone`	`string`	Yes	—
`timezone_offset`	`number`	Yes	—
`current`	`object`	No	—
`minutely`	`object[]`	No	—
`hourly`	`object[]`	No	—
`daily`	`object[]`	No	—
`alerts`	`object[]`	No	—

current full type

{
  dt: number,
  sunrise?: number,
  sunset?: number,
  temp: number,
  feels_like: number,
  pressure: number,
  humidity: number,
  dew_point: number,
  uvi: number,
  clouds: number,
  visibility?: number,
  wind_speed: number,
  wind_deg: number,
  wind_gust?: number,
  weather: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  rain?: {
    1h: number
  },
  snow?: {
    1h: number
  }
}

minutely full type

{
  dt: number,
  precipitation: number
}[]

hourly full type

{
  dt: number,
  temp: number,
  feels_like: number,
  pressure: number,
  humidity: number,
  dew_point: number,
  uvi: number,
  clouds: number,
  visibility?: number,
  wind_speed: number,
  wind_deg: number,
  wind_gust?: number,
  weather: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  pop: number,
  rain?: {
    1h: number
  },
  snow?: {
    1h: number
  }
}[]

daily full type

{
  dt: number,
  sunrise: number,
  sunset: number,
  moonrise: number,
  moonset: number,
  moon_phase: number,
  summary?: string,
  temp: {
    day: number,
    min: number,
    max: number,
    night: number,
    eve: number,
    morn: number
  },
  feels_like: {
    day: number,
    night: number,
    eve: number,
    morn: number
  },
  pressure: number,
  humidity: number,
  dew_point: number,
  wind_speed: number,
  wind_deg: number,
  wind_gust?: number,
  weather: {
    id: number,
    main: string,
    description: string,
    icon: string
  }[],
  clouds: number,
  pop: number,
  rain?: number,
  snow?: number,
  uvi: number
}[]

alerts full type

{
  sender_name: string,
  event: string,
  start: number,
  end: number,
  description: string,
  tags: string[]
}[]

Overview

Plugins

Air Pollution

current

forecast

history

Geocoding

byZip

direct

reverse

History

timeMachine

Maps

weatherMapTile

Stations

create

get

getMeasurements

list

remove

submitMeasurements

update

Summary

daySummary

overview

Weather

circleCity

current

forecast5Day

oneCall

​Air Pollution

​current

​forecast

​history

​Geocoding

​byZip

​direct

​reverse

​History

​timeMachine

​Maps

​weatherMapTile

​Stations

​create

​get

​getMeasurements

​list

​remove

​submitMeasurements

​update

​Summary

​daySummary

​overview

​Weather

​circleCity

​current

​forecast5Day

​oneCall

Air Pollution

current

forecast

history

Geocoding

byZip

direct

reverse

History

timeMachine

Maps

weatherMapTile

Stations

create

get

getMeasurements

list

remove

submitMeasurements

update

Summary

daySummary

overview

Weather

circleCity

current

forecast5Day

oneCall