Skip to content

Quickstart

You can register a free account by signing up on the Epoch platform to get access to the API. The first free 100 plots are on us!

Once you are logged in, the fastest way to testing the APIs on your plot data is to upload a geojson under the "Test APIs" tab in the dashboard.

Upload Geojson File

  1. Click on the "Test APIs" tab in the dashboard, and select the endpoints you want to test:

account_page_token_retrieval.png

You can select either the deforestation endpoint or the biomass emissions endpoint. The deforestation endpoint will return the deforestation risk and EUDR compliance status for the plot for the time period provided, while the biomass emissions endpoint will return the annual biomass stock for the plot for the time period provided.

  1. Upload a geojson file with the plot geometries you want to test the API on:

deforestation_endpoint_test.png

  1. Wait for the results to populate the accordeon menu:

deforestation_endpoint_results.png

You can do the same for the biomass emissions endpoint:

biomass_emissions_endpoint_test.png

Draw Polygon on Map

If you don't have a geojson file, you can also draw a polygon on the map:

  1. Start clicking in the map viewport where you want your polygon vertices to be located

  2. Select the cut-off date and other parameters in the form, and click on Check to run the API with the drawn polygon

draw on map

  1. Wait for the results to pop up in the bottom menu (it may take anywhere from a few seconds to minute depending on size of plots)

DISCLAIMER: Keep the window open while the API is running, as the results will be displayed in the same window. If you change window you will lose the results and will have to run the API again.