Hazard APIs

To perform a Inundation calculation the request must be in this format: 
 GET /v1/aep/inundation
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=sea_level_rise&lat=-38.356731&lon=144.924568. Partial names are OK.
endYear:
This param set the last year for the statistical projection.
height:
This param set the height (asset height + ground height) for the input asset.
location (lat, lon):
This params set the location (in latitude and longitude) for the asset.
waves:
This param set the waves for the calculation (by default the waves are enable). This parameter accept on, off or the station id.
waveSetup:
This param set the wave setup parameter.

Request example:

/v1/aep/inundation?profile=Haigh-et-al-2014&endYear=2100&height=2.8&lat=-38.356731&lon=144.924568&waves=off&waveSetup=15.0
To perform a riverine flood AEP calculation the request must be in this format: 
GET /v1/aep/flood_riverine
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=flood&lat=-38.356731&lon=144.924568. Partial names are OK.
organisation:
The data collection from which to get context layer data.
height:
This param set the height for the input asset.
startYear:
This param set the first year for the statistical projection.
endYear:
This param set the last year for the statistical projection.
location (lat, lon):
This params set the location (in latitude and longitude) for the asset.
station:
This param set the id of the closest station for the asset.
elevations:
This replace the elevations reported by the riverine flood layers, use | (pipe) or , (comma) to pass multiple values. Also usable if the flood layers do not cover the passed location.
model:
The precipitation model to use (default is model=precip):
  • model=precip for using projected climate model precipitation
  • model=temp-scaling for scaling observed precipitation by projected temperature changes
radius_km (only used when model=temp-scaling):
An area average of radius_km to use for determining projected temperature changes. Default is to only use the grid cell of the provided lat/lon.
probabilities:
This param will set the probabilities for the passed elevations, use | (pipe) or , (comma) to pass multiple values.
use_defended_areas:
(boolean) whether to use defended areas in the flood calculation.

Request example:

/v1/aep/flood_riverine?profile=AUTO&organisation=public&startYear=2019&endYear=2100&height=2.8&lat=-37.84&lon=145.78
To perform a surface water flood calculation the request must be in this format: 
GET /v1/aep/flood_surfacewater
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=flood&lat=-38.356731&lon=144.924568. Partial names are OK.
organisation:
The data collection from which to get context layer data.
height:
This param set the height for the input asset.
startYear:
This param set the first year for the statistical projection.
endYear:
This param set the last year for the statistical projection.
location (lat, lon):
This params set the location (in latitude and longitude) for the asset.
station:
This param set the id of the closest station for the asset.
elevations:
This replace the elevations reported by the riverine flood layers, use | (pipe) or , (comma) to pass multiple values. Also usable if the flood layers do not cover the passed location.
model:
The precipitation model to use (default is model=precip):
  • model=precip for using projected climate model precipitation
  • model=temp-scaling for scaling observed precipitation by projected temperature changes
radius_km (only used when model=temp-scaling):
An area average of radius_km to use for determining projected temperature changes. Default is to only use the grid cell of the provided lat/lon.
probabilities:
This param will set the probabilities for the passed elevations, use | (pipe) or , (comma) to pass multiple values.
use_defended_areas:
(boolean) whether to use defended areas in the flood calculation.

Request example:

/v1/aep/flood_surfacewater?profile=AUTO&organisation=public&startYear=2019&endYear=2100&height=2.8&lat=-37.84&lon=145.78
To perform a heat calculation the request must be in this format: 
 GET /v1/aep/heat
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=heat&lat=-38.356731&lon=144.924568. Partial names are OK.
endYear:
This argument sets the last year for the statistical projection.
temperature:
This argument sets the failure temperature thresholds for the asset.
return_frequency:
This argument sets return_frequency based thresholds.
location (lat, lon):
This argument sets the location (in latitude and longitude) for the asset.
station:
This argument sets the id of the closest station for the asset.

Request example:

/v1/aep/heat?profile=AUTO&endYear=2100&temperature=42.0&lat=-37.84&lon=145.78 /v1/aep/heat?profile=AUTO&endYear=2100&return_frequency=0.01&lat=-37.84&lon=145.78
To perform a soil movement calculation the request must be in this format: 
 GET /v1/aep/soil_movement
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=drought&lat=-38.356731&lon=144.924568. Partial names are OK.
endYear:
This param set the last year for the statistical projection.
location (lat, lon):
This params set the location (in latitude and longitude) for the asset.
station:
This param set the id of the closest station for the asset.

Request example:

/v1/aep/soil_movement?profile=AUTO&endYear=2100&lat=-36.371&lon=143.153
To perform a forest fire calculation the request must be in this format: 
GET /v1/aep/forest_fire
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=forest_fire&lat=-38.356731&lon=144.924568. Partial names are OK.
organisation:
Data collection from which to get the context layers.
endYear:
Last year for the statistical projection.
location (lat, lon):
The location (in latitude and longitude) for the asset.
station:
This param set the id of the closest station for the asset.

Request example:

/v1/aep/forest_fire?profile=AUTO&organisation=public&endYear=2100&lat=-38.356731&lon=144.924568
To perform a wind calculation the request must be in this format: 
 GET /v1/aep/wind
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=wind&lat=-38.356731&lon=144.924568. Partial names are OK.
endYear:
This param set the last year for the statistical projection.
buildYear:
This param set the build year for the asset.
location (lat, lon):
This params set the location (in latitude and longitude) for the asset.

Request example:

/v1/aep/wind?buildYear=1970&lat=-31.231&lon=138.101
Endpoint for freeze thaw calculation: 
GET /v1/aep/freezeThaw
profile:
Which climate simulation to use for the AEP calculations. A list of all available simulations for a location is available at e.g. https://ana.climaterisk.com.au/v1/available_data/hazard?hazard=freeze-thaw&lat=-38.356731&lon=144.924568. Partial names are OK.
endYear:
This parameter sets the last year for the statistical projection.
location (lat, lon):
This parameter sets the location (in latitude and longitude) for the asset.
station:
This parameter sets the id of the closest station for the asset.

Request example:

/v1/aep/freezeThaw?endYear=2100&lat=-38.356731&lon=144.924568
The cyclone_wind api uses sea surface temperature to predict wind speeds for cyclone events. Land distance from coast and historical cyclone frequency are also taken into account.
Available Data
Cyclone relevant data can be viewed at:
API
 GET /v1/aep/cyclone_wind
profile:
Which simulation data to use for the calculations. Partial names are OK.
years
Comma seperated list of years to query results. e.g. years=2020,2050,2080,2100
location (lat, lon)
The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
out_value (default=aeps)
Type of output, either
  • out_value=aeps for annual exceedance probability
  • out_value=severities for wind speed (m/s) severities
wind_speed (default=70)
Comma seperated list of wind speed thresholds (m/s) for which to query aeps. e.g. wind_speed=30,50,70
return_frequency (default derived from default wind_speed)
Comma seperated list of return frequencies (between 0 and 1) for which to query wind speed severity (m/s). e.g. return_frequency=0.1,0.05,0.01

Request example:

/v1/aep/cyclone_wind?years=2020,2050,2080,2100&lat=-17.505098&lon=146.064919&wind_speed=30,70&out_value=severities
The convective_wind api uses a combination of convective available potential energy (CAPE) and wind shear between the surface and 6 km (S06) to predict wind speeds from convective storms. Historical occurrence of severe convective environments and regular convective environments are taken into account to determine regions most susceptible to severe convection.
Available Data
Convective wind relevant data can be viewed at:
API
 GET /v1/aep/convective_wind
profile:
Which simulation data to use for the calculations. Partial names are OK.
years
Comma seperated list of years to query results. e.g. years=2020,2050,2080,2100
location (lat, lon)
The location (in latitude and longitude) of the asset. e.g. lat=-21.59026997&lon=138.28616316
out_value (default=aeps)
Type of output, either
  • out_value=aeps for annual exceedance probability
  • out_value=severities for wind speed (km/hr) severities
wind_speed (default=90)
Comma seperated list of wind speed thresholds (m/s) for which to query aeps. e.g. wind_speed=90, 120, 180
return_frequency (default derived from default wind_speed)
Comma seperated list of return frequencies (between 0 and 1) for which to query wind speed severity (km/hr). e.g. return_frequency=0.1,0.05,0.01

Request example:

/v1/aep/convective_wind?years=2020,2050,2080,2100&lat=-21.59026997&lon=138.28616316&return_frequencies=0.1,0.05,0.01&out_value=severities
The subannual_inundation api uses a combination of daily max data from tidal guages and sea level rise to predict the expected number of days of inundation
Available Data
  • the tidal guage distributions information and guage name / location
    • API
     GET /v1/exceedances/inundation
    profile:
    Which simulation data to use for the calculations. Partial names are OK.
    years
    Comma seperated list of years to query results. e.g. years=2020,2050,2080,2100
    location (lat, lon)
    The location (in latitude and longitude) of the asset. e.g. lat=-21.59026997&lon=138.28616316
    elevation
    The heights above mean sea level in meters (can be list of floats)
    days_inundated
    The number of days inundated (used for aeps and severities, is a list)
    distance_to_coast
    Boolean flag to return distance to coast, useful for QA
    out_value (default=aeps)
    Type of output, either
    • out_value=days for expected number of days inundated at a given height
    • out_value=severities for the min height for a given number of days inundated
    ,

    Request example (days):

    /v1/exceedances/inundation?years=1990,2020,2050,2080&lat=-17.505098&lon=146.064919&elevation=2.253&out_value=days

    Request example (severities):

    /v1/exceedances/inundation?years=1990,2020,2050,2080&lat=-17.505098&lon=146.064919&days_inundated=12,20,59&out_value=severities
    The Precipitation API returns annual maximum daily rainfall using either projected precipitation from a climate model or observed precipitation that is scaled by projected temperature change from a climate model.
    API
     GET /v1/aep/precipitation
    profile:
    Which simulation data to use for the calculations. Partial names are OK. Some simulations that you may want to use when model=temp-scaling:
    • profile=NRMmean to use NRM mean temperatures (only implemented for Australia).
    • profile=global_mean to use global mean temperatures.
    • profile=zonal_mean to use zonal mean temperatures (based on a moving window of 15 degrees of latitude).
    startYear:
    This param set the first year for the statistical projection.
    endYear:
    This param set the last year for the statistical projection.
    location (lat, lon):
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=aeps):
    Type of output, either:
    • out_value=aeps for annual exceedance probability
    • out_value=severities for precipitation (mm/day) severities
    model:
    The precipitation model to use (default is model=precip):
    • model=precip for using projected climate model precipitation
    • model=temp-scaling for scaling observed precipitation by projected temperature changes
    radius_km (only used when model=temp-scaling):
    An area average of radius_km to use for determining projected temperature changes. Default is to only use the grid cell of the provided lat/lon.
    precipitation:
    Comma seperated list of precipitation intensities (mm/day) for which to query aeps. e.g. precipitation=90,95,100
    return_frequency (default derived from default precipitation):
    Comma seperated list of return frequencies (between 0 and 1) for which to query precipitation severity (mm/day). e.g. return_frequency=0.1,0.05,0.01

    Request example:

    /v1/aep/precipitation?profile=AUTO&organisation=public&startYear=2019&endYear=2099&precipitation=300&lat=-21.59027&lon=138.286163&model=temp-scaling
    The sub-annual heat API returns annual exceedances of a given daily maximum temperature threshold. For example, the number of days above 35 degrees.
    API
     GET /v1/exceedances/heat
    profile:
    Which simulation data to use for the calculations. Partial names are OK.
    startYear:
    This parameter sets the first year for the projection.
    endYear:
    This parameter sets the last year for the projection.
    location (lat, lon):
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=days):
    Type of output, either:
    • out_value=days to return the number of days each year above the specified temperature(s). Values are smoothed the reflect climatology.
    • out_value=raw_values to return the number of days each year above the specified temperature(s), without smoothing. This reflects the inter-annual variability.
    temperature:
    The temperature threshold(s) of interest, in degrees Celsius. e.g. temperature=35,40 will return the number of days above these two temperatures.

    Request example:

    /v1/exceedances/heat?organisation=public&profile=AUTO&endYear=2099&lat=-21.6081&lon=138.3168&temperature=35,40
    The sub-annual rainfall API returns the annual exceedances of a given daily rainfall threshold. For example, the number of days above 30 millimetres.
    API
     GET /v1/exceedances/rain
    profile:
    Which simulation data to use for the calculations. Partial names are OK.
    startYear:
    This parameter sets the first year for the projection.
    endYear:
    This parameter sets the last year for the projection.
    location (lat, lon):
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=days):
    Type of output, either:
    • out_value=days to return the number of days each year above the specified rainfall amount(s). Values are smoothed the reflect climatology.
    • out_value=raw_values to return the number of days each year above the specified rainfall amount(s), without smoothing. This reflects the inter-annual variability.
    rain:
    The rainfall threshold(s) of interest in millimetres. e.g. rain=30,40 will return the number of days above these two rainfall amounts.

    Request example:

    /v1/exceedances/rain?organisation=public&profile=AUTO&endYear=2099&lat=-21.6081&lon=138.3168&rain=30,40
    The drought SPEI/SPI API returns projections based on the Standardised Precipitation Index (SPI) and Standardised Precipitation-Evapotranspiration Index (SPEI).
    API
     GET /v1/drought_spei
    profile:
    Which simulation data to use for the calculations. Partial names are OK.
    startYear:
    This parameter sets the first year for the projection.
    endYear:
    This parameter sets the last year for the projection.
    location (lat, lon):
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=aneps):
    Type of output, options are:
    • out_value=aneps to return the annual non-exceedance probability (ANEP). This reflects the annual probability of projected water balances being below the provided threshold(s). Values are smoothed the reflect climatology. Also accepts 'aeps' for backward compatibility with other hazards, even though this is not the correct term for this hazard.
    • out_value=severities to return SPEI/SPI values converted to water balance (either precipitation for the SPI or precipitation-evapotranspiration for the SPEI, expressed, both in mm). This can be interpreted as the future mm corresponding to the provided threshold(s).
    • out_value=severities_spei to return the SPEI/SPI values. These values reflect the number of standard deviations above or below the historical median that the provided threshold(s) will be in the future.
    • out_value=historical_aneps for the annual non-exceedance probabilities (ANEP) of the projected threshold(s) occurring in the historical baseline climate.
    • out_value=raw_values for the raw SPEI/SPI values that are read in from the gridded climate model files. Not transformed by any provided thresholds.
    • out_value=raw_values_smoothed for the raw SPEI/SPI values that are read in from the gridded climate model files, smoothed to reflect climatological means. Not transformed by any provided thresholds.
    method (default=spei12):
    Whether the SPEI or SPI should be calculated, as well as the month-scale to use. Available options are: spei12, spei6, spei3, spi12, spi6 and spi3.
    calendar_month (default=12):
    An integer between 1 and 12 indicating the calendar month (January to December) that the drought period of interest ends on. For example, calendar_month=6 with method=spei3 indicates that the 3-month SPEI for April-May-June will be used.
    return_frequency (default=0.01):
    Comma seperated list of return frequencies (between 0 and 1) to use for calculating projected AEP's or severities. e.g. return_frequency=0.1,0.05,0.01
    standard_deviations (default=None):
    Threshold number standard deviation(s) to use for calculating projected projected AEP's or severities. e.g. standard_deviations=-1,-1.5

    Request example:

    /v1/drought_spei?profile=AUTO&startYear=1951&endYear=2100&organisation=public&lat=-21.59026997&lon=138.28616316&method=spei6&out_value=severities&return_frequency=0.01,0.05
    The landslip api uses susceptibility map and the rainfall data to forecast the landslide probablity at a give location.
    Available Data
    Landslip relevant data can be viewed at:
    API
     GET /v1/aep/landslip
    profile:
    LHASA model
    years
    Comma seperated list of years to query results. e.g. years=2020,2050,2080,2100
    location (lat, lon)
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=aeps)
    Type of output (only annual exceedance probability is available for landslip):
    • out_value=aeps for annual exceedance probability

    Request example:

    /v1/aep/landslip?years=2020,2050,2080,2100&lat=-21.505098&lon=138.064919&forecast_speed=30,70&out_value=severities
    The cyclone_storm_surge api uses the cyclone wind model to predict storm surge height for cyclone events. Ocean depth is taken into account.
    Available Data
    Cyclone storm surge relevant data can be viewed at:
    API
     GET /v1/aep/cyclone_storm_surge
    profile:
    Which simulation data to use for the calculations. Partial names are OK.
    years
    Comma seperated list of years to query results. e.g. years=2020,2050,2080,2100
    location (lat, lon)
    The location (in latitude and longitude) of the asset. e.g. lat=-38.356731&lon=144.924568
    out_value (default=aeps)
    Type of output, either
    • out_value=aeps for annual exceedance probability
    • out_value=severities for surge height (m) severities
    surge_height (default=0)
    Comma seperated list of surge height thresholds (m), relative to MSL, for which to query aeps. e.g. surge_height=1,2.5,5. This allows an understanding of the change in various surge heights for a given asset's total elevation, rather than the change relative to the asset's floor height only.
    return_frequency (default derived from default surge_height)
    Comma seperated list of return frequencies (between 0 and 1) for which to query surge height severity (m). e.g. return_frequency=0.1,0.05,0.01
    elevation (default=None)
    Elevation of the ground above mean sea level (m) to be accounted for in storm surge calculation, e.g. elevation=2. This must be provided to the model.
    height_above_ground (default=None)
    Asset floor height above the ground (m) to be accounted for in storm surge calculation, e.g. height_above_ground=0.5. This must be provided to the model.
    tide (default=True)
    Boolean, whether to include tide in the storm surge results or not. Provided results are the "storm tide", which is storm surge (calculated using wind speeds from the tropical cyclone wind model), plus the maximum tide height for the provided (or associated) return frequency. If a surge_height is provided, then it is considered the storm surge height, not the storm tide height, e.g. tide=True
    tide_type (default=max)
    String, whether to consider the average of annual maximum tide height (default) or average of annual minimum tide height (tide_type=min) in the results.

    Request example:

    /v1/aep/cyclone_storm_surge?years=2020,2050,2080,2100&lat=-17.505098&lon=146.064919&surge_height=2&elevation=2&height_above_ground=0.5&out_value=severities&tide=True