Media Warnings API

The warnings service provides access to the official Bureau of Meteorology warnings. Only the current warnings can be accessed. Historical warnings are not available.

The warnings service uses a location identifier which represents a region. To find out what warning locations to use, use the Weather Resources call (see Location Services) or the List Regions call.

1 List Regions

This call is used to list the available warnings regions.

Description: This call gets an array of the warning locations.

API Call:

GET /countries/{countryCode}/severeWeather/warningRegions

Parameters:

Example:

This example would return the current warnings regions.

GET /countries/au/severeWeather/warningRegions

API Response:

{
    "issue-time":"2017-02-21T02:21:58Z",
    "response":{
        "act":"Australian Capital Territory",
        "nsw":"New South Wales",
        "nt":"Northern Territory",
        "oc":"Ocean",
        "qld":"Queensland",
        "sa":"South Australia",
        "tas":"Tasmania",
        "vic":"Victoria",
        "wa":"Western Australia"
    }
}

Data fields:

2 By Region

Description: This call returns a list of all the current active warnings. If a region is provided only the current warnings for that region are returned. If no region is specified all current warnings across all the regions are returned.

API Call:

GET /countries/{countryCode}/severeWeather/warnings?region=[regionid]&detail={summary|full}

Parameters:

Example 1:

This example would return a summary of all the current warnings for all regions.

GET /countries/au/severeWeather/warnings

API Response:

{
    "issue-time":"2017-02-22T00:27:02Z",
    "response":[
        "IDQ20885",
        "IDV22000",
        "IDQ20875",
        "IDD20520",
        "IDT20100",
        "IDN22000",
        "IDN65068",
        "IDQ20870",
        "IDD20585",
        "IDD20545",
        "IDS20095",
        "IDN20400",
        "IDQ20890",
        "IDW39885",
        "IDS20290",
        "IDW20100",
        "IDS20201",
        "IDW39730",
        "IDV20600"
    ]
}

Data fields:

Example 2:

This example would return details of all the current warnings for all regions.

GET /countries/au/severeWeather/warnings?detail=full

API Response:

{
    "path":"/detailed/list/*",
    "issue-time":"2018-02-11T20:34:24Z",
    "response":[
        {
            "identifier":"IDW20100",
            "warning-data":{
                "warning-issuer":"Western Australia",
                "warning-timestamp":"2018-02-11T07:00:00Z",
                "warning-title":"Marine Wind Warning Summary for Western Australia",
                "warningcontent":"IDW20100\nAustralian Government Bureau of Meteorology\nWestern Australia\n\nMarine Wind Warning Summary for Western Australia\nIssued at 4:00 am WST on Monday 12 February 2018\nfor the period until midnight WST Tuesday 13 February 2018.\n\nWind Warnings for Monday 12 February\nStrong Wind Warning for the following areas:\nPerth Local Waters, Perth Coast and Bunbury Geographe Coast\\n\nWind Warnings for Tuesday 13 February\nStrong Wind Warning for the following areas:\nPerth Local Waters, Ningaloo Coast, Gascoyne Coast, Geraldton Coast, Perth\nCoast, Bunbury Geographe Coast, Albany Coast, Esperance Coast and Eucla Coast\n\nThe next marine wind warning summary will be issued by 4:00 pm WST Monday.\n\n

================================================================================\n
Check the latest Coastal Waters Forecast or Local Waters Forecast for\ninformation on wind, wave and weather conditions for these coastal zones.\n
================================================================================\n\n"
            }
        },
        {
            "identifier":"IDS20201",
            "warning-data":{
                "warning-issuer":"South Australia",
                "warning-timestamp":"2018-02-11T05:40:00Z",
                "warning-title":"Marine Wind Warning Summary for South Australia",
                "warningcontent":"IDS20201\nAustralian Government Bureau of Meteorology\nSouth Australia\n\nMarine Wind Warning Summary for South Australia\nIssued at 5:10 am CDT on Monday 12 February 2018\nfor the period until midnight CDT Tuesday 13 February 2018.\n\nWind Warnings for Tuesday 13 February\nStrong Wind Warning for the following area:\nSouth Central Coast\n\nThe next marine wind warning summary will be issued by 3:50 pm CDT Monday.\n\n

================================================================================\n
Check the latest Coastal Waters Forecast or Local Waters Forecast for\ninformation on wind, wave and weather conditions for these coastal zones.\\n
================================================================================\n\n"
            }
        }
    ]
}

Example 3:

This example would return a summary of all the current warnings of the Western Australia region.

GET /countries/au/severeWeather/warnings?region=wa

API Response:

{
    "issue-time":"2017-02-22T00:27:02Z",
    "response":[
        "IDW39885",
        "IDW20100",
        "IDW39730"
    ]
}

Example 4:

This example would return details of all the current warnings of the New South Wales region.

GET /countries/au/severeWeather/warnings?region=nsw&detail=full

API Response:

{
    "issue-time":"2018-02-01T23:31:22Z",
    "response":[
        {
            "identifier":"IDN20400",
            "warning-data":{
                "warning-issuer":"New South Wales",
                "warning-timestamp":"2018-01-31T10:02:00Z",
                "warning-title":"Marine Wind Warning Summary for New South Wales",
                "warningcontent":"IDN20400\nAustralian Government Bureau of Meteorology\nNew South Wales\n\nMarine Wind Warning Summary for New South
Wales\nIssued at 10:02 am EDT on Thursday 1 February 2018\nfor the period until midnight EDT Thursday 1 February 2018.\n\nWind Warnings for Thursday 1 February\nCancellation for the following areas:\nByron Coast, Coffs Coast and Macquarie Coast\n\nThe next Marine Wind Warning Summary will be issued when required.\n\n

================================================================================\nCheck the latest Coastal Waters Forecast or Local Waters Forecast for\ninformation on wind, wave and weather conditions for these coastal zones.\n
================================================================================\n\n"
            }
        },
        {
            "identifier":"IDN28522",
            "warning-data":{
                "warning-issuer":"New South Wales",
                "warning-timestamp":"2018-02-01T04:26:00Z",
                "warning-title":"Hazardous Surf Warning for New South Wales",
                "warningcontent":"IDN28522\nAustralian Government Bureau of Meteorology\nNew South Wales\n\nHazardous Surf Warning for New South Wales\n
\nIssued at 4:26 am EDT on Friday 2 February 2018\nfor the period until midnight EDT Friday 2 February 2018.\n\nSurf and swell conditions may be hazardous for coastal activities such as rock\nfishing, boating, and swimming early this morning in the following areas.\n\nFriday 2 February\n\nHazardous Surf Warning for: \nByron Coast, Coffs Coast and Macquarie Coast\n\nSafety Advice\nNSW Police Force, Marine Area Command advise that:\n - People should consider staying out of the water and avoid walking near\n surfexposed areas.\n - Rock fishers should avoid coastal rock platforms exposed to the ocean and seek\n a safe location that is sheltered from thesurf.\n - Boaters planning to cross shallow water and ocean bars should consider changing\n or delaying their voyage.\n - Boaters already on the water should carry the appropriate safety equipment and\n wear a lifejacket.\n - Boaters should remember to log on with their local Marine Rescue radio base,\n via VHF Radio or the Marine Rescue APP, and consider their safety management\n plan.\n\nNo further warnings will be issued for this event, but the situation will\ncontinue to be monitored and further warnings issued if necessary.\n\n

================================================================================\n
Check the Coastal Waters Forecast for information on wind, wave
and weather\nconditions for these areas at http://www.bom.gov.au/nsw/ or on marine radio.\n
================================================================================\n"
            }
        }
    ]
}

3 By Warning ID

Description: This call returns the details of a specific warning. Full details about a warning are always returned.

API Call:

GET /countries/{countryCode}/severeWeather/warnings/{warningID}

Parameters:

Example:

This example would return the details for warning IDW39605.

GET /countries/au/severeWeather/warnings/IDW39605

API Response:

This shows the details of a Flood Watch Warning

{
    "issue-time":"2018-02-01T23:25:10Z",
    "response":{
        "identifier":"IDW39605",
        "warning-data":{
            "warning-issuer":"Western Australia",
            "warning-timestamp":"2018-01-31T14:14:00Z",
            "warning-title":"Flood Watch for the Warburton District and Nullarbor District Catchments",
            "warningcontent":"IDW39605\nAustralian Government Bureau of Meteorology, Western Australia\n\nFlood Watch for the Warburton District and Nullarbor District Catchments\n\nIssued at 11:14 am WST on Thursday 1 February 2018\nThe Bureau of Meteorology, Australia \\n\nFlood Watch Number: 8\n\nFlooding may develop in the Warburton District and Nullarbor District\ncatchments due to heavy rainfall associated with a tropical low.\n\nA tropical low over the central Interior will drift slowly southeast on\nThursday and Friday towards the southern interior of WA. \n\nAs the system tracks further to the southeast, rainfall is expected to increase\nin the Warburton District and Nullarbor District catchments. Widespread\nrainfall totals of 20 to 50 mm are expected to 9 am Thursday morning with\nisolated totals of 80 mm possible.\n\nFurther heavy falls are also possible in subsequent days.\n\nHeavy rainfall is expected to cause significant river rises, areas of flooding\nand adversely affect road conditions. Some roads may become impassable and some\ncommunities may become isolated.\n\nCatchments likely to be affected include:\n\n Nullarbor District Rivers \n\n Warburton District Rivers \n\\nThis flood watch is available by dialling 1300 659213. For more information on\nthe Flood Watch Service visit\nhttp://www.bom.gov.au/water/floods/floodWarningServices.shtml\n\nFlood Safety Advice:\nDFES advises people and communities to be aware that flooding is possible and\nbe prepared to relocate equipment and livestock. Watch water levels. Travellers\nneed to be aware that road conditions may be adversely affected and travel\nplans may need to be reconsidered. Do not drive into water of unknown depth and\nvelocity.\n\nCommunity information is available from DFES at www.dfes.wa.gov.au\n\nCurrent river levels are available from Department of Water and Environmental\nRegulation at www.water.wa.gov.au\n\n \n\nNext issue:\nThe next Flood Watch will be issued by 11:00 am WST on Friday 02 February 2018.\n"
        }
    }
}

Data fields:

NOTE: Return warning content is based on warning narrative as supplied directly from the BOM.
Active warnings are subject to constant change and therefore a given warning ID may no longer be current and as such will not be available.

Errors:

If the source of the warning is not available a standard 404 response will be returned.

{
    "Status":"ESB: HTTP Status 404",
    "Summary":"Resource not found for provided parameters, please check that they are correct.",
    "Diagnosis":"Not Found",
    "Info":"No Warnings found for country: 'au' and ID: 'IDD21038'"
}