You can use our test environment or interactive web console like Postman to test our API.
While you are testing, here are some helpful pointers to assist your debugging:
Ensure you are always using the POST method for each call.
Always use your Subscription key
API REFERENCE
The API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
AUTHENTICATION
Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Earth Networks Enterprise Portal. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
This variable can be any one of the following: (1) a zip code, or (2) a city name, or (3) a combination of zip code and city name separated by a comma, or (4) a city ID
Optional parameters:
cultureInfo (optional)
string
en-us, es-es
locationtype
string
“latitudelongitude”
location
string
a valid latitude/longitude
maxresults
number
Request headers:
Ocp-Apim-Subscription-Key
string
Subscription key which provides access to this API. Found in your Profile.
Radar and Maps provides URLs for Satellite, Radar, and Temperature maps as well as other various images of the United States, Puerto Rico and the Virgin Islands.
Maps can be provided in standard (373×272) size or enlarged (640×480) size. Earth Networks provides the capability for end users to navigate between maps (traveling N, S, E, W), and to zoom in and out between local, regional, and national maps. Navigation XML can be optionally added to provide a way to create an interface for your users to pan and zoom throughout the maps.
An animation option allows for a number of time-sequential images to be returned. Cycling through these images provides for a small animation loop. Note that images should be used in the same order as they are returned in the XML. Radar and Maps provide specific information for the given zip code or city code RequestType “RadarAndMaps” or 5.
The zip code for the area that you wish to have data returned for.
We now support 9-digit zipcodes.
For example, 20171, 20171-
1234 both of these formats will be accepted if passed in
PostalCode
5-digit number
A series of letters and/or digits appended to a postal address for the purpose of sorting mail.
CityCode
integer
The city code that identifies this location. This is the value that will be used in other calls to identify a specific list of stations for the provided city code
Optional parameters:
MapType
1 = Doppler Radar
2 = Infrared Satellite
3 = Satellite/Radar
4 = Visible Satellite
5 = Current Temperatures
6 = High Temps Today
7 = High Temps Tomorrow
8 = Wind Chill/Heat Index
9 = Wind Speed/Direction
10 = Topography
The type of map to retrieve.
Not all map types are available in all zip codes, such as Puerto Rico.
Zoom (Only for US)
1 = Local (closest view)
2 = Metro
3 = Regional
4 = National
8 = Hawaii
10 = Alaska
12 = Puerto Rico/Virgin Islands
The zoom level for the map
to retrieve. If you desire a map of Hawaii, Alaska, Puerto Rico or the Virgin Islands, be sure to specify the corresponding Zoom level. Not all map types are available in all zoom levels.
Animate
0 or blank = Show only the
current map URL
1 = Show a list of URLs for animation loops
Provides the animation image list, rather than a single image XML in the response.
Navigation
An XML Node containing an ID attribute as well as two sub-nodes.
Contains information about the current category ID and has sub-nodes to indicate the next and previous categories.
Enlarge
0 or blank = Show standard
size map URL(s)
1 = Show large image URL(s)
when 0 is entered standard is returned 363×272 images in the XML response. When 1 is entered enlarged is returned 640×480 images
Request headers:
Ocp-Apim-Subscription-Key
string
Subscription key which provides access to this API. Found in your Profile.
The Earth Networks Observation Data Feed will provide you with a set of current condition data based on the location or station id requested. For Location the logic is in place to always return the best observation for the location requested based on age, distance and accuracy. For station id the logic is to always return observations for that station id.
The Earth Networks Observation Data Feed will provide you with a set of current condition data based on the location or station id requested. For Location the logic is in place to always return the best observation for the location requested based on age, distance and accuracy. For station id the logic is to always return observations for that station id.
The stations call provides access to the station list and allows for the entry of optional parameters to make a bounding box to get a list of stations within that area.
This call returns a complete set of icons listed in order of icon code (for either lunar or forecast, by request). When providing Icons for depicting sky cover for current conditions the response shall check the local sunrise/sunset time in order to determine whether to return a day or night conditions icon value.
This call returns a complete set of icons listed in order of icon code (for either lunar or forecast, by request). When providing Earth Networks icons for depicting sky cover for current conditions the response shall check the local sunrise/sunset time in order to determine whether to return a day or night conditions icon value.
The stations call provides access to the entire station list. You should only use stations with a provider ID of 3, 4, 10 or 17. Adds optional display flag to allow manual setting to determine whether or not to use the station data.
Sunrise and Sunset provides accurate sunrise and sunset times based on latitude and longitude. Default behavior when optional parameters NumDays, ShowSunrise and ShowSunset are omitted is to display both sunrise and sunset data for seven days beginning with the current day.
„CityId“ from Search Location or Longitude,Latitude
Optional parameters:
days
number
number of days you want data for. The default is 1 meaning only the current day. The number of days includes the current day and any subsequent days in local time (max:10)
verbose (optional)
boolean
true, false
cultureInfo (optional)
string
en-us, es-es
Request headers:
Ocp-Apim-Subscription-Key
string
Subscription key which provides access to this API. Found in your Profile.