Satellite Map API Parameters
Request Parameters | Response Parameters
Global Satellite API query string parameters
| Parameter | Description | Default value | |
|---|
| api |
Hostname to be used only in production: api.accuweather.com. |
N/A |
Required |
| apidev |
Hostname to be used only in development: apidev.accuweather.com. |
N/A |
Required |
| apikey |
Unique code used to access the API. |
N/A |
Required |
| version |
Version of the API. |
v1 |
Required |
| display_mode |
A numerical value that can change the resultant rendered tiles. |
N/A |
Optional |
| locations |
Boolean value. When true, returns a bounding box for the requested feature. |
false |
Optional |
| locationkey |
Unique ID used to search for a specific location. |
N/A |
Required |
| toplat |
The northern latitude that defines a bounding box. |
N/A |
Required |
| bottomlat |
The southern latitude that defines a bounding box. |
N/A |
Required |
| rightlon |
The eastern longitude that defines a bounding box. |
N/A |
Required |
| leftlon |
The western longitude that defines a bounding box. |
N/A |
Required |
| zoom |
Viewing height or distance the viewer appears to be from the map surface. |
N/A |
Required |
| attribute |
Returns JSON query attribution information for the source data. |
false |
Optional |
| products |
The full code of a specific Global Satellite product or products. |
N/A |
Required |
| x1 |
The top left X coordinate of a bounding box. |
N/A |
Required |
| y1 |
The top left Y coordinate of a bounding box. |
N/A |
Required |
| x2 |
The bottom right X coordinate of a bounding box. |
N/A |
Required |
| y2 |
The bottom right Y coordinate of a bounding box. |
N/A |
Required |
| nrd |
Normalized radar data. Returns all satellite graphics in red only. The red value directly correlates to the temperature in Kelvin. |
N/A |
Optional |
| imageDimensions |
The width and length, in pixels, of the image. Optional values are 768x432 or 480x270. |
N/A |
Required |
| theme |
A coloration option for image delivery. Currently available in light or dark. |
light |
Optional |
| legend |
Boolean value that indicates if a color-coded legend will be displayed in the bottom left of the returned weather map image. |
false |
Optional |
| imgtype |
The image file format. Current options are png or jpg. |
png |
Optional |
Top of page
Product lists response parameters
| Parameter | Description |
|---|
| products |
An array containing the full list of products. |
|
color |
Hexadecimal color code. |
|
location |
An object containing the bounding box limits. |
|
|
east |
Eastern bounding longitudinal value. |
|
|
|
north |
Northern bounding latitudinal value. |
|
|
|
south |
Southern bounding latitudinal value. |
|
|
|
west |
Western bounding longitudinal value. |
|
|
major |
The first part of the product ID number. Combined with the minor value and separated with a dash. |
|
minor |
The second part of the product ID number. Combined with the major value and separated with a dash. |
|
name |
The name of the product in English. |
| url |
The root URL for the current API system. |
Top of page
Product frames
| Parameter | Description |
|---|
| attributions |
An array that contains information about the sources for weather data within the product frames. |
|
assetcode |
For internal AccuWeather use only. |
|
sourceid |
A unique ID number for the specific source. |
|
sourcename |
The name of the source in English. |
| frames |
An array containing a list of frames. |
| url |
The root URL for the current API system. |
Top of page