Web Services Reference
- GetLocationList
- Get Station List
- GetUSWorldCityByLatLong
- Get Live Weather
- Get Live Compact Weather
- GetAlertsDataList
- Get Forecast:
- Get Forecast Issue Details
-
GetLocationList
Description:
Get a list of International and U.S. locations based on Zip Code or any search string.
Input Parameters:
- Length (required)
- SearchString (required)
- ACode (required)
Output:
-
An ArrayList of objects of type ApiLocationData.
<anyType /> <anyType />
-
Get Station List
Description:
Get a list of stations based on City Code or Zip Code.
-
By City Code (GetStationListByCityCode):
Input Parameters:
- Length (required)
- CityCode (required)
- UnitType
- ACode (required)
Output:
-
An ArrayList of objects of type ApiStationData.
<anyType /> <anyType />
-
By Zip Code (GetStationListByUSZipCode):
Input Parameters:
- Length (required)
- ZipCode (required)
- UnitType
- ACode (required)
Output:
-
An ArrayList of objects of type ApiStationData
<anyType /> <anyType />
-
-
GetUSWorldCityByLatLong
Description:
Get a list of location data of the U.S. or international city nearest to the provided latitude and longitude.
Input Parameters:
- Length (required)
- latitude (required)
- longitude (required)
- ACode (required)
Output:
- An ArrayList of objects of type ApiStationTempsMapData.
<CityName>string</CityName> <CityCode>string</CityCode> <CountryCode>string</CountryCode> <isUSCity>boolean</isUSCity> <Latitude>decimal</Latitude> <Longitude>decimal</Longitude> <Province>string</Province> <State>string</State> <TimeZone>decimal</TimeZone> <ZipCode>string</ZipCode>
-
Get live Weather
Description:
Get live weather based on City Code, Station ID, or Zip Code.
-
By City Code (GetLiveWeatherByCityCode):
Input Parameters:
- Length (required)
- CityCode (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveWeatherData.
<AuxTemperature>string</AuxTemperature> <AuxTemperatureRate>string</AuxTemperatureRate> <City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <DewPoint>string</DewPoint> <Elevation>int</Elevation> <ElevationUnit>string</ElevationUnit> <FeelsLike>string</FeelsLike> <GustTime>dateTime</GustTime> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Humidity>string</Humidity> <HumidityUnit>string</HumidityUnit> <HumidityHigh>string</HumidityHigh> <HumidityLow>string</HumidityLow> <HumidityRate>string</HumidityRate> <MoonPhase>int</MoonPhase> Number indicates the percent illuminated. Ranges between -99 (New Moon) to 99 (Full Moon) <MoonPhaseImage>string</MoonPhaseImage> <Pressure>string</Pressure> <PressureUnit>string</PressureUnit> <PressureHigh>string</PressureHigh> <PressureLow>string</PressureLow> <PressureRate>string</PressureRate> <PressureRateUnit>string</PressureRateUnit> <Light>string</Light> <LightRate>string</LightRate> <IndoorTemperature>string</IndoorTemperature> <IndoorTemperatureRate>string</IndoorTemperatureRate> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainMonth>string</RainMonth> <RainRate>string</RainRate> <RainRateMax>string</RainRateMax> <RainRateUnit>string</RainRateUnit> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <RainYear>string</RainYear> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <StationURL>string</StationURL> <Sunrise>dateTime</Sunrise> <Sunset>dateTime</Sunset> <Temperature>string</Temperature> <TemperatureHigh>string</TemperatureHigh> <TemperatureLow>string</TemperatureLow> <TemperatureRate>string</TemperatureRate> <TemperatureRateUnit>string</TemperatureRateUnit> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WetBulb>string</WetBulb> <WindDirection>string</WindDirection> <WindDirectionAvg>string</WindDirectionAvg> <WindSpeed>string</WindSpeed> <WindSpeedAvg>string</WindSpeedAvg> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
-
By Station ID (GetLiveWeatherByStationID):
Input Parameters:
- Length (required)
- StationID (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveWeatherData.
<AuxTemperature>string</AuxTemperature> <AuxTemperatureRate>string</AuxTemperatureRate> <City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <DewPoint>string</DewPoint> <Elevation>int</Elevation> <ElevationUnit>string</ElevationUnit> <FeelsLike>string</FeelsLike> <GustTime>dateTime</GustTime> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Humidity>string</Humidity> <HumidityUnit>string</HumidityUnit> <HumidityHigh>string</HumidityHigh> <HumidityLow>string</HumidityLow> <HumidityRate>string</HumidityRate> <MoonPhase>int</MoonPhase> Number indicates the percent illuminated. Ranges between -99 (New Moon) to 99 (Full Moon) <MoonPhaseImage>string</MoonPhaseImage> <Pressure>string</Pressure> <PressureUnit>string</PressureUnit> <PressureHigh>string</PressureHigh> <PressureLow>string</PressureLow> <PressureRate>string</PressureRate> <PressureRateUnit>string</PressureRateUnit> <Light>string</Light> <LightRate>string</LightRate> <IndoorTemperature>string</IndoorTemperature> <IndoorTemperatureRate>string</IndoorTemperatureRate> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainMonth>string</RainMonth> <RainRate>string</RainRate> <RainRateMax>string</RainRateMax> <RainRateUnit>string</RainRateUnit> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <RainYear>string</RainYear> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <StationURL>string</StationURL> <Sunrise>dateTime</Sunrise> <Sunset>dateTime</Sunset> <Temperature>string</Temperature> <TemperatureHigh>string</TemperatureHigh> <TemperatureLow>string</TemperatureLow> <TemperatureRate>string</TemperatureRate> <TemperatureRateUnit>string</TemperatureRateUnit> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WetBulb>string</WetBulb> <WindDirection>string</WindDirection> <WindDirectionAvg>string</WindDirectionAvg> <WindSpeed>string</WindSpeed> <WindSpeedAvg>string</WindSpeedAvg> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
-
By Zip Code (GetLiveWeatherByUSZipCode):
Input Parameters:
- Length (required)
- ZipCode (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveWeatherData.
<AuxTemperature>string</AuxTemperature> <AuxTemperatureRate>string</AuxTemperatureRate> <City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <DewPoint>string</DewPoint> <Elevation>int</Elevation> <ElevationUnit>string</ElevationUnit> <FeelsLike>string</FeelsLike> <GustTime>dateTime</GustTime> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Humidity>string</Humidity> <HumidityUnit>string</HumidityUnit> <HumidityHigh>string</HumidityHigh> <HumidityLow>string</HumidityLow> <HumidityRate>string</HumidityRate> <MoonPhase>int</MoonPhase> Number indicates the percent illuminated. Ranges between -99 (New Moon) to 99 (Full Moon) <MoonPhaseImage>string</MoonPhaseImage> <Pressure>string</Pressure> <PressureUnit>string</PressureUnit> <PressureHigh>string</PressureHigh> <PressureLow>string</PressureLow> <PressureRate>string</PressureRate> <PressureRateUnit>string</PressureRateUnit> <Light>string</Light> <LightRate>string</LightRate> <IndoorTemperature>string</IndoorTemperature> <IndoorTemperatureRate>string</IndoorTemperatureRate> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainMonth>string</RainMonth> <RainRate>string</RainRate> <RainRateMax>string</RainRateMax> <RainRateUnit>string</RainRateUnit> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <RainYear>string</RainYear> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <StationURL>string</StationURL> <Sunrise>dateTime</Sunrise> <Sunset>dateTime</Sunset> <Temperature>string</Temperature> <TemperatureHigh>string</TemperatureHigh> <TemperatureLow>string</TemperatureLow> <TemperatureRate>string</TemperatureRate> <TemperatureRateUnit>string</TemperatureRateUnit> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WetBulb>string</WetBulb> <WindDirection>string</WindDirection> <WindDirectionAvg>string</WindDirectionAvg> <WindSpeed>string</WindSpeed> <WindSpeedAvg>string</WindSpeedAvg> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
Definition of API terms | GetLocationList | GetUSWorldCityByLatLong | Complete List of City Codes | Complete List of Short Predictions | Complete List of Icon Descriptions
-
-
Get Live Compact Weather
Description:
Get live compact weather based on City Code, Station ID or Zip Code.
-
By City Code (GetLiveCompactWeatherByCityCode):
Input Parameters:
- Length (required)
- CityCode (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveCompactWeatherData.
<City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <Temperature>string</Temperature> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WindDirection>string</WindDirection> <WindSpeed>string</WindSpeed> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
-
By City Code (GetLiveCompactWeatherByStationID):
Input Parameters:
- Length (required)
- StationID (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveCompactWeatherData.
<City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <Temperature>string</Temperature> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WindDirection>string</WindDirection> <WindSpeed>string</WindSpeed> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
-
By City Code (GetLiveCompactWeatherByUSZipCode):
Input Parameters:
- Length (required)
- ZipCode (required)
- UnitType
- ACode (required)
Output:
-
An object of type LiveCompactWeatherData.
<City>string</City> <CityCode>string</CityCode> <Country>string</Country> <CurrIcon>string</CurrIcon> <CurrDesc>string</CurrDesc> <GustWindSpeed>string</GustWindSpeed> <GustWindSpeedUnit>string</GustWindSpeedUnit> <GustWindDirectionString>string</GustWindDirectionString> <Latitude>double</Latitude> <Longitude>double</Longitude> <ObDate>string</ObDate> <ObDateTime>dateTime</ObDateTime> <RainToday>string</RainToday> <RainUnit>string</RainUnit> <State>string</State> <StationIDRequested>string</StationIDRequested> <StationIDReturned>string</StationIDReturned> <StationName>string</StationName> <Temperature>string</Temperature> <TemperatureUnit>string</TemperatureUnit> <TimeZone>string</TimeZone> <TimeZoneOffset>double</TimeZoneOffset> <WindDirection>string</WindDirection> <WindSpeed>string</WindSpeed> <WindSpeedUnit>string</WindSpeedUnit> <ZipCode>string</ZipCode>
Definition of API terms | GetLocationList | GetUSWorldCityByLatLong | Complete List of City Codes | Complete List of Short Predictions | Complete List of Icon Descriptions
-
-
GetAlertsDataList
Description:
Get Severe Weather Alerts based on U.S. Zip Codes.
Input Parameters:
- Length (required)
- ZipCode (required)
- ACode (required)
Output
-
An ArrayList of objects of type ApiAlertData.
<anyType /> <anyType />
Definition of API terms | GetLocationList | GetUSWorldCityByLatLong
-
Get Forecast
Description:
Get a local forecast based on City Code or Zip Code.
-
By City Code (GetForecastByCityCode):
Input Parameters:
- Length (required)
- CityCode (required)
- UnitType
- ACode (required)
Output:
-
An ArrayList of objects of type ApiForecastData.
<anyType /> <anyType />
-
By Zip Code (GetForecastByUSZipCode):
Input Parameters:
- Length (required)
- ZipCode (required)
- UnitType
- ACode (required)
Output:
-
An ArrayList of objects of type ApiForecastData.
<anyType /> <anyType />
Definition of API terms | GetLocationList | GetUSWorldCityByLatLong | Complete List of City Codes| Complete List of Short Predictions | Complete List of Icon Descriptions
-
-
Get Forecast Issue Details
Description:
Get forecast issue details based on City Code or Zip Code. This includes information such as the city, City Code, country, forecast date, state, Zip Code, and zone.
-
By City Code (GetForecastIssueDetailsByCityCode):
Input Parameters:
- Length (required)
- CityCode (required)
- ACode (required)
Output:
-
An object of type ApiForecastIssueData.
<City>string</City> <CityCode>string</CityCode> <Country>string</Country> <ForecastDate>string</ForecastDate> <State>string</State> <ZipCode>string</ZipCode> <Zone>string</Zone>
-
By Zip Code (GetForecastIssueDetailsByUSZipCode
Input Parameters:
- Length (required)
- ZipCode (required)
- ACode (required)
Output:
-
An object of type ApiForecastIssueData.
<City>string</City> <CityCode>string</CityCode> <Country>string</Country> <ForecastDate>string</ForecastDate> <State>string</State> <ZipCode>string</ZipCode> <Zone>string</Zone>
Definition of API terms | GetLocationList | GetUSWorldCityByLatLong | Complete List of City Codes | Complete List of Short Predictions | Complete List of Icon Descriptions
-
