Documentation

Blog

Fix6

API Reference

Datasets

Support

Delete Project

APIKeyHeader

HTTPValidationError

Home for your carbon and climate intelligence

Welcome 👋

Quickstart

Datasets overview

Agricultural climate indicators

Global administrative boundaries

Bulk Data Delivery

Example overview page before API endpoints

Authentication

Retrieve a list of all the projects you have registered with Fix6

List Projects

Createa a new project with a provided GeoJSON or file. Accepted file formats are GeoJSON and KML.
You can also pass a GeoJSON file through the body of the request, and that body will be parsed as the GeoJSON file
for your project.

Create Project

Project Details

Available Project 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 Climate Data

Get Summary Metrics

Get a GeoTIFF image with a boolean indication of whether deforestation has occurred since
a baseline year.

The indicator is a boolean outcome with a value of 1 if $p_ ext{deforestation}$ - the probability of deforestation
from our model -- is greater than 0.7.

Deforestation Indicator Image

Get a summary of deforestation in the project area, with the
total area (in hectares) and percentage of area deforested since 2018.

Data are reported yearly, and the current year's values are based on the
observed deforestation, if any, to the current date.

Deforestation Summary

Get a deforestation summary across all your projects.

Get the hectares and percentage of deforestation throughout your portfolio of projects since 2018.
Optionally, choose a level of aggregation for reporting to view the deforested area and percentage
at the level of a country or state/territory.

Deforestation Summary All Projects

Return baseline sequestration data for a project

Baseline sequestration represents the amount of carbon that would be sequestered if the project did not exist.
Meaning that in an area that is absent of existing tree and shrubland, the baseline will be 0.

Optionally, you can specify a `start_date` and an `end_date` to extract a subset of the data. If no dates are
specified, the entire dataset will be returned.

Baseline Sequestration

Performance Benchmark

Ghg Emissions

Carbon Additionality

Retrieve observed weather data over the project carea for a given period.

The `period` can take the following values, with a default of `daily`: ['daily', 'weekly', 'monthly', 'yearly'].

The `start_date` defaults to a year before the current date. The earliest `start_date` is is ten years before the current date. However you can request more data be made
available for your project, back to 1980. To do so please reach us at `api@fix6.io`.
The latest `end_date` is usually seven days before the current date, but is subject to publishing of reanalysis data.

If your start and/or end dates fall within a time period, the data will only be aggregated to the start and/or end date.
Meaning, aggregation will be incomplete for montly data if your start date.

Periods are queried based on the local time. So aggregation begins at midnight local time for the project area.

Get Weather Data

Get remote sensing indices as the project. Returns as a MapboxImage object, for integration with
the Mapbox API. Includes the URL to the image and the coordinates of the bounding box.

You can provide a `start_date` and `end_date` in ISO format (`yyyy-mm-dd`) to aggregate the index over a date range.
If a `start_date` is supplied, the index will be aggregated over the specified date range.
If no `start_date` is supplied, it will return the most recent image.

API Documentation

Projects

Climate risk

Deforestation

Carbon

Other

Utilities

Delete Project

Authorizations

Path Parameters

Response