openapi: 3.0.3
info:
  title: App Weather - A Weather Source API
  description: "**This API is in BETA release.**\n\nApp/Webpage optimized weather data for latitude/longitude points, ZIP/Postal Codes, and OnPoint™ grid points. The Weather Source App Weather 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 use. Weather Source offers the highest resolution grid on the market, covering every landmass in the world and up to 200 miles offshore.\n\nThis API returns current conditions (Nowcast) and a 10-day forecast (hourly and daily data). The nowcast and forecast include limited astronomical data. All plain-language response data may be translated to English, Spanish, or French.\n\nThe weather icon identifiers returned by this API correspond to classes used by the open-source licensed [Weather Icons](https://developer.weathersourceapis.com/apis/appwx-weather-icons/) font set.\n  \n  **IMPORTANT:** To authenticate to the Weather Source App Weather 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.1
servers:
- url: https://appwx.weathersourceapis.com/v2
security:
- ApiKeyAuth: []
tags:
- name: points
  description: Latitude/Longitude App Weather
- name: postcodes
  description: Postcode App Weather
- name: onpoints
  description: OnPoint™ point App Weather
paths:
  /points/{latitude},{longitude}:
    get:
      tags:
      - points
      summary: App Weather for a Latitude/Longitude point.
      description: |
        Returns current conditions (Nowcast) and a 10-day forecast (hourly and daily data) for a Latitude/Longitude point. The nowcast and forecasts include limited astronomical data. All plain-language response data may be translated to English, Spanish or French.

        The weather icon identifiers returned by this API correspond to classes used by the open-source licensed [Weather Icons](https://developer.weathersourceapis.com/apis/appwx-weather-icons/) font.

        **IMPORTANT:** To authenticate to the Weather Source App Weather 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.**
        required: true
        style: form
        explode: false
        schema:
          type: array
          example: all
          items:
            type: string
            enum:
            - all
            - allAstronomy
            - allCldCvr
            - allFeelsLike
            - allIcon
            - allPrecip
            - allRelHum
            - allSummary
            - allTemp
            - allWind
      - name: unitScale
        in: query
        description: The unit scale for returned values.<br>
        required: false
        schema:
          type: string
          example: IMPERIAL
          default: IMPERIAL
          enum:
          - IMPERIAL
          - METRIC
          - SI
      - name: language
        in: query
        description: The language for translatable returned values.<br>
        required: false
        schema:
          type: string
          example: ENGLISH
          default: ENGLISH
          enum:
          - ENGLISH
          - FRENCH
          - SPANISH
      responses:
        "200":
          description: App Weather response for a Latitude/Longitude point.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appwxPointObj"
        default:
          $ref: "#/components/responses/errorResponse"
  /postcodes/{postcode},{countryCode}:
    get:
      tags:
      - postcodes
      summary: App Weather response for a postcode.
      description: |
        Returns current conditions (Nowcast) and a 10-day forecast (hourly and daily data) for a postcode. The nowcast and forecasts include limited astronomical data. All plain-language response data may be translated to English, Spanish or French.

        The weather icon identifiers returned by this API correspond to classes used by the open-source licensed [Weather Icons](https://developer.weathersourceapis.com/apis/appwx-weather-icons/) font set.

        **IMPORTANT:** To authenticate to the Weather Source App Weather 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: postcode
        in: path
        description: A postcode string.
        required: true
        schema:
          type: string
          example: "22222"
      - name: countryCode
        in: path
        description: "An uppercase 2-character [ISO 3166-1 Alpha-2 country code](https://developer.weathersourceapis.com/apis/countries-with-postal-code-support/)."
        required: true
        schema:
          pattern: "^([A-Z]){2}$"
          type: string
          example: US
      - 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.**
        required: true
        style: form
        explode: false
        schema:
          type: array
          example: all
          items:
            type: string
            enum:
            - all
            - allAstronomy
            - allCldCvr
            - allFeelsLike
            - allIcon
            - allPrecip
            - allRelHum
            - allSummary
            - allTemp
            - allWind
      - name: unitScale
        in: query
        description: The unit scale for returned values.<br>
        required: false
        schema:
          type: string
          example: IMPERIAL
          default: IMPERIAL
          enum:
          - IMPERIAL
          - METRIC
          - SI
      - name: language
        in: query
        description: The language for translatable returned values.<br>
        required: false
        schema:
          type: string
          example: ENGLISH
          default: ENGLISH
          enum:
          - ENGLISH
          - FRENCH
          - SPANISH
      responses:
        "200":
          description: App Weather response for a postcode.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appwxPostcodeObj"
        default:
          $ref: "#/components/responses/errorResponse"
  /onpoints/{onpointId}:
    get:
      tags:
      - onpoints
      summary: App Weather for an OnPoint™ point.
      description: |
        Returns current conditions (Nowcast) and a 10-day forecast (hourly and daily data) for an OnPoint™ point. The nowcast and forecasts include limited astronomical data. All plain-language response data may be translated to English, Spanish or French.

        The weather icon identifiers returned by this API correspond to classes used by the open-source licensed [Weather Icons](https://developer.weathersourceapis.com/apis/appwx-weather-icons/) font set.

        **IMPORTANT:** To authenticate to the Weather Source App Weather 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.**
        required: true
        style: form
        explode: false
        schema:
          type: array
          example: all
          items:
            type: string
            enum:
            - all
            - allAstronomy
            - allCldCvr
            - allFeelsLike
            - allIcon
            - allPrecip
            - allRelHum
            - allSummary
            - allTemp
            - allWind
      - name: unitScale
        in: query
        description: The unit scale for returned values.<br>
        required: false
        schema:
          type: string
          example: IMPERIAL
          default: IMPERIAL
          enum:
          - IMPERIAL
          - METRIC
          - SI
      - name: language
        in: query
        description: The language for translatable returned values.<br>
        required: false
        schema:
          type: string
          example: ENGLISH
          default: ENGLISH
          enum:
          - ENGLISH
          - FRENCH
          - SPANISH
      responses:
        "200":
          description: App Weather response for an OnPoint™ point.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appwxOnpointObj"
        default:
          $ref: "#/components/responses/errorResponse"
components:
  schemas:
    featuresObj:
      title: featuresObj
      required:
      - fields
      - language
      - unitScale
      type: object
      properties:
        fields:
          $ref: "#/components/schemas/fieldListObj"
        unitScale:
          $ref: "#/components/schemas/unitScale"
        language:
          $ref: "#/components/schemas/language"
      description: Metadata for the returned data.
      example:
        fields:
          forecastDay:
            date: "Date as string: \"YYYY-MM-DD\""
            cldCvrMax: "Percent value in [0,100]"
            cldCvrMin: "Percent value in [0,100]"
            feelsLikeMax: Fahrenheit
            feelsLikeMin: Fahrenheit
            icon: Weather icon identifier as a string
            moonPhase: Phase of moon in English as a string
            precip: Inches
            precipProb: "Percent value in [0,100]"
            relHumMax: "Percent value in [0,100]"
            relHumMin: "Percent value in [0,100]"
            snowfall: Inches
            snowfallProb: "Percent value in [0,100]"
            summary: Summary of weather conditions in English as a string
            summaryLong: Extended summary of weather conditions in English as a string
            sunrise: "Timestamp as string: RFC 3339"
            sunset: "Timestamp as string: RFC 3339"
            tempMax: Fahrenheit
            tempMin: Fahrenheit
            windDirAvg: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
            windSpdMax: Miles per Hour
            windSpdMin: Miles per Hour
          forecastHour:
            timestamp: "Timestamp as string: RFC 3339"
            cldCvr: "Percent value in [0,100]"
            feelsLike: Fahrenheit
            icon: Weather icon identifier as a string
            precip: Inches
            precipProb: "Percent value in [0,100]"
            relHum: "Percent value in [0,100]"
            snowfall: Inches
            snowfallProb: "Percent value in [0,100]"
            summary: Summary of weather conditions in English as a string
            temp: Fahrenheit
            windDir: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
            windSpd: Miles per Hour
          nowcast:
            timestamp: "Timestamp as string: RFC 3339"
            civilRise: "Timestamp as string: RFC 3339"
            civilSet: "Timestamp as string: RFC 3339"
            cldCvr: "Percent value in [0,100]"
            feelsLike: Fahrenheit
            icon: Weather icon identifier as a string
            moonPhase: Phase of moon in English as a string
            precipFlag: Boolean value
            precipIntensity: Inches
            relHum: "Percent value in [0,100]"
            snowfallFlag: Boolean value
            snowfallIntensity: Inches
            summary: Summary of weather conditions in English as a string
            summaryLong: Extended summary of weather conditions in English as a string
            sunTransit: "Timestamp as string: RFC 3339"
            sunrise: "Timestamp as string: RFC 3339"
            sunset: "Timestamp as string: RFC 3339"
            temp: Fahrenheit
            tempMax: Fahrenheit
            tempMin: Fahrenheit
            windDir: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
            windSpd: Miles per Hour
        unitScale: IMPERIAL
        language: ENGLISH
    fieldListObj:
      title: fieldListObj
      required:
      - forecastDay
      - forecastHour
      - nowcast
      type: object
      properties:
        forecastDay:
          $ref: "#/components/schemas/fields"
        forecastHour:
          $ref: "#/components/schemas/fields"
        nowcast:
          $ref: "#/components/schemas/fields"
      description: A list of returned field names the associated units grouped by service.
      example:
        forecastDay:
          date: "Date as string: \"YYYY-MM-DD\""
          cldCvrMax: "Percent value in [0,100]"
          cldCvrMin: "Percent value in [0,100]"
          feelsLikeMax: Fahrenheit
          feelsLikeMin: Fahrenheit
          icon: Weather icon identifier as string
          moonPhase: Phase of moon as string
          precip: Inches
          precipProb: "Percent value in [0,100]"
          relHumMax: "Percent value in [0,100]"
          relHumMin: "Percent value in [0,100]"
          snowfall: Inches
          snowfallProb: "Percent value in [0,100]"
          summary: Summary of weather conditions in English as string
          summaryLong: Extended summary of weather conditions in English as string
          sunrise: "Timestamp as string: RFC 3339"
          sunset: "Timestamp as string: RFC 3339"
          tempMax: Fahrenheit
          tempMin: Fahrenheit
          windDirAvg: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
          windSpdMax: Miles per Hour
          windSpdMin: Miles per Hour
        forecastHour:
          timestamp: "Timestamp as string: RFC 3339"
          cldCvr: "Percent value in [0,100]"
          feelsLike: Fahrenheit
          icon: Weather icon identifier as string
          precip: Inches
          precipProb: "Percent value in [0,100]"
          relHum: "Percent value in [0,100]"
          snowfall: Inches
          snowfallProb: "Percent value in [0,100]"
          summary: Summary of weather conditions in English as string
          temp: Fahrenheit
          windDir: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
          windSpd: Miles per Hour
        nowcast:
          timestamp: "Timestamp as string: RFC 3339"
          civilRise: "Timestamp as string: RFC 3339"
          civilSet: "Timestamp as string: RFC 3339"
          cldCvr: "Percent value in [0,100]"
          feelsLike: Fahrenheit
          icon: Weather icon identifier as string
          moonPhase: ""
          precipFlag: Boolean value
          precipIntensity: Inches
          relHum: "Percent value in [0,100]"
          snowfallFlag: Boolean value
          snowfallIntensity: Inches
          summary: Summary of weather conditions in English as string
          summaryLong: Extended summary of weather conditions in English as string
          sunTransit: "Timestamp as string: RFC 3339"
          sunrise: "Timestamp as string: RFC 3339"
          sunset: "Timestamp as string: RFC 3339"
          temp: Fahrenheit
          tempMax: Fahrenheit
          tempMin: Fahrenheit
          windDir: "String 16-point wind direction in English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW)"
          windSpd: Miles per Hour
    nowcastObj:
      required:
      - timestamp
      type: object
      properties:
        timestamp:
          $ref: "#/components/schemas/timestamp"
        civilRise:
          $ref: "#/components/schemas/civilRise"
        civilSet:
          $ref: "#/components/schemas/civilSet"
        cldCvr:
          $ref: "#/components/schemas/cldCvr"
        feelsLike:
          $ref: "#/components/schemas/feelsLike"
        icon:
          $ref: "#/components/schemas/icon"
        moonPhase:
          $ref: "#/components/schemas/moonPhase"
        precipFlag:
          $ref: "#/components/schemas/precipFlag"
        precipIntensity:
          $ref: "#/components/schemas/precipIntensity"
        relHum:
          $ref: "#/components/schemas/relHum"
        snowfallFlag:
          $ref: "#/components/schemas/snowfallFlag"
        snowfallIntensity:
          $ref: "#/components/schemas/snowfallIntensity"
        summary:
          $ref: "#/components/schemas/summary"
        summaryLong:
          $ref: "#/components/schemas/summaryLong"
        sunTransit:
          $ref: "#/components/schemas/sunTransit"
        sunrise:
          $ref: "#/components/schemas/sunrise"
        sunset:
          $ref: "#/components/schemas/sunset"
        temp:
          $ref: "#/components/schemas/temp"
        tempMax:
          $ref: "#/components/schemas/tempMax"
        tempMin:
          $ref: "#/components/schemas/tempMin"
        windDir:
          $ref: "#/components/schemas/windDir"
        windSpd:
          $ref: "#/components/schemas/windSpd"
      description: A nowcast object.
    forecastDayArr:
      type: array
      description: An array of daily weather forecast objects.
      items:
        $ref: "#/components/schemas/forecastDayObj"
    forecastDayObj:
      required:
      - date
      type: object
      properties:
        date:
          $ref: "#/components/schemas/date"
        cldCvrMax:
          $ref: "#/components/schemas/cldCvrMax"
        cldCvrMin:
          $ref: "#/components/schemas/cldCvrMin"
        feelsLikeMax:
          $ref: "#/components/schemas/feelsLikeMax"
        feelsLikeMin:
          $ref: "#/components/schemas/feelsLikeMin"
        icon:
          $ref: "#/components/schemas/icon"
        moonPhase:
          $ref: "#/components/schemas/moonPhase"
        precip:
          $ref: "#/components/schemas/precip"
        precipProb:
          $ref: "#/components/schemas/precipProb"
        relHumMax:
          $ref: "#/components/schemas/relHumMax"
        relHumMin:
          $ref: "#/components/schemas/relHumMin"
        snowfall:
          $ref: "#/components/schemas/snowfall"
        snowfallProb:
          $ref: "#/components/schemas/snowfallProb"
        summary:
          $ref: "#/components/schemas/summary"
        summaryLong:
          $ref: "#/components/schemas/summaryLong"
        sunrise:
          $ref: "#/components/schemas/sunrise"
        sunset:
          $ref: "#/components/schemas/sunset"
        tempMax:
          $ref: "#/components/schemas/tempMax"
        tempMin:
          $ref: "#/components/schemas/tempMin"
        windDirAvg:
          $ref: "#/components/schemas/windDirAvg"
        windSpdMin:
          $ref: "#/components/schemas/windSpdMin"
        windSpdMax:
          $ref: "#/components/schemas/windSpdMax"
      description: A daily weather forecast object.
    forecastHourArr:
      type: array
      description: An array of hourly weather forecast objects.
      items:
        $ref: "#/components/schemas/forecastHourObj"
    forecastHourObj:
      required:
      - timestamp
      type: object
      properties:
        timestamp:
          $ref: "#/components/schemas/timestamp"
        cldCvr:
          $ref: "#/components/schemas/cldCvr"
        feelsLike:
          $ref: "#/components/schemas/feelsLike"
        icon:
          $ref: "#/components/schemas/icon"
        precip:
          $ref: "#/components/schemas/precip"
        precipProb:
          $ref: "#/components/schemas/precipProb"
        relHum:
          $ref: "#/components/schemas/relHum"
        snowfall:
          $ref: "#/components/schemas/snowfall"
        snowfallProb:
          $ref: "#/components/schemas/snowfallProb"
        summary:
          $ref: "#/components/schemas/summary"
        temp:
          $ref: "#/components/schemas/temp"
        windDir:
          $ref: "#/components/schemas/windDir"
        windSpd:
          $ref: "#/components/schemas/windSpd"
      description: An hourly weather forecast object.
    appwxPointObj:
      required:
      - features
      - forecastDay
      - forecastHour
      - location
      - nowcast
      type: object
      properties:
        location:
          $ref: "#/components/schemas/pointObj"
        features:
          $ref: "#/components/schemas/featuresObj"
        nowcast:
          $ref: "#/components/schemas/nowcastObj"
        forecastDay:
          $ref: "#/components/schemas/forecastDayArr"
        forecastHour:
          $ref: "#/components/schemas/forecastHourArr"
      description: Latitude/Longitude App Weather object
    appwxPostcodeObj:
      required:
      - features
      - forecastDay
      - forecastHour
      - location
      - nowcast
      type: object
      properties:
        location:
          $ref: "#/components/schemas/postcodeObj"
        features:
          $ref: "#/components/schemas/featuresObj"
        nowcast:
          $ref: "#/components/schemas/nowcastObj"
        forecastDay:
          $ref: "#/components/schemas/forecastDayArr"
        forecastHour:
          $ref: "#/components/schemas/forecastHourArr"
      description: Postcode App Weather object
    appwxOnpointObj:
      required:
      - features
      - forecastDay
      - forecastHour
      - location
      - nowcast
      type: object
      properties:
        location:
          $ref: "#/components/schemas/onpointObj"
        features:
          $ref: "#/components/schemas/featuresObj"
        nowcast:
          $ref: "#/components/schemas/nowcastObj"
        forecastDay:
          $ref: "#/components/schemas/forecastDayArr"
        forecastHour:
          $ref: "#/components/schemas/forecastHourArr"
      description: OnPoint™ point App Weather object
    civilRise:
      type: string
      description: Time of the beginning of civil twilight before sunrise formatted RFC 3339.
      format: date-time
      example: 2019-12-20T06:52:29-05:00
    civilSet:
      type: string
      description: Time of the end of civil twilight after sunset formatted RFC 3339.
      format: date-time
      example: 2019-12-20T17:18:53-05:00
    cldCvr:
      maximum: 100
      minimum: 0
      type: number
      description: Cloud Cover as a percent value.
      format: float
      example: 100
    cldCvrMin:
      maximum: 100
      minimum: 0
      type: number
      description: Minimum Cloud Cover as a percent value.
      format: float
      example: 22
    cldCvrMax:
      maximum: 100
      minimum: 0
      type: number
      description: Maximum Cloud Cover as a percent value.
      format: float
      example: 100
    feelsLike:
      type: number
      description: "Feels Like Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 46.75
    feelsLikeMin:
      type: number
      description: "Minimum Feels Like Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 42.3
    feelsLikeMax:
      type: number
      description: "Maximum Feels Like Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 55.2
    icon:
      type: string
      description: "Icon class for specific weather conditions. The icon class corresponds to classes used by the open source licensed [Weather Icons](https://erikflowers.github.io/weather-icons/) font set."
      example: wi-day-sunny
    moonPhase:
      type: string
      description: "The Moon Phase as a string translated to English, Spanish, or French."
      example: Waning Crescent
    precip:
      type: number
      description: "Total precipitation in inches (imperial) or centimeters (metric, si)."
      format: float
      example: 0
    precipFlag:
      type: boolean
      description: A boolean value that indicates if there is precipitation in the vicinity of the queried location.
      example: false
    precipIntensity:
      type: number
      description: "Amount of precipitation expected within one hour at the current intensity in inches (imperial) or centimeters (metric, si)."
      format: float
      example: 0.01
    precipProb:
      maximum: 100
      minimum: 0
      type: number
      description: Probability of precipitation as a percent value.
      format: float
      example: 0
    relHum:
      maximum: 100
      minimum: 0
      type: number
      description: Relative humidity as a percent value.
      format: float
      example: 96.87
    relHumMin:
      maximum: 100
      minimum: 0
      type: number
      description: Minimum Relative humidity as a percent value.
      format: float
      example: 62.1
    relHumMax:
      maximum: 100
      minimum: 0
      type: number
      description: Maximum Relative humidity as a percent value.
      format: float
      example: 98
    snowfall:
      type: number
      description: "Total snowfall in inches (imperial) or centimeters (metric, si)."
      format: float
      example: 0
    snowfallFlag:
      type: boolean
      description: A boolean value that indicates if there is snowfall in the vicinity of the queried location.
      example: false
    snowfallIntensity:
      type: number
      description: "Amount of snowfall expected within one hour at the current intensity 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
    summary:
      type: string
      description: "Summary of weather conditions translated to English, Spanish or French as string."
      example: Light rain with wind
    summaryLong:
      type: string
      description: "Extended summary of weather conditions translated to English, Spanish or French as string."
      example: Mostly cloudy with Light rain and strong winds from the north-northeast.
    sunTransit:
      type: string
      description: Time of Sun's transit (solar noon) formatted RFC 3339.
      format: date-time
      example: 2019-12-20T12:05:41-05:00
    sunrise:
      type: string
      description: Time of sunrise formatted RFC 3339.
      format: date-time
      example: 2019-12-20T07:22:27-05:00
    sunset:
      type: string
      description: Time of sunset formatted RFC 3339.
      format: date-time
      example: 2019-12-20T16:48:55-05:00
    temp:
      type: number
      description: "Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 46.75
    tempMin:
      type: number
      description: "Minimum Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 43.5
    tempMax:
      type: number
      description: "Maximum Temperature in Degrees Fahrenheit (imperial), Celsius (metric), or Kelvin (si)."
      format: float
      example: 55.3
    windDir:
      type: string
      description: "16-point average wind direction at 10 meters, translated to English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW), Spanish and French (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSO,SO,WSO,O,WNO,NO,NNO)."
      example: NNE
    windDirAvg:
      type: string
      description: "16-point average wind direction at 10 meters, translated to English (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSW,SW,WSW,W,WNW,NW,NNW), Spanish and French (N,NNE,NE,ENE,E,ESE,SE,SSE,S,SSO,SO,WSO,O,WNO,NO,NNO)."
      example: NNE
    windSpd:
      type: number
      description: "Wind speed at 10 meters in miles per hour (imperial) or km/hour (metric, si)."
      format: float
      example: 0.84
    windSpdMin:
      type: number
      description: "Minimum Wind speed at 10 meters in miles per hour (imperial) or km/hour (metric, si)."
      format: float
      example: 0.3
    windSpdMax:
      type: number
      description: "Maximum Wind speed at 10 meters in miles per hour (imperial) or km/hour (metric, si)."
      format: float
      example: 5.1
    errorObj:
      type: object
      properties:
        errorCode:
          maximum: 600
          minimum: 100
          type: integer
          example: 404
        errorMessage:
          type: string
          example: NOT FOUND. Item not found.
    unitScale:
      type: string
      description: The unit scale for returned values.
      example: IMPERIAL
      enum:
      - IMPERIAL
      - METRIC
      - SI
    language:
      type: string
      description: Language for translatable returned values.
      example: ENGLISH
      enum:
      - ENGLISH
      - FRENCH
      - SPANISH
    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
    date:
      type: string
      description: A date formatted as an RFC3339 date value.
      format: date
      example: 2019-12-20
    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
    postcodeObj:
      required:
      - boundingPoints
      - countryCode
      - countryName
      - elevation
      - grid
      - latitude
      - longitude
      - postcode
      - timezone
      type: object
      properties:
        postcode:
          $ref: "#/components/schemas/postcode"
        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: A postcode location metadata object
    postcode:
      type: string
      description: A postcode string.
      example: "22222"
    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:
    fields:
      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.**
      required: true
      style: form
      explode: false
      schema:
        type: array
        example: all
        items:
          type: string
          enum:
          - all
          - allAstronomy
          - allCldCvr
          - allFeelsLike
          - allIcon
          - allPrecip
          - allRelHum
          - allSummary
          - allTemp
          - allWind
    latitude:
      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
    longitude:
      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
    unitScale:
      name: unitScale
      in: query
      description: The unit scale for returned values.<br>
      required: false
      schema:
        type: string
        example: IMPERIAL
        default: IMPERIAL
        enum:
        - IMPERIAL
        - METRIC
        - SI
    language:
      name: language
      in: query
      description: The language for translatable returned values.<br>
      required: false
      schema:
        type: string
        example: ENGLISH
        default: ENGLISH
        enum:
        - ENGLISH
        - FRENCH
        - SPANISH
    postcode:
      name: postcode
      in: path
      description: A postcode string.
      required: true
      schema:
        type: string
        example: "22222"
    countryCode:
      name: countryCode
      in: path
      description: "An uppercase 2-character [ISO 3166-1 Alpha-2 country code](https://developer.weathersourceapis.com/apis/countries-with-postal-code-support/)."
      required: true
      schema:
        pattern: "^([A-Z]){2}$"
        type: string
        example: US
    onpointId:
      name: onpointId
      in: path
      description: An OnPoint™ ID.
      required: true
      schema:
        type: integer
        example: 10725864
  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