Radar Map API Guide

 

Types of Searches:

Tile Requests

Product Requests

Global Coverage Requests

 

 

 

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.

 

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 full time and date for the requested weather data. These four variables determine which tile is returned by the call and what information it contains.

https://{{api} or {apidev}}.accuweather.com/maps/v1/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/v1/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/v1/radar/globalSIR/quadkey/{quadkey value}.png?apikey={your key}&colortable={{on} or {off}}&display_mode={display mode}

Tile requests that yield no graphical data will redirect to a blank tile. See below for details.

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/v1/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/v1/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/v1/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/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/v1/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/v1/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/v1/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/v1/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/v1/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