--- openapi: 3.0.3 info: title: UV - A Weather Source API description: |- Daily and hourly UV data for latitude/longitude points, ZIP/Postal Codes, and Designated Market Areas. UV forecast is up to 5 days out from the current day. Historical UV data is also available. The Weather Source UV 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. **IMPORTANT:** To authenticate to the Weather Source UV 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. 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://uv.weathersourceapis.com/v2 description: UV server security: - ApiKeyAuth: [] tags: - name: points description: Latitude/Longitude UV data - name: postcodes description: Postcode UV data - name: dmas description: Designated Market Area UV data - name: onpoints description: OnPoint™ point UV data paths: /points/{latitude},{longitude}/days: get: tags: - points summary: The complete daily UV forecast for a Latitude/Longitude point. description: | Returns the complete set of daily UV forecast data for a Latitude/Longitude point. *Alternatively using a query that specificies just the days required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source UV 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 date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV forecast response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/days/{date}: get: tags: - points summary: A day of UV data for a Latitude/Longitude point. description: | Returns a single day of UV data for a Latitude/Longitude point. The provided date must exist within the current valid 5-day forecast range, or it must be a historical date. **IMPORTANT:** To authenticate to the Weather Source UV 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: date in: path description: An date formatted as a RFC3339 date value. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/days/{dateStart},{dateEnd}: get: tags: - points summary: A contiguous range of daily UV data for a Latitude/Longitude point. description: | Returns a contiguous range of daily UV data for a Latitude/Longitude point. The temporal range provided must not exceed 1 year in duration **IMPORTANT:** To authenticate to the Weather Source Uv 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: dateStart in: path description: An date formatted as a RFC3339 date value that must occur temporally before dateEnd. required: true schema: type: string format: date example: 2019-12-20 - name: dateEnd in: path description: An date formatted as a RFC3339 date value that must occur temporally after dateStart. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/hours: get: tags: - points summary: The complete hourly UV forecast for a Latitude/Longitude point. description: | Returns the complete set of UV 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 UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/hours/{timestamp}: get: tags: - points summary: An hour of UV data for a Latitude/Longitude point. description: | Returns a single hour of UV data for a Latitude/Longitude point. The provided timestamp must exist within the current valid 5-day forecast range, or it must be a historical timestamp. **IMPORTANT:** To authenticate to the Weather Source UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /points/{latitude},{longitude}/hours/{timestampStart},{timestampEnd}: get: tags: - points summary: A contiguous range of hourly UV data for a Latitude/Longitude point. description: | Returns a contiguous range of hourly ECMWF forecast data for a Latitude/Longitude point. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Latitude/Longitude point. content: application/json: schema: $ref: '#/components/schemas/uvPointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/days: get: tags: - postcodes summary: The complete daily UV forecast for a postcode. description: | Returns the complete set of UV forecast data for a postcode. *Alternatively using a query that specificies just the days required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source UV 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 date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/days/{date}: get: tags: - postcodes summary: A day of UV data for a postcode. description: | Returns a single day of UV data for a postcode. The provided date must exist within the current valid 5-day forecast range, or it must be a historical date. **IMPORTANT:** To authenticate to the Weather Source UV 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: date in: path description: An date formatted as a RFC3339 date value. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/days/{dateStart},{dateEnd}: get: tags: - postcodes summary: A contiguous range of daily UV data for a postcode. description: | Returns a contiguous range of daily ECMWF forecast data for a postcode. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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: dateStart in: path description: An date formatted as a RFC3339 date value that must occur temporally before dateEnd. required: true schema: type: string format: date example: 2019-12-20 - name: dateEnd in: path description: An date formatted as a RFC3339 date value that must occur temporally after dateStart. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/hours: get: tags: - postcodes summary: The complete hourly UV forecast for a postcode. description: | Returns the complete set of UV forecast data for a postcode. *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 UV 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.** In addition to individual field names, following convenience field groups are also supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/hours/{timestamp}: get: tags: - postcodes summary: An hour of UV data for a postcode. description: | Returns a single hour of ECMWF forecast data for a postcode. The provided timestamp must exist within the current valid 5-day forecast range, or it must be a historical timestamp. **IMPORTANT:** To authenticate to the Weather Source UV 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: 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /postcodes/{postcode},{countryCode}/hours/{timestampStart},{timestampEnd}: get: tags: - postcodes summary: A contiguous range of hourly UV data for a postcode. description: | Returns a contiguous range of hourly UV data for a postcode. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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: 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a postcode. content: application/json: schema: $ref: '#/components/schemas/uvPostcodeHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/days: get: tags: - dmas summary: The complete daily UV forecast for a DMA. description: | Returns the complete set of UV forecast data for a Designated Market Area. *Alternatively using a query that specificies just the days required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/days/{date}: get: tags: - dmas summary: A day of UV data for a DMA. description: | Returns a single day of UV data for a Designated Market Area. The provided date must exist within the current valid 5-day forecast range, or it must be a historical date. **IMPORTANT:** To authenticate to the Weather Source UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - name: date in: path description: An date formatted as a RFC3339 date value. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/days/{dateStart},{dateEnd}: get: tags: - dmas summary: A contiguous range of daily UV data for a DMA. description: | Returns a contiguous range of daily UV data for a Designated Market Area. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - name: dateStart in: path description: An date formatted as a RFC3339 date value that must occur temporally before dateEnd. required: true schema: type: string format: date example: 2019-12-20 - name: dateEnd in: path description: An date formatted as a RFC3339 date value that must occur temporally after dateStart. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/hours: get: tags: - dmas summary: The complete hourly UV forecast for a DMA description: | Returns the complete set of UV forecast data for a Designated Market Area. *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 UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/hours/{timestamp}: get: tags: - dmas summary: An hour of UV data for a DMA description: | Returns a single hour of UV data for a Designated Market Area. The provided timestamp must exist within the current valid 5-day forecast range, or it must be a historical timestamp. **IMPORTANT:** To authenticate to the Weather Source UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /dmas/{dmaId}/hours/{timestampStart},{timestampEnd}: get: tags: - dmas summary: A contiguous range of hourly UV data for a DMA. description: | Returns a contiguous range of hourly UV data for a Designated Market Area. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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: dmaId in: path description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). required: true schema: type: integer example: 529 - 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for a Designated Market Area. content: application/json: schema: $ref: '#/components/schemas/uvDmaHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/days: get: tags: - onpoints summary: The complete daily UV forecast for an OnPoint™ point. description: | Returns the complete set of UV forecast data for an OnPoint™ point. *Alternatively using a query that specificies just the days required for your purposes will improve the query response time.* **IMPORTANT:** To authenticate to the Weather Source UV 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 date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/days/{date}: get: tags: - onpoints summary: A day of UV data for an OnPoint™ point. description: | Returns a single day of UV data for an OnPoint™ point. The provided date must exist within the current valid 5-day forecast range, or it must be a historical date. **IMPORTANT:** To authenticate to the Weather Source UV 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: date in: path description: An date formatted as a RFC3339 date value. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/days/{dateStart},{dateEnd}: get: tags: - onpoints summary: A contiguous range of daily UV data for an OnPoint™ point. description: | Returns a contiguous range of daily UV data for an OnPoint™ point. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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: dateStart in: path description: An date formatted as a RFC3339 date value that must occur temporally before dateEnd. required: true schema: type: string format: date example: 2019-12-20 - name: dateEnd in: path description: An date formatted as a RFC3339 date value that must occur temporally after dateStart. required: true schema: type: string format: date example: 2019-12-20 - name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all - 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: Daily UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointDayObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/hours: get: tags: - onpoints summary: The complete hourly UV forecast for an OnPoint™ point. description: | Returns the complete set of UV forecast data for an OnPoint™ 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 UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/hours/{timestamp}: get: tags: - onpoints summary: An hour of UV data for an OnPoint™ point. description: | Returns a single hour of UV data for an OnPoint™ point. The provided timestamp must exist within the current valid 5-day forecast range, or it must be a historical timestamp. **IMPORTANT:** To authenticate to the Weather Source UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' /onpoints/{onpointId}/hours/{timestampStart},{timestampEnd}: get: tags: - onpoints summary: A contiguous range of hourly UV data for an OnPoint™ point. description: | Returns a contiguous range of hourly UV data for an OnPoint™ point. The temporal range provided must not exceed 1 year in duration. **IMPORTANT:** To authenticate to the Weather Source UV 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all - 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 UV response for an OnPoint™ point. content: application/json: schema: $ref: '#/components/schemas/uvOnpointHourObj' default: description: Unexpected error response content: application/json: schema: $ref: '#/components/schemas/errorObj' components: schemas: fieldListDayObj: title: fieldListObj required: - fields type: object properties: fields: $ref: '#/components/schemas/fields' description: A list of returned field names the associated units. example: fields: date: 'Date as string: "YYYY-MM-DD"' timestampInit: 'Timestamp as string: RFC 3339' uvIndexMax: UV Index (unitless) 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' uvIndex: UV Index (unitless) uvDayArr: type: array description: An array of daily weather UV objects. items: $ref: '#/components/schemas/uvDayObj' uvDayObj: required: - date type: object properties: date: $ref: '#/components/schemas/date' timestampInit: $ref: '#/components/schemas/timestampInit' uvIndexMax: $ref: '#/components/schemas/uvIndexMax' description: A daily weather UV object. uvHourArr: type: array description: An array of hourly weather UV objects. items: $ref: '#/components/schemas/uvHourObj' uvHourObj: required: - timestamp type: object properties: timestamp: $ref: '#/components/schemas/timestamp' timestampInit: $ref: '#/components/schemas/timestampInit' uvIndex: $ref: '#/components/schemas/uvIndex' description: An hourly weather UV object. uvPointDayObj: required: - dateRange - fieldList - location - uv type: object properties: location: $ref: '#/components/schemas/pointObj' dateRange: $ref: '#/components/schemas/dateRangeObj' fieldList: $ref: '#/components/schemas/fieldListDayObj' uv: $ref: '#/components/schemas/uvDayArr' description: Daily Latitude/Longitude UV object uvPointHourObj: required: - fieldList - location - timestampRange - uv type: object properties: location: $ref: '#/components/schemas/pointObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' uv: $ref: '#/components/schemas/uvHourArr' description: Hourly Latitude/Longitude UV object uvPostcodeDayObj: required: - dateRange - fieldList - location - uv type: object properties: location: $ref: '#/components/schemas/postcodeObj' dateRange: $ref: '#/components/schemas/dateRangeObj' fieldList: $ref: '#/components/schemas/fieldListDayObj' uv: $ref: '#/components/schemas/uvDayArr' description: Daily Postcode UV object uvPostcodeHourObj: required: - fieldList - location - timestampRange - uv type: object properties: location: $ref: '#/components/schemas/postcodeObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' uv: $ref: '#/components/schemas/uvHourArr' description: Hourly Postcode UV object uvDmaDayObj: required: - dateRange - fieldList - location - uv type: object properties: location: $ref: '#/components/schemas/dmaObj' dateRange: $ref: '#/components/schemas/dateRangeObj' fieldList: $ref: '#/components/schemas/fieldListDayObj' uv: $ref: '#/components/schemas/uvDayArr' description: Daily Designated Market Area UV object uvDmaHourObj: required: - fieldList - location - timestampRange - uv type: object properties: location: $ref: '#/components/schemas/dmaObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' uv: $ref: '#/components/schemas/uvHourArr' description: Hourly Designated Market Area UV object uvOnpointDayObj: required: - dateRange - fieldList - location - uv type: object properties: location: $ref: '#/components/schemas/onpointObj' dateRange: $ref: '#/components/schemas/dateRangeObj' fieldList: $ref: '#/components/schemas/fieldListDayObj' uv: $ref: '#/components/schemas/uvDayArr' description: Daily OnPoint™ UV object uvOnpointHourObj: required: - fieldList - location - timestampRange - uv type: object properties: location: $ref: '#/components/schemas/onpointObj' timestampRange: $ref: '#/components/schemas/timestampRangeObj' fieldList: $ref: '#/components/schemas/fieldListHourObj' forecast: $ref: '#/components/schemas/uvHourArr' description: Hourly OnPoint™ UV 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 uvIndex: maximum: 100 minimum: 0 type: number description: UV Index (unitless). format: float example: 10 uvIndexMax: maximum: 100 minimum: 0 type: number description: UV Index Max (unitless). format: float example: 10 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 date: type: string description: A date formatted as an RFC3339 date value. format: date example: 2019-12-20 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 dateRangeObj: required: - dateEnd - dateStart type: object properties: dateStart: $ref: '#/components/schemas/dateStart' dateEnd: $ref: '#/components/schemas/dateEnd' description: A date range object. dateStart: type: string description: A start date for a date range formatted as an RFC3339 date value. format: date example: 2019-12-20 dateEnd: type: string description: An end date for a date range formatted as an RFC3339 date value. format: date example: 2019-12-20 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 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" dmaObj: required: - countryCode - countryName - dmaId - dmaName - grid - population - samplePoints - timezone type: object properties: dmaId: $ref: '#/components/schemas/dmaId' dmaName: $ref: '#/components/schemas/dmaName' timezone: $ref: '#/components/schemas/timezone' population: $ref: '#/components/schemas/population' countryCode: $ref: '#/components/schemas/countryCode' countryName: $ref: '#/components/schemas/countryName' samplePoints: $ref: '#/components/schemas/samplePoints' grid: $ref: '#/components/schemas/grid' description: A Designated Market Area location metadata object dmaId: type: integer description: A [Designated Market Area ID](https://developer.weathersourceapis.com/apis/supported-dmas/). example: 529 dmaName: type: string description: A Designated Market Area name. example: Louisville population: type: integer description: The population as represented in the 2010 census. example: 1584746 samplePoints: type: array description: A list of OnPoint™ points used for interpolation for the Designated Market Area. These points are the OnPoint™ ID closest to the centroid of the 10 most populous postcodes within the target DMA. items: $ref: '#/components/schemas/samplePoints_inner' distancePop: type: integer description: The difference in population for the whole Designated Market Area and the population for the postcode represented by this sample point. example: 1536552 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' samplePoints_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/distancePop' elevation: $ref: '#/components/schemas/elevation' parameters: fieldsDay: name: fields in: query description: | A comma separated list of field names to return. The date 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 supported: * all *(all fields)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndexMax - all 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)* required: true style: form explode: false schema: type: array example: all items: type: string enum: - timestampInit - uvIndex - all 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