API Reference

Calculate climate change

post
https://{host}/platform/riskdata/v1/analyses//climate-change
Headers
uuid
required
Defaults to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ID of resource group. To learn more, see Resource Groups

Path Params
int64
required
≥ 1

ID of reference analysis.

Reference analysis must be modeled using a model that supports climate change analysis. For a complete list, see Climate Change Model Requirements in Support Center.

Body Params
string
enum
required

Type of scenario to use in analysis.

  • If rcp, rcpScenario is required.
  • If ssp, sspScenario is required.

Use scenario that is applicable to the model used in reference analysis

Allowed:
string

Name of climate change analysis. Can be alphanumeric string.

string
enum
required

View depends on the base model used in reference analysis.

  • NAHU reference analyses support Combined - All Parameters or Frequency and Intensity Only
  • All other models support Default only.

To learn more see North Atlantic Hurricane Climate Change Models in Support Center.

Allowed:
int32
enum
required

ID of event rate scheme conditioned for climate change.

IDModelCodeEngine
1RMS 2011 Historical Event RatesUSFLHD
4RMS 2019 Historical Event RatesUSFLHD
6RMS v1.0 Default Rates (US)NAWFHD
7RMS v1.0 Default Rates (US+CA)NAWFHD
9RMS v2.0 Default RatesEUFLHD
14RMS v2.0 Stoch (Typhoon and Non-typhoon)JPWSHD
15RMS v2.0 Stoch (Typhoon)JPWSHD
16RMS v2.0 Stoch (Non-typhoon)JPWSHD
17RMS v1.0 Default RatesNZFLHD
18RMS 2011 Historical Rates (TC)USFLHD
19RMS 2019 Historical Rates (TC)USFLHD
21RMS 2021 Historical Event RatesUSFLHD
23RMS 2021 Historical Event Rates (TC)USFLHD
26RMS HDv1.0 Stoch Event Set (Default)EUWSHD
27RMS HDv1.0 Stoch Event Set (Unclustered)EUWSHD
35RMS 2023 Historical Event RatesUSFLHD
37RMS 2023 Historical Event Rates (TC)USFLHD
39RMS 2011 Historical Event Rates (Non-TC)USFLHD
40RMS 2023 Historical Event Rates (Non-TC)USFLHD
65RMS 2025 Historical Event RatesUSFLHD
66RMS 2025 Historical Event Rates (TC)USFLHD
67RMS 2025 Historical Event Rates (Non-TC)USFLHD
84RMS 2015 Stochastic Event RatesEUWSDLM
190RMS 2019 Historical Event RatesNAHUDLM
202RMS 2021 Historical Event RatesNAHUDLM
577RMS 2023 Historical Event RatesNAHUDLM
738RMS 2025 Historical Event RatesNAHUDLM
double
enum
required

RCP scenario. One of 2.6, 4.5, 6.0, or 8.5.

  • 2.6: A pathway where radiative forcing peaks at approximately 3 W m-2 before 2100 and then declines to 2.6 W m-2.
  • 4.5: An intermediate stabilization pathway in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.
  • 6.0: An intermediate stabilization pathways in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.
  • 8.5: A high pathway for which radiative forcing reaches greater than 8.5 W m-2 by 2100 and continues to rise for some amount of time.
Allowed:
int32
required

Snapshot year to include in RCP scenario-based analysis. A single five-year interval between 2020 and 2100, e.g. one of 2020, 2025, 2030, etc.

boolean

Indicates whether the climate change analysis includes RCP scenarios. If no rcpScenario or timeHorizon values are specified, set to false.

Responses

Updated about 6 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
*/*
application/json

Updated about 6 hours ago

Did this page help you?