Climate risk

Get Climate Data

Return climate data for a given project ID. Requires that a project_id be supplied.

The period parameter can be used to define which period to return data for. The default is monthly, but can also be any of weekly, or yearly. If you are interested in custome aggregation periods please contact us (api@fix6.io).

By default, the start_date will be today’s date, and the end_date will be 2099-12-31. These can be changed to any date in the format YYYY-MM-DD between the dates 2015-01-01 and 2100-01-01.

Additionally, the ssp{xxx}_weight parameters can be used to weight the SSP scenarios. The default is ssp126_weight=0.1, ssp245_weight=0.4, ssp370_weight=0.4, and ssp585_weight=0.1. These can be changed to any positive values that sum to 1. This allows the user to weight the scenarios as they see fit, considering that there are differing opinions as to the likelihood of each scenario (e.g., [1][2]).

[1] https://www.nature.com/articles/d41586-020-00177-3

[2] https://www.pnas.org/doi/full/10.1073/pnas.2007117117

GET

projects

{project_id}

climate

{
  "period": "2023-11-07T05:31:56Z",
  "project_id": "<string>",
  "lat": 0,
  "lon": 0,
  "avg_temperature_degC": 123,
  "min_temperature_degC": 123,
  "max_temperature_degC": 123,
  "avg_wind_speed_m_per_s": 123,
  "sum_total_precipitation_mm_of_water_equivalent": 123,
  "avg_relative_humidity_0_1": 123
}

Authorizations

x-api-key

string

header

required

Path Parameters

project_id

string

required

Query Parameters

period

string

default:monthly

start_date

string

default:today

end_date

string

default:2099-12-31

ssp126_weight

number

default:0.1

ssp245_weight

number

default:0.4

ssp370_weight

number

default:0.4

ssp585_weight

number

default:0.1

Response

200

application/json

Climate data for a given project ID.

period

string

required

project_id

string

required

lat

number

required

Required range: -90 <= x <= 90

lon

number

required

Required range: -180 <= x <= 180

avg_temperature_degC

number

required

min_temperature_degC

number

required

max_temperature_degC

number

required

avg_wind_speed_m_per_s

number

required

sum_total_precipitation_mm_of_water_equivalent

number

required

avg_relative_humidity_0_1

number

required

Available Project Data Get Summary Metrics

{
  "period": "2023-11-07T05:31:56Z",
  "project_id": "<string>",
  "lat": 0,
  "lon": 0,
  "avg_temperature_degC": 123,
  "min_temperature_degC": 123,
  "max_temperature_degC": 123,
  "avg_wind_speed_m_per_s": 123,
  "sum_total_precipitation_mm_of_water_equivalent": 123,
  "avg_relative_humidity_0_1": 123
}

API Documentation

Projects

Climate risk

Deforestation

Carbon

Other

Utilities

Get Climate Data

Authorizations

Path Parameters

Query Parameters

Response