--- openapi: 3.0.3 info: title: ECMWF Vert Forecast - A Weather Source API description: "Hourly vertically interpolated forecast data from the ECMWF model for latitude/longitude points,OnPoint Ids. Hourly forecast is up to 10 days out from current day. The Weather Source ECMWF Vert Forecast API is built upon the [OnPoint™ Platform](https://weathersource.com/products/onpoint-platform/) which ensures data that is gap-free, homogeneous, and ready for immediate analysis. We offer the highest resolution grid on the market, covering every landmass in the world and up to 200 miles offshore.\n\n **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation.\n \n When using the \\\"Try it out\\\" capability in the documentation, the API key should be added by clicking the green \\\"Authorize\\\" button at the top of the page.\n" termsOfService: https://weathersource.com/company/legal/terms-of-service/ contact: name: Weather Source APIs url: https://developer.weathersourceapis.com/ email: support@weathersource.com version: 2.0.0 servers: - url: https://ecmwfvertforecast.weathersourceapis.com/v2 security: - ApiKeyAuth: [] tags: - name: points description: Latitude/Longitude ECMWF Vert forecast data - name: onpoints description: OnPoint™ point ECMWF Vert forecast data paths: /points/{latitude},{longitude}/height/{height}/hours: get: tags: - points summary: The complete hourly ECMWF Vert forecast for a Latitude/Longitude point. description: | Returns the complete set of ECMWF forecast data for a Latitude/Longitude point. *Alternatively using a query that specificies just the hours required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: latitude in: path description: A latitude value between -90° and 90°. required: true schema: maximum: 90 minimum: -90 type: number format: float example: 38.8552 - name: longitude in: path description: A longitude value between -180° (West) and 180° (East). required: true schema: maximum: 180 minimum: -180 type: number format: float example: -77.0513 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/height/{height}/hours/{timestamp}: get: tags: - points summary: An hour of ECMWF Vert forecast data for a Latitude/Longitude point. description: | Returns a single hour of ECMWF Vert forecast data for a Latitude/Longitude point. The provided timestamp must exist within the current valid 10-day forecast range. **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: latitude in: path description: A latitude value between -90° and 90°. required: true schema: maximum: 90 minimum: -90 type: number format: float example: 38.8552 - name: longitude in: path description: A longitude value between -180° (West) and 180° (East). required: true schema: maximum: 180 minimum: -180 type: number format: float example: -77.0513 - name: timestamp in: path description: A timestamp formatted as an RFC3339 date-time value. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/height/{height}/hours/{timestampStart},{timestampEnd}: get: tags: - points summary: A contiguous range of hourly ECMWF Vert forecast data for a Latitude/Longitude point. description: | Returns a contiguous range of hourly ECMWF Vert forecast data for a Latitude/Longitude point. The provided timestamps must exist within the current valid 10-day forecast range. **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: latitude in: path description: A latitude value between -90° and 90°. required: true schema: maximum: 90 minimum: -90 type: number format: float example: 38.8552 - name: longitude in: path description: A longitude value between -180° (West) and 180° (East). required: true schema: maximum: 180 minimum: -180 type: number format: float example: -77.0513 - name: timestampStart in: path description: A timestamp formatted as an RFC3339 date-time value that must occur temporally before timestampEnd. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: timestampEnd in: path description: A timestamp formatted as an RFC3339 date-time value that must occur temporally after timestampStart. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/height/{height}/hours: get: tags: - onpoints summary: The complete hourly ECMWF Vert forecast for an OnPoint™ ID. description: | Returns the complete set of ECMWF Vert forecast data for an OnPoint™ ID. *Alternatively using a query that specificies just the hours required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: onpointId in: path description: An OnPoint™ ID. required: true schema: type: integer example: 10725864 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/height/{height}/hours/{timestamp}: get: tags: - onpoints summary: An hour of ECMWF Vert forecast data for an OnPoint™ ID. description: | Returns a single hour of ECMWF Vert forecast data for an OnPoint™ ID. The provided timestamp must exist within the current valid 10-day forecast range. **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: onpointId in: path description: An OnPoint™ ID. required: true schema: type: integer example: 10725864 - name: timestamp in: path description: A timestamp formatted as an RFC3339 date-time value. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for an OnPoint™ ID. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/height/{height}/hours/{timestampStart},{timestampEnd}: get: tags: - onpoints summary: A contiguous range of hourly ECMWF Vert forecast data for an OnPoint™ ID. description: | Returns a contiguous range of hourly ECMWF Vert forecast data for an OnPoint™ ID. The provided timestamps must exist within the current valid 10-day forecast range. **IMPORTANT:** To authenticate to the Weather Source ECMWF Vert Forecast API, each request must contain your API key set to a custom header named `X-API-KEY`. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. When using the \"Try it out\" capability in the documentation, the API key should be added by clicking the green \"Authorize\" button at the top of the page. parameters: - name: onpointId in: path description: An OnPoint™ ID. required: true schema: type: integer example: 10725864 - name: timestampStart in: path description: A timestamp formatted as an RFC3339 date-time value that must occur temporally before timestampEnd. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: timestampEnd in: path description: A timestamp formatted as an RFC3339 date-time value that must occur temporally after timestampStart. The UTC offset is required. required: true schema: type: string format: date-time example: 2019-12-20T23:00:00-05:00 - name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular - name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 - name: unitScale in: query description: The unit scale for returned values.
required: false schema: type: string example: IMPERIAL default: IMPERIAL enum: - IMPERIAL - METRIC - SI responses: "200": description: Hourly ECMWF Vert forecast response for an OnPoint™ ID. content: application/json: schema: $ref: '#/components/schemas/ecmwfForecastOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' components: schemas: fieldListHourObj: title: fieldListObj required: - fields type: object properties: fields: $ref: '#/components/schemas/fields' description: A list of returned field names the associated units. example: fields: timestamp: 'Timestamp as string: RFC 3339' timestampInit: 'Timestamp as string: RFC 3339' cldCvr: Percent value in [0,100] dewPt: Fahrenheit feelsLike: Fahrenheit heatIndex: Fahrenheit mslPres: Millibars precip: Inches precipProb: Percent value in [0,100] radSolar: Watts per Square Meter radDirectSolar: Watts per Square Meter radDirectPSolar: Watts per Square Meter relHum: Percent value in [0,100] pres: Millibars snowfall: Inches snowfallProb: Percent value in [0,100] spcHum: Grams of Moisture per Kilograms of Air temp: Fahrenheit wetBulb: Fahrenheit windChill: Fahrenheit windDir: Degrees [0,360] (0 = North) windSpd: Miles per Hour ecmwfForecastHourArr: type: array description: An array of hourly weather ECMWF Vert forecast objects. items: $ref: '#/components/schemas/ecmwfForecastHourObj' ecmwfForecastHourObj: required: - timestamp type: object properties: timestamp: $ref: '#/components/schemas/timestamp' timestampInit: $ref: '#/components/schemas/timestampInit' cldCvr: $ref: '#/components/schemas/cldCvr' dewPt: $ref: '#/components/schemas/dewPt' feelsLike: $ref: '#/components/schemas/feelsLike' heatIndex: $ref: '#/components/schemas/heatIndex' mslPres: $ref: '#/components/schemas/mslPres' precip: $ref: '#/components/schemas/precip' precipProb: $ref: '#/components/schemas/precipProb' radSolar: $ref: '#/components/schemas/radSolar' radSolarDirect: $ref: '#/components/schemas/radSolarDirect' radSolarDirectP: $ref: '#/components/schemas/radSolarDirectP' relHum: $ref: '#/components/schemas/relHum' pres: $ref: '#/components/schemas/pres' snowfall: $ref: '#/components/schemas/snowfall' snowfallProb: $ref: '#/components/schemas/snowfallProb' spcHum: $ref: '#/components/schemas/spcHum' temp: $ref: '#/components/schemas/temp' wetBulb: $ref: '#/components/schemas/wetBulb' windChill: $ref: '#/components/schemas/windChill' windDir: $ref: '#/components/schemas/windDir' windSpd: $ref: '#/components/schemas/windSpd' description: An hourly weather ECMWF Vert forecast object. ecmwfForecastPointHourObj: required: - fieldList - forecast - location - timestampRange type: object properties: location: $ref: '#/components/schemas/pointObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' forecast: $ref: '#/components/schemas/ecmwfForecastHourArr' description: Hourly Latitude/Longitude ECMWF Vert forecast object ecmwfForecastOnpointHourObj: required: - fieldList - forecast - location - timestampRange type: object properties: location: $ref: '#/components/schemas/onpointObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' forecast: $ref: '#/components/schemas/ecmwfForecastHourArr' description: Hourly OnPoint™ ECMWF Vert forecast object timestampInit: type: string description: The model initialization timestamp formatted as an RFC3339 date-time value. format: date-time example: 2019-12-20T23:00:00-05:00 cldCvr: maximum: 100 minimum: 0 type: number description: Cloud Cover as a percent value. format: float example: 100 dewPt: type: number description: Dew Point in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 45.92 feelsLike: type: number description: Feels Like Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 46.75 heatIndex: type: number description: Heat Index in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 46.75 mslPres: type: number description: Pressure in millibars. format: float example: 1017.46 precip: type: number description: Total precipitation in inches (imperial) or centimeters (metric, si). format: float example: 0 precipProb: maximum: 100 minimum: 0 type: number description: Probability of precipitation as a percent value. format: float example: 0 radSolar: type: number description: Solar Radiation in watts per square meter. format: float example: 0 radSolarDirect: type: number description: Direct Solar Radiation in watts per square meter. format: float example: 0 radSolarDirectP: type: number description: Direct Solar Radiation on a plane perpendicular to the direction of the Sun in watts per square meter. format: float example: 0 relHum: maximum: 100 minimum: 0 type: number description: Relative humidity as a percent value. format: float example: 96.87 pres: type: number description: Surface pressure in millibars. format: float example: 1013.83 snowfall: type: number description: Total snowfall in inches (imperial) or centimeters (metric, si). format: float example: 0 snowfallProb: maximum: 100 minimum: 0 type: number description: Probability of snowfall as a percent value. format: float example: 0 spcHum: type: number description: Specific humidity in grams per kilograms. format: float example: 6.49 temp: type: number description: Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 46.75 wetBulb: type: number description: Wet Bulb Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 46.32 windChill: type: number description: Wind Chill in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si). format: float example: 46.75 windDir: maximum: 360 minimum: 0 type: number description: Wind direction at 10 meters in Degrees (0 or 360 = North, 90 = East, South = 180, West = 270). format: float example: 302.6 windSpd: type: number description: Wind speed at 10 meters in miles per hour (imperial) or km/hour (metric, si). format: float example: 0.84 errorObj: type: object properties: errorCode: maximum: 600 minimum: 100 type: integer example: 404 errorMessage: type: string example: NOT FOUND. Item not found. fields: type: object additionalProperties: type: string description: Unit value for field identified in the related key. example: Fahrenheit timestamp: type: string description: A timestamp formatted as an RFC3339 date-time value. format: date-time example: 2019-12-20T23:00:00-05:00 pointObj: required: - boundingPoints - elevation - grid - latitude - longitude - timezone type: object properties: latitude: $ref: '#/components/schemas/latitude' longitude: $ref: '#/components/schemas/longitude' timezone: $ref: '#/components/schemas/timezone' countryCode: $ref: '#/components/schemas/countryCode' countryName: $ref: '#/components/schemas/countryName' subdivCode: $ref: '#/components/schemas/subdivCode' subdivName: $ref: '#/components/schemas/subdivName' boundingPoints: $ref: '#/components/schemas/boundingPoints' grid: $ref: '#/components/schemas/grid' elevation: $ref: '#/components/schemas/elevation' description: Metadata object for a postcode latitude: maximum: 90 minimum: -90 type: number description: A latitude value between -90° and 90°. format: float example: 38.8552 longitude: maximum: 180 minimum: -180 type: number description: A longitude value between -180° (West) and 180° (East). format: float example: -77.0513 timezone: type: string description: An Olson timezone ID. example: America/New_York countryCode: type: string description: An [ISO 3166-1 Alpha-2 country code](https://developer.weathersourceapis.com/apis/countries-with-postal-code-support/). example: US countryName: type: string description: A common country name. example: United States of America subdivCode: type: string description: An ISO 3166-2 country subdivision code. example: US-VA subdivName: type: string description: A common country subdivision name. example: Virginia boundingPoints: type: array description: A list of OnPoint™ points related to the location items: $ref: '#/components/schemas/boundingPoints_inner' onpointId: type: integer description: An OnPoint™ ID. example: 10725864 grid: type: string description: The OnPoint™ grid on which the resource exists. example: NORTH_AMERICA_GRID enum: - GLOBAL_GRID - NORTH_AMERICA_GRID distance: type: number description: A distance from the provided point in miles. format: float example: 2.6772 elevation: type: number description: The elevation above sea level of a location in meters format: float example: 173.5 timestampRangeObj: required: - timestampEnd - timestampStart type: object properties: timestampStart: $ref: '#/components/schemas/timestampStart' timestampEnd: $ref: '#/components/schemas/timestampEnd' description: A timestamp range object timestampStart: type: string description: A start timestamp for a timestamp range formatted as an RFC3339 date-time value. format: date-time example: 2019-12-20T23:00:00-05:00 timestampEnd: type: string description: An end timestamp for a timestamp range formatted as an RFC3339 date-time value. format: date-time example: 2019-12-20T23:00:00-05:00 onpointObj: required: - elevation - grid - latitude - longitude - onpointId - timezone type: object properties: onpointId: $ref: '#/components/schemas/onpointId' latitude: $ref: '#/components/schemas/latitude' longitude: $ref: '#/components/schemas/longitude' timezone: $ref: '#/components/schemas/timezone' countryCode: $ref: '#/components/schemas/countryCode' countryName: $ref: '#/components/schemas/countryName' subdivCode: $ref: '#/components/schemas/subdivCode' subdivName: $ref: '#/components/schemas/subdivName' grid: $ref: '#/components/schemas/grid' elevation: $ref: '#/components/schemas/elevation' description: An OnPoint™ point location metadata object boundingPoints_inner: required: - distance - elevation - grid - latitude - longitude - onpointId type: object properties: onpointId: $ref: '#/components/schemas/onpointId' latitude: $ref: '#/components/schemas/latitude' longitude: $ref: '#/components/schemas/longitude' grid: $ref: '#/components/schemas/grid' distance: $ref: '#/components/schemas/distance' elevation: $ref: '#/components/schemas/elevation' responses: errorResponse: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' parameters: height: name: height in: path description: The height in meters at which to vertically interpolate. The height MUST be in meters, even if selecting IMPERIAL unit type. required: true style: simple explode: false schema: type: number example: 20 fieldsHour: name: fields in: query description: | A comma separated list of field names to return. The timestamp field is always returned. **Limiting the query to needed fields will improve the query response time.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* * allCldCvr *(cldCvr)* * allHum *(relHum, spcHum)* * allPrecip *(precip, precipProb, snowfall, snowfallProb)* * allPres *(mslPres, pres)* * allRad *(radSolar, radSolarDirect, radSolarDirectP)* * allTemp *(dewPt, feelsLike, heatIndex, temp, wetBulb, windChill)* * allWind *(windDir, windSpd)* * popular *(cldCvr, feelsLike, precip, relHum, snowfall, temp, windDir, windSpd)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - cldCvr - dewPt - feelsLike - heatIndex - mslPres - precip - precipProb - radSolar - radSolarDirect - radSolarDirectP - relHum - sfcPres - snowfall - snowfallProb - spcHum - temp - wetBulb - windChill - windDir - windSpd - all - allCldCvr - allHum - allPrecip - allPres - allRad - allTemp - allWind - popular securitySchemes: ApiKeyAuth: type: apiKey description: | API key to authorize requests. If you do not have a Weather Source API key [sign up for a free 30-day developer account](https://developer.weathersourceapis.com/account/sign-up/). You may use the evaluation API Key `C0W60UOFRML47ytbXk4xlLBfv` to access example locations found in this documentation. name: X-API-KEY in: header