Passport Advantage® Core Aggregation Engine Common Parameter

Overview

• Domain Portfolio: Utility
• Domain: Aggregation
• Usage Classification: Standard
• Geography: Global
• Attribution Required: NO
• Attribution Requirements: N/A

• Products included in the aggregation request must be semicolon separated (;). Query parameters are required for all requests.

Aggregate Limitations

Important limitations on what can be produced and supported through aggregation:

1. Aggregations are limited to a total uncompressed response size of less than 1 megabyte total (the entire response for the complete aggregation cannot exceed 1 megabyte).
2. URL’s are limited to approximately 4,000 characters in length (including protocol, hostname, path and query string).

For all practical purposes, the most likely limits you will hit in using aggregation are the payload and character restrictions (especially the total uncompressed size).

WARNING: Due to the nature of the implementation of aggregation, if your request or response does violate any of the above limitations, you will receive an error response with a 5XX HTTP Status code

HTTP Headers and Data Lifetime - Caching and Expiration

For details on appropriate header values as well as caching and expiration definitions, please see The Weather Company Data | API Common Usage Guide.

URL Construction

Note: Unique to this API is the ability to request by multiple geocodes and placeids as a semicolon-seperated product list. See below for details.

JSON Sample

{
id: "33.74,-84.39",
v2fcstdaily3: {
metadata: {
language: "en-US",
transaction_id: "1521823740966:-765308731",
version: "1",
latitude: 33.74,
longitude: -84.39,
units: "e",
expire_time_gmt: 1521824404,
status_code: 200
},
forecasts: [
{
class: "fod_long_range_daily",
expire_time_gmt: 1521824404,
fcst_valid: 1521802800,
fcst_valid_local: "2018-03-23T07:00:00-0400",
num: 1,
max_temp: 63,
min_temp: 45,
torcon: null,
stormcon: null,
blurb: null,
blurb_author: null,
lunar_phase_day: 6,
dow: "Friday",
lunar_phase: "Waxing Crescent",
lunar_phase_code: "WXC",
sunrise: "2018-03-23T07:37:26-0400",
sunset: "2018-03-23T19:51:42-0400",
moonrise: "2018-03-23T11:58:55-0400",
moonset: "2018-03-23T01:16:44-0400",
qualifier_code: null,
qualifier: null,
narrative: "Partly cloudy. Highs in the low 60s and lows in the mid 40s.",
qpf: 0,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
night: {
fcst_valid: 1521846000,
fcst_valid_local: "2018-03-23T19:00:00-0400",
day_ind: "N",
thunder_enum: 0,
daypart_name: "Tonight",
long_daypart_name: "Friday night",
alt_daypart_name: "Tonight",
thunder_enum_phrase: "No thunder",
num: 2,
temp: 45,
hi: 60,
wc: 44,
pop: 20,
icon_extd: 2900,
icon_code: 29,
wxman: "wx1650",
phrase_12char: "P Cloudy",
phrase_22char: "Partly Cloudy",
phrase_32char: "Partly Cloudy",
subphrase_pt1: "Partly",
subphrase_pt2: "Cloudy",
subphrase_pt3: "",
precip_type: "rain",
rh: 66,
wspd: 7,
wdir: 83,
wdir_cardinal: "E",
clds: 61,
pop_phrase: "",
temp_phrase: "Low near 45F.",
accumulation_phrase: "",
wind_phrase: "Winds E at 5 to 10 mph.",
shortcast: "Partly cloudy",
narrative: "Partly cloudy this evening with more clouds for overnight. Low near 45F. Winds E at 5 to 10 mph.",
qpf: 0,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D2:DA02:X3000280021:S300021:TL45:W04R02",
qualifier_code: null,
qualifier: null,
uv_index_raw: 0,
uv_index: 0,
uv_warning: 0,
uv_desc: "Low",
golf_index: null,
golf_category: ""
},
day: {
fcst_valid: 1521802800,
fcst_valid_local: "2018-03-23T07:00:00-0400",
day_ind: "D",
thunder_enum: 0,
daypart_name: "Today",
long_daypart_name: "Friday",
alt_daypart_name: "Today",
thunder_enum_phrase: "No thunder",
num: 1,
temp: 63,
hi: 62,
wc: 54,
pop: 0,
icon_extd: 3000,
icon_code: 30,
wxman: "wx1100",
phrase_12char: "P Cloudy",
phrase_22char: "Partly Cloudy",
phrase_32char: "Partly Cloudy",
subphrase_pt1: "Partly",
subphrase_pt2: "Cloudy",
subphrase_pt3: "",
precip_type: "rain",
rh: 36,
wspd: 9,
wdir: 298,
wdir_cardinal: "WNW",
clds: 37,
pop_phrase: "",
temp_phrase: "High 63F.",
accumulation_phrase: "",
wind_phrase: "Winds WNW at 5 to 10 mph.",
shortcast: "Mix of sun and clouds",
narrative: "Partly cloudy. High 63F. Winds WNW at 5 to 10 mph.",
qpf: 0,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D1:DA01:X3000300014:S300012:TH63:W13R02",
qualifier_code: null,
qualifier: null,
uv_index_raw: 7.22,
uv_index: 7,
uv_warning: 0,
uv_desc: "High",
golf_index: 9,
golf_category: "Very Good"
}
},
{
class: "fod_long_range_daily",
expire_time_gmt: 1521824404,
fcst_valid: 1521889200,
fcst_valid_local: "2018-03-24T07:00:00-0400",
num: 2,
max_temp: 70,
min_temp: 56,
torcon: null,
stormcon: null,
blurb: null,
blurb_author: null,
lunar_phase_day: 7,
dow: "Saturday",
lunar_phase: "First Quarter",
lunar_phase_code: "FQ",
sunrise: "2018-03-24T07:36:05-0400",
sunset: "2018-03-24T19:52:27-0400",
moonrise: "2018-03-24T12:52:50-0400",
moonset: "2018-03-24T02:18:59-0400",
qualifier_code: null,
qualifier: null,
narrative: "Chance of afternoon showers. Highs in the low 70s and lows in the mid 50s.",
qpf: 0.22,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
night: {
fcst_valid: 1521932400,
fcst_valid_local: "2018-03-24T19:00:00-0400",
day_ind: "N",
thunder_enum: 2,
daypart_name: "Tomorrow night",
long_daypart_name: "Saturday night",
alt_daypart_name: "Saturday night",
thunder_enum_phrase: "Thunder expected",
num: 4,
temp: 56,
hi: 70,
wc: 59,
pop: 70,
icon_extd: 1140,
icon_code: 11,
wxman: "wx2500",
phrase_12char: "T-Showers",
phrase_22char: "Thundershowers",
phrase_32char: "Thundershowers",
subphrase_pt1: "T-Showers",
subphrase_pt2: "",
subphrase_pt3: "",
precip_type: "rain",
rh: 73,
wspd: 11,
wdir: 236,
wdir_cardinal: "SW",
clds: 90,
pop_phrase: "Chance of rain 70%.",
temp_phrase: "Low 56F.",
accumulation_phrase: "",
wind_phrase: "Winds SW at 10 to 15 mph.",
shortcast: "Thundershowers",
narrative: "Rain showers in the evening then thundershowers overnight. Low 56F. Winds SW at 10 to 15 mph. Chance of rain 70%.",
qpf: 0.19,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D4:DA17:X1100114042:S114043:TL56:W10R03:P9071",
qualifier_code: null,
qualifier: null,
uv_index_raw: 0,
uv_index: 0,
uv_warning: 0,
uv_desc: "Low",
golf_index: null,
golf_category: ""
},
day: {
fcst_valid: 1521889200,
fcst_valid_local: "2018-03-24T07:00:00-0400",
day_ind: "D",
thunder_enum: 0,
daypart_name: "Tomorrow",
long_daypart_name: "Saturday",
alt_daypart_name: "Saturday",
thunder_enum_phrase: "No thunder",
num: 3,
temp: 70,
hi: 69,
wc: 43,
pop: 50,
icon_extd: 7103,
icon_code: 39,
wxman: "wx2500",
phrase_12char: "PM Showers",
phrase_22char: "PM Showers",
phrase_32char: "PM Showers",
subphrase_pt1: "PM",
subphrase_pt2: "Showers",
subphrase_pt3: "",
precip_type: "rain",
rh: 60,
wspd: 13,
wdir: 186,
wdir_cardinal: "S",
clds: 70,
pop_phrase: "Chance of rain 50%.",
temp_phrase: "High near 70F.",
accumulation_phrase: "",
wind_phrase: "Winds S at 10 to 20 mph.",
shortcast: "Afternoon showers",
narrative: "Partly cloudy skies during the morning hours will give way to occasional showers in the afternoon. High near 70F. Winds S at 10 to 20 mph. Chance of rain 50%.",
qpf: 0.03,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D3:DA16:X3000110031:S710331:TH70:W08R04:P9051",
qualifier_code: null,
qualifier: null,
uv_index_raw: 5.6,
uv_index: 6,
uv_warning: 0,
uv_desc: "High",
golf_index: 9,
golf_category: "Very Good"
}
},
{
class: "fod_long_range_daily",
expire_time_gmt: 1521824404,
fcst_valid: 1521975600,
fcst_valid_local: "2018-03-25T07:00:00-0400",
num: 3,
max_temp: 60,
min_temp: 40,
torcon: null,
stormcon: null,
blurb: null,
blurb_author: null,
lunar_phase_day: 8,
dow: "Sunday",
lunar_phase: "Waxing Gibbous",
lunar_phase_code: "WXG",
sunrise: "2018-03-25T07:34:44-0400",
sunset: "2018-03-25T19:53:11-0400",
moonrise: "2018-03-25T13:52:17-0400",
moonset: "2018-03-25T03:19:10-0400",
qualifier_code: null,
qualifier: null,
narrative: "Light rain in the morning. Highs in the low 60s and lows in the low 40s.",
qpf: 0.28,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
night: {
fcst_valid: 1522018800,
fcst_valid_local: "2018-03-25T19:00:00-0400",
day_ind: "N",
thunder_enum: 0,
daypart_name: "Sunday night",
long_daypart_name: "Sunday night",
alt_daypart_name: "Sunday night",
thunder_enum_phrase: "No thunder",
num: 6,
temp: 40,
hi: 51,
wc: 36,
pop: 70,
icon_extd: 7100,
icon_code: 45,
wxman: "wx2550",
phrase_12char: "Shwrs Late",
phrase_22char: "Showers Late",
phrase_32char: "Showers Late",
subphrase_pt1: "Showers",
subphrase_pt2: "Late",
subphrase_pt3: "",
precip_type: "rain",
rh: 74,
wspd: 14,
wdir: 88,
wdir_cardinal: "E",
clds: 99,
pop_phrase: "Chance of rain 70%.",
temp_phrase: "Low near 40F.",
accumulation_phrase: "",
wind_phrase: "Winds E at 10 to 20 mph.",
shortcast: "Showers late",
narrative: "Cloudy with occasional showers late at night. Low near 40F. Winds E at 10 to 20 mph. Chance of rain 70%.",
qpf: 0.21,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D6:DA05:X2600110041:S710041:TL40:W04R04:P9071",
qualifier_code: null,
qualifier: null,
uv_index_raw: 0,
uv_index: 0,
uv_warning: 0,
uv_desc: "Low",
golf_index: null,
golf_category: ""
},
day: {
fcst_valid: 1521975600,
fcst_valid_local: "2018-03-25T07:00:00-0400",
day_ind: "D",
thunder_enum: 0,
daypart_name: "Sunday",
long_daypart_name: "Sunday",
alt_daypart_name: "Sunday",
thunder_enum_phrase: "No thunder",
num: 5,
temp: 60,
hi: 59,
wc: 48,
pop: 80,
icon_extd: 6304,
icon_code: 11,
wxman: "wx2550",
phrase_12char: "AM Lgt Rain",
phrase_22char: "AM Light Rain",
phrase_32char: "AM Light Rain",
subphrase_pt1: "AM",
subphrase_pt2: "Lt Rain",
subphrase_pt3: "",
precip_type: "rain",
rh: 80,
wspd: 12,
wdir: 83,
wdir_cardinal: "E",
clds: 97,
pop_phrase: "Chance of rain 80%.",
temp_phrase: "High near 60F.",
accumulation_phrase: "",
wind_phrase: "Winds E at 10 to 15 mph.",
shortcast: "Light rain in the morning",
narrative: "Cloudy with occasional light rain...mainly in the morning. High near 60F. Winds E at 10 to 15 mph. Chance of rain 80%.",
qpf: 0.07,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D5:DA04:X1201260033:S630431:TH60:W04R03:P9081",
qualifier_code: null,
qualifier: null,
uv_index_raw: 3.25,
uv_index: 3,
uv_warning: 0,
uv_desc: "Moderate",
golf_index: 5,
golf_category: "Fair"
}
},
{
class: "fod_long_range_daily",
expire_time_gmt: 1521824404,
fcst_valid: 1522062000,
fcst_valid_local: "2018-03-26T07:00:00-0400",
num: 4,
max_temp: 46,
min_temp: 44,
torcon: null,
stormcon: null,
blurb: null,
blurb_author: null,
lunar_phase_day: 9,
dow: "Monday",
lunar_phase: "Waxing Gibbous",
lunar_phase_code: "WXG",
sunrise: "2018-03-26T07:33:23-0400",
sunset: "2018-03-26T19:53:55-0400",
moonrise: "2018-03-26T14:55:24-0400",
moonset: "2018-03-26T04:14:16-0400",
qualifier_code: null,
qualifier: null,
narrative: "Showers. Highs in the mid 40s with temperatures nearly steady overnight.",
qpf: 0.1,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
night: {
fcst_valid: 1522105200,
fcst_valid_local: "2018-03-26T19:00:00-0400",
day_ind: "N",
thunder_enum: 0,
daypart_name: "Monday night",
long_daypart_name: "Monday night",
alt_daypart_name: "Monday night",
thunder_enum_phrase: "No thunder",
num: 8,
temp: 44,
hi: 48,
wc: 40,
pop: 20,
icon_extd: 2600,
icon_code: 26,
wxman: "wx1250",
phrase_12char: "Cloudy",
phrase_22char: "Cloudy",
phrase_32char: "Cloudy",
subphrase_pt1: "Cloudy",
subphrase_pt2: "",
subphrase_pt3: "",
precip_type: "rain",
rh: 63,
wspd: 12,
wdir: 95,
wdir_cardinal: "E",
clds: 98,
pop_phrase: "",
temp_phrase: "Low 44F.",
accumulation_phrase: "",
wind_phrase: "Winds E at 10 to 15 mph.",
shortcast: "Mostly cloudy",
narrative: "Cloudy. Low 44F. Winds E at 10 to 15 mph.",
qpf: 0,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D8:DA07:X2600260042:S260042:TL44:W04R03",
qualifier_code: null,
qualifier: null,
uv_index_raw: 0,
uv_index: 0,
uv_warning: 0,
uv_desc: "Low",
golf_index: null,
golf_category: ""
},
day: {
fcst_valid: 1522062000,
fcst_valid_local: "2018-03-26T07:00:00-0400",
day_ind: "D",
thunder_enum: 0,
daypart_name: "Monday",
long_daypart_name: "Monday",
alt_daypart_name: "Monday",
thunder_enum_phrase: "No thunder",
num: 7,
temp: 46,
hi: 46,
wc: 32,
pop: 40,
icon_extd: 1100,
icon_code: 11,
wxman: "wx2510",
phrase_12char: "Showers",
phrase_22char: "Showers",
phrase_32char: "Showers",
subphrase_pt1: "Showers",
subphrase_pt2: "",
subphrase_pt3: "",
precip_type: "rain",
rh: 67,
wspd: 15,
wdir: 90,
wdir_cardinal: "E",
clds: 100,
pop_phrase: "Chance of rain 40%.",
temp_phrase: "High 46F.",
accumulation_phrase: "",
wind_phrase: "Winds E at 10 to 20 mph.",
shortcast: "Chance of showers",narrative: "Rain showers in the morning becoming more intermittent in the afternoon. High 46F. Winds E at 10 to 20 mph. Chance of rain 40%.",
qpf: 0.1,
snow_qpf: 0,
snow_range: "",
snow_phrase: "",
snow_code: "",
vocal_key: "D7:DA06:X1100460032:S110033:TH46:W04R04:P9041",
qualifier_code: null,
qualifier: null,
uv_index_raw: 3.28,
uv_index: 3,
uv_warning: 0,
uv_desc: "Moderate",
golf_index: 2,
golf_category: "Very Poor"
}
}
]
},
v2obs: {
metadata: {
language: "en-US",
transaction_id: "1521823740927:1684309144",
version: "1",
latitude: 33.74,
longitude: -84.39,
units: "e",
expire_time_gmt: 1521827520,
status_code: 200
},
observation: {
key: "KATL",
class: "observation",
expire_time_gmt: 1521827520,
obs_id: "KATL",
obs_name: "Atlanta",
valid_time_gmt: 1521820320,
day_ind: "D",
temp: 50,
wx_icon: 28,
icon_extd: 2800,
wx_phrase: "Mostly Cloudy",
pressure_tend: null,
pressure_desc: null,
dewPt: 29,
heat_index: 50,
rh: 44,
pressure: 29.2,
vis: 10,
wc: 50,
wdir: 280,
wdir_cardinal: "W",
gust: null,
wspd: 3,
max_temp: null,
min_temp: null,
precip_total: null,
precip_hrly: 0,
snow_hrly: null,
uv_desc: "Moderate",
feels_like: 50,
uv_index: 3,
qualifier: null,
qualifier_svrty: null,
blunt_phrase: null,
terse_phrase: null,
clds: "BKN",
water_temp: null,
primary_wave_period: null,
primary_wave_height: null,
primary_swell_period: null,
primary_swell_height: null,
primary_swell_direction: null,
secondary_swell_period: null,
secondary_swell_height: null,
secondary_swell_direction: null
}
},
v3-location-point: {
location: {
latitude: 33.738,
longitude: -84.384,
city: "Atlanta",
locale: {
locale1: null,
locale2: "Atlanta",
locale3: null,
locale4: "Summerhill"
},
neighborhood: "Summerhill",
adminDistrict: "Georgia",
adminDistrictCode: "GA",
postalCode: "30312",
postalKey: "30312:US",
country: "United States",
countryCode: "US",
ianaTimeZone: "America/New_York",
displayName: "Atlanta",
dstEnd: "2018-11-04T01:00:00-0500",
dstStart: "2018-03-11T03:00:00-0400",
placeId: "25d07eca1bcda02800c1a9e699d7eb1c8132cad9bc2d6efa8a2531f0ee4a81cd"
}
}
}