The Raine API from AccuWeather — 1 operation(s) for raine.
openapi: 3.0.1
info:
title: AccuWeather One Active Storms Raine API
description: AccuWeather's internal product API for the One platform.
version: v1
tags:
- name: Raine
paths:
/api/raine:
get:
tags:
- Raine
summary: AccuWeather Retreives the Raine Configuration for a Page
parameters:
- name: Locale
in: query
description: ISO 639-2 and ISO 3166-1 code for the locale
schema:
type: string
example: en-us
example: en-us
- name: MeasurementDisplay
in: query
description: Display type for weather conditions and distance
schema:
$ref: '#/components/schemas/MeasurementDisplayType'
example: Imperial
- name: WindUnit
in: query
description: Additional display type for wind direction
schema:
$ref: '#/components/schemas/WindDirectionDisplayType'
example: Cardinal
- name: Theme
in: query
description: Theme for the application
schema:
$ref: '#/components/schemas/ThemeType'
example: System
- name: pageGroup
in: query
description: The page group name.
schema:
type: string
example: example-value
- name: platform
in: query
description: The platform name.
schema:
type: string
default: one
example: example-value
- name: locationKey
in: query
description: The location key to retrieve weather location.
schema:
type: string
default: ''
example: '347628'
responses:
'200':
description: Page View response received
content:
application/json:
schema:
$ref: '#/components/schemas/RainePageView'
examples:
_api_raine200Example:
summary: Default _api_raine 200 response
x-microcks-default: true
value:
id: '500123'
test: example-value
platform: example-value
version: example-value
page:
group: example-value
url: https://www.accuweather.com/en/us/new-york-ny/10007/weather-forecast/347628
referrer: example-value
ads:
code: example-value
status: example-value
cookie3p: example-value
session:
id: '500123'
partner: example-value
utm:
source: AccuWeather
medium: example-value
campaign: example-value
term: example-value
user:
id: '500123'
language: example-value
country: example-value
region: example-value
city: example-value
dma: example-value
start: example-value
offset: example-value
network:
throughput: example-value
network: example-value
type: example-value
device:
name: New York
brand: example-value
version: example-value
category: example-value
weather:
key: '347628'
bot: true
time: example-value
'400':
description: Parameters are bad, details in body.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
MeasurementDisplayType:
enum:
- Metric
- Imperial
- Hybrid
type: string
UserNetwork:
type: object
properties:
throughput:
type: string
description: Category of 'network speed' for the user. Eg. 'vhigh'
nullable: true
network:
type: string
description: Name of the network for the user. Eg. 'comcast'
nullable: true
type:
type: string
description: Type of network for the user. Eg. 'cable'
nullable: true
additionalProperties: false
UserInfo:
type: object
properties:
id:
type: string
description: Unique ID for the user (persistent across sessions)
nullable: true
language:
type: string
description: Language code set for the product for the user (en-us, en-gb, etc.)
nullable: true
country:
type: string
description: "Country code for the user's location.\r\nEg. US"
nullable: true
region:
type: string
description: "Region code for the user's location.\r\nEg. PA"
nullable: true
city:
type: string
description: City for the location
nullable: true
dma:
type: string
description: "DMA for the user's location.\r\nEg. 566. Not available outside of the US."
nullable: true
start:
type: string
description: "Date of the user's first visit.\r\nI.e. Cookie creation date"
nullable: true
offset:
type: string
description: "Valid string of the user's current UTC offset in hh:mm:ss format.\r\nEx. -05:00 or 05:00"
nullable: true
additionalProperties: false
RainePageView:
type: object
properties:
id:
type: string
nullable: true
test:
type: string
nullable: true
platform:
type: string
nullable: true
version:
type: string
nullable: true
page:
$ref: '#/components/schemas/PageInfo'
ads:
$ref: '#/components/schemas/AdInfo'
session:
$ref: '#/components/schemas/SessionInfo'
user:
$ref: '#/components/schemas/UserInfo'
network:
$ref: '#/components/schemas/UserNetwork'
device:
$ref: '#/components/schemas/DeviceInfo'
weather:
$ref: '#/components/schemas/WeatherInfo'
bot:
type: boolean
description: True if X-Akamai-Bot header is filled; default false
nullable: true
time:
type: string
nullable: true
additionalProperties: false
DeviceInfo:
type: object
properties:
name:
type: string
description: "Name of the user's browser.\r\nEg. 'Chrome'"
nullable: true
brand:
type: string
description: "Name of the user's device maker.\r\nEg. 'Apple' or 'Samsung'"
nullable: true
version:
type: string
description: "Version of the user's browser.\r\nEg. '16'"
nullable: true
category:
type: string
description: One of 'mobile', 'tablet', or 'desktop'
nullable: true
additionalProperties: false
AdInfo:
type: object
properties:
code:
type: string
description: "Simplified ad code for ad slots on the page.\r\nEg. '6581/web/us/*/news_info/country_home'"
nullable: true
status:
type: string
description: "One of 'active', 'missing', or 'restricted' indicating a user's ID status\r\nDefault missing."
nullable: true
cookie3p:
type: string
description: "One of 'active', 'missing', or 'restricted' indicating a user can access 3rd party cookies or not.\r\nDefault missing."
nullable: true
additionalProperties: false
SessionInfo:
type: object
properties:
id:
type: string
description: Unique ID for the user's session (persistent to 10m after the last pageview)
nullable: true
partner:
type: string
description: Unique ID for the partner from the URL
nullable: true
utm:
$ref: '#/components/schemas/UTMInfo'
additionalProperties: false
ThemeType:
enum:
- Light
- Dark
- System
type: string
UTMInfo:
type: object
properties:
source:
type: string
description: utm_source from the URL
nullable: true
medium:
type: string
description: utm_medium from the URL
nullable: true
campaign:
type: string
description: utm_campaign from the URL
nullable: true
term:
type: string
description: utm_term from the URL
nullable: true
additionalProperties: false
WindDirectionDisplayType:
enum:
- Cardinal
- Degrees
type: string
PageInfo:
type: object
properties:
group:
type: string
description: Page group like 'three-day' or 'hourly' designating the page category
nullable: true
url:
type: string
description: URL of the page
nullable: true
referrer:
type: string
description: Referrer of the page
nullable: true
additionalProperties: false
WeatherInfo:
type: object
properties:
key:
type: string
description: "Surefind location key for the user's weather location\r\nEg. 335315"
nullable: true
additionalProperties: false