Radar Map API Guide

Tile requests

Product requests

Global coverage requests

Static radar map images

Tile Requests

There are multiple methods for requesting tiles from Global Radar. ZXY and ZYX formats provide a means of identifying tiles directly by coordinates, while quadkey identifies tiles by a unique code. Tile requests that yield no graphical data will redirect to a blank tile. See Blank Tiles below for details.

ZXY and ZYX format

The ZXY URL format is a standard Google format. It requires the zoom level (z), the x coordinate (x), the y coordinate (y), and a time and date for the requested weather data. These four variables determine which tile the call returns and what information it contains.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/zxy/{yyyy-mm-dd}T{hh:mm:ss}Z/{zoom}/{x}/{y}.png?apikey={your key}&colortable={{on} or {off}}&display_mode={display mode}

The ZYX URL format is nearly identical but will return the most recent tile for the provided location. Date and time are not necessary for this call. The call is redirected (via 302 redirect) to an altered response URL that includes the appropriate date and time.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/zxy/tile/{zoom}/{x}/{y}.png?apikey={your key}&colortable={{on} or {off}}&display_mode={display mode}

Example

A simple search for a specific tile with a zoom level of 4, at coordinates X=9 and Y=4 will look like this:

https://api.accuweather.com/maps/v1/radar/globalSIR/zxy/4/9/4.png?apikey={your key}

The call will redirect to the most recently available time and date for that tile, and the response will be the specified tile showing current weather data:

https://api.accuweather.com/maps/v1/radar/globalSIR/zxy/2019-02-05T18:00:00Z/4/9/4.png?apikey={your key}

Top of page

Quadkey format

This method gets tiles using Microsoft's quadtree key (quadkey) format. Quadkey is an alternative method for identifying individual tiles in a map grid. Instead of separating values, it combines all identifying factors into a solid numerical string. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/quadkey/{quadkey value}.png?apikey={your key}&colortable={{on} or {off}}&display_mode={display mode}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/quadkey/03133.png?apikey={your key}&colortable=on

Top of page

Blank tiles

If a tile request yields no graphical data, the API returns a generic blank tile. The URL redirects to a static address that contains the blank tile. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/blank.png?apikey={your key}&display_mode={display mode}

Top of page

Product requests

List available products

Returns a list of available products within Global Radar. This function can be used to move the map to a specific product. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/request_products?apikey={your key}&locations={boolean}

Setting locations to true will return an extra object within each product that provides a bounding box for that product.

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/request_products?apikey={your key}&locations=true

Top of page

List active products

Returns a list of products within the current map bounding box. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/preferred_box_products?apikey={your key}&toplat={north latitude}&bottomlat={southern latitude}&rightlon={eastern longitude}&leftlon={western longitude}&zoom={zoom level}&attribute={boolean}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/preferred_box_products?apikey={your key}&toplat=66&bottomlat=-22&rightlon=95&leftlon=-55&zoom=3&attribute=true

Top of page

Request frames for products

Returns a list of mutual frames for all listed products. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/preferred_product_frames?apikey={your key}&products={major}-{minor},{major}-{minor},{major}-{minor},...&attribute={boolean}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/preferred_product_frames?apikey={your key}&products=16-1004,16-1005,16-1001,16-1002,16-1003&attribute=true

Top of page

Request frames for box

Returns a list of frames within the current map bounding box. The response includes attributions. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/preferred_box_frames?apikey={your key}&toplat={north latitude}&bottomlat={southern latitude}&rightlon={eastern longitude}&leftlon={western longitude}&zoom={zoom level}&attribute={boolean}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/preferred_product_frames?apikey={your key}&toplat=49&bottomlat=28&rightlon=17&leftlon=-20&zoom=5&attribute=true

Top of page

Request products for tiles

Returns a list of products within a specified map bounding box. The top left corner of the box is defined by X1, Y1 and the bottom right corner of the box is defined by X2, Y2. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/preferred_tile_products?apikey={your key}&x1={top left x coordinate}&y1={top left y coordinate}&x2={bottom right x coordinate}&y2={bottom right y coordinate}&z={zoom level}&attribute={boolean}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/preferred_tile_products?apikey={your key}&x1=6&y1=5&x2=8&y2=6&z=4&attribute=true

Top of page

Global coverage requests

Each product encompasses a certain region of the world. Global coverage requests will return information about products and what area they cover.

Request meta information

This endpoint lists full information for each product, including bounding boxes. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/request_products?apikey={your key}&locations={boolean}

Example

https://api.accuweather.com/maps/v1/radar/globalSIR/request_products?apikey={your key}&locations=true

Top of page

Request image coverage

Returns a map that shows radar coverage. The correct URL formatting is shown below.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/globalSIR/global_coverage?apikey={your key}

Example

Note: the response image shown in this example is not displayed at full size. Click here to see the full-size image.

https://api.accuweather.com/maps/v1/radar/globalSIR/global_coverage?apikey={your key}

Top of page

Static radar map

Returns a static weather radar image that includes a base map image in a single file.

Static radar map by city

Seach by city to return a localized radar map image.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/staticImage/{imagedimensions}/cities/{locationkey}?apikey={your key}&language={languagecode}&theme={{light} or {dark}}&legend={boolean}&imgtype={{png} or {jpg}}

Example

https://api.accuweather.com/maps/v1/radar/staticImage/480x270/cities/349727?apikey={your key}&theme=light&legend=false&imgtype=jpg

Top of page

Static radar map by admin area

Search by political division within a country such as state or province.

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/staticImage/{imagedimensions}/adminareas/{countrycode}/{region}?apikey={your key}&language={languagecode}&theme={{light} or {dark}}&legend={boolean}&imgtype={{png} or {jpg}}

Example

https://api.accuweather.com/maps/v1/radar/staticImage/768x432/adminareas/US/PA?apikey={your key}&legend=true

Top of page

Static radar map by country

https://{{api} or {apidev}}.accuweather.com/maps/{version}/radar/staticImage/{imagedimensions}/countries/{countrycode}?apikey={your key}&language={languagecode}&theme={{light} or {dark}}&legend={boolean}&imgtype={{png} or {jpg}}

Example

https://api.accuweather.com/maps/v1/radar/staticImage/480x270/countries/US?apikey={your key}&theme=dark&legend=true

Top of page