WIFS API

API

The UK Met Office and National Weather Service (NWS) have synergized around the common use of the Open Geospatial Consortium (OGC) Environmental Data Retrieval (EDR) Application Programming Interface (API) for dissemination of WIFS/SADIS products. This decision has been largely driven by three compelling ICAO requirements:

The desire to support user specified requests for data
A requirement to support publication subscription services for WIFS/SADIS
A future ICAO requirement to support corridor extractions of data from WIFS/SADIS

The goals of the WIFS API are to make it easier to access a wide range of data through a uniform, well-defined simple Web interface, and to achieve data reduction to just the data needed by the user or client while hiding much of the data storage complexity. The user can retrieve small subsets from large collections of environmental data, such as weather forecasts, along with many other types of data. The important aspect is that the data can be unambiguously specified by spatio-temporal coordinates.

Users can access the WIFS API page using an API key set up through your WIFS account.

Collections

Gridded Data

Collection Types

1.25 deg grids

KWBC_WAFS_HUMIDITY_1P25
KWBC_WAFS_WINDTEMPGEO_1P25
KWBC_WAFS_TROPJET_1P25
EGRR_WAFS_HUMIDITY_1P25
EGRR_WAFS_WINDTEMPGEO_1P25
EGRR_WAFS_TROPJET_1P25

0.25 deg grids

KWBC_WAFS_HUMIDITY_0P25
KWBC_WAFS_WINDTEMPGEO_0P25
KWBC_WAFSHZDS_BLENDED_CB_0P25
KWBC_WAFSHZDS_BLENDED_TURB_0P25
KWBC_WAFSHZDS_BLENDED_ICE_0P25
EGRR_WAFS_HUMIDITY_0P25
EGRR_WAFS_WINDTEMPGEO_0P25

Items

Parameters

R - Humidity
T - Temperature
UV - UV Winds
H - ICAO Height
B - CB Data
L - GTG Turbulence
I - Icing severity

Grid

DX - 1.25 deg data
DY - 0.25 deg data

Location

G - Global
A1 - Europe - 30-90N, 30W-60E
A2 - Africa - 60S-30N, 30W-60E
A3 - Central Asia - 0-60N, 60E-150W
A4 - Australia - 60S-0, 60E-150W
A5 - North America - 15-90N, 150W-30W
A6 - South America - 60S-15N, 150W-30W
A7 - Siberia - 60-90N, 60E-150W
A8 - Antarctica - 90-60S, 180W-180E

Level

FLALL - All levels
FL998 - Max Wind
FL999 - Tropopause
FL001 - CB horizontal extent
FL002 - CB Base
FL003 - CB Top

Format

GRIB

Times

Hours for 1.25 deg, 3 hourly

006-012 - F06, F09, F12 collection
015-021 - F15, F18, F21 collection
024-030 - F24, F27, F30 collection
033-036 - F33, F36 collection

Hours for 0.25 deg, hourly

006-008 - F06, F07, F08 collection
009-011 - F09, F10, F11 collection
012-014 - F12, F13, F14 collection
015-017 - F15, F16, F17 collection
018-020 - F18, F19, F20 collection
021-023 - F21, F22, F23 collection

every 3 hours, all grids

024-030 - F24, F27, F30 collection
033-039 - F33, F36, F39 collection
042-048 - F42, F45, F48 collection

every 6 hours, Temp, Wind, Height only

054-066 - F54, F60, F66 collection
072-084 - F72, F78, F84 collection
090-102 - F90, F96, F102 collection
108-120 - F108, F114, F120 collection

Examples

Sample curl to access gridded data:

curl "https://aviationweather.gov/wifs/api/collections/{collection}/items/{item}?f={format}" -H "X-API-Key: {apikey}" --output {output_file}

{collection} is Collection Types
{item} is the data to return = {Params}{Grid}{Location}{Hours}{Level}
{format} is Format
{api_key} is a key provided by AWC to the user to authenticate use
{output_file} is where the downloaded data are to be stored

Type	Example URL
1.25 deg HUMIDITY	/wifs/api/collections/KWBC_WAFS_HUMIDITY_1P25/items/YRDXG006-012FLALL?f=GRIB
1.25 deg WINDTEMPGEO	/wifs/api/collections/KWBC_WAFS_WINDTEMPGEO_1P25/items/YUVDXG006-012FLALL?f=GRIB
1.25 deg TROPJET MAXWIND HEIGHT	/wifs/api/collections/KWBC_WAFS_TROPJET_1P25/items/YHDXG006-012FL998?f=GRIB
1.25 deg TROPJET TROP TEMP	/wifs/api/collections/KWBC_WAFS_TROPJET_1P25/items/YTDXG006-012FL999?f=GRIB
1.25 deg TROPJET MAXWIND UV WIND	/wifs/api/collections/KWBC_WAFS_TROPJET_1P25/items/YUVDXG006-012FL998?f=GRIB
0.25 deg WINDTEMPGEO HEIGHT GLOBAL	/wifs/api/collections/KWBC_WAFS_WINDTEMPGEO_0P25/items/YHDYG006-008FLALL?f=GRIB
0.25 deg WINDTEMPGEO TEMP TILE 5	/wifs/api/collections/KWBC_WAFS_WINDTEMPGEO_0P25/items/YTDYA5006-008FLALL?f=GRIB
0.25 deg WINDTEMPGEO UV WIND TILE 5 HOURS 24-30	/wifs/api/collections/KWBC_WAFS_WINDTEMPGEO_0P25/items/YUVDYA5024-030FLALL?f=GRIB
0.25 deg HUMIDITY TILE 5	/wifs/api/collections/KWBC_WAFS_HUMIDITY_0P25/items/YRDYA5006-008FLALL?f=GRIB
0.25 deg HAZ CB HOR EXT TILE 1	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_CB_0P25/items/YBDYA1006-008FL001?f=GRIB
0.25 deg HAZ CB HOR EXT GLOBAL	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_CB_0P25/items/YBDYG006-008FL001?f=GRIB
0.25 deg HAZ CB BASE GLOBAL	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_CB_0P25/items/YBDYG006-008FL002?f=GRIB
0.25 deg HAZ CB TOP GLOBAL	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_CB_0P25/items/YBDYG006-008FL003?f=GRIB
0.25 deg HAZ TURB TILE 1	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_TURB_0P25/items/YLDYA1006-008FLALL?f=GRIB
0.25 deg HAZ ICE TILE 1	/wifs/api/collections/KWBC_WAFSHZDS_BLENDED_ICE_0P25/items/YIDYA1006-008FLALL?f=GRIB

OPMET Data

Collection Types

tac_opmet_reports
iwxxm_opmet_reports

Params

METAR
SPECI
SIGMET
AIRMET
TAF

Location

GLOBAL
EUR-NAT - Europe/North Atlantic
NAM-CAR - North America/Caribbean
SAM - South America
AFI - Africa
MID - Middle East
ASIA-PAC - Asia/Pacific

Format

tac
iwxxm

Examples

Sample curl to access gridded data:

curl "https://aviationweather.gov/wifs/api/collections/{collection}/locations/{location}?parameter-name={parameter}&datetime={datetime}/{offset}&f={format}" -H "X-API-Key: {apikey}" --output {output_file}

{collection} is Collection Types
{location} is Location
{parameter} is comma separated list of Params
{datetime} is yyyy-mm-ddThh:mm:ss
{offset} is PT1M for previous one minute/PT5M for previous five minutes
{format} is Format
{api_key} is a key provided by AWC to the user to authenticate use
{output_file} is where the downloaded data are to be stored