Using the Direct API

The Floodlight API can be called directly for certain data sets. It is called using GET or POST requests and supports both http and https connections.

API Parameters for Usage

The API supports the parameters below:

METRIC, LOCATION, MONTH, YEAR, DAY

These are used in the API as such: /api/v1/{METRIC}/{LOCATION}/{YEAR}/{MONTH}/{DAY}?key={YOUR KEY HERE}

Basic Example Usage:

api.floodlightinvest.com/api/v1/risk_measure/0001/2022/01?key={YOUR KEY HERE}

Detailed Access:

Possible Values for METRIC:

• risk_measure

• biomass

• tree_presence

• scope_1_emissions

• scope_2_emissions

• total_emissions

• hazards (filtered based on API key permissions)

• current_conditions

• biodiversity

Possible Values for LOCATION:

• geographic_coordinates (latitude, longitude)

• country_code (ISO 3166-1 alpha-2 or alpha-3)

• region (specified by the region's common name)

• city (specified by the city's common name)

• postal_code (zipcode or equivalent system globally)

• site_id (unique identifier for properties within the system)

Possible Values for YEAR:

• current_year (the ongoing calendar year)

• last_year (the immediate past calendar year)

• A specific year (e.g., 2022, 2021, 2020)

Possible Values for MONTH (optional):

• current_month

• last_month

• 01 (January)

• 02 (February)

• 03 (March)

• 04 (April)

• 05 (May)

• 06 (June)

• 07 (July)

• 08 (August)

• 09 (September)

• 10 (October)

• 11 (November)

• 12 (December)

Possible Values for DAY (optional):

• 01 through 31 representing the day of the month.

• current_day (today's date)

• yesterday (yesterday's date)