Satelligence API (v1)

The satelligence API provides 4 capabilities to synchronize data to and from the platform:

  1. Bulk uploads new!

A full fledged set of endpoints to manage supply chain data in the platform. Use this endpoint to set up automated data synchronization of supply chain data to the Satelligence platform and fully leverage the risk assessment and mitigation features inside the platform.

  1. Plot downloads new!

An endpoint that can serve to sync plot data from the platform into your own systems. It can serve both plot metadata, geometries, and risk assessments from the platform.

  1. Get Risk Info

A lightweight endpoint to access geospatial risk information for a given boundary without uploading supply chain data to the platform. Use this endpoint to leverage the Satelligence geospatial data but build your own risk assessment and mitigation strategies outside of the Satelligence platform.

  1. Detections export

To fetch all deforestation and fire detections in shapefile format. Use this endpoint to gather the raw Satelligence real time data and build your own archive of detections for fully custom workflows.

Authentication

Authentication requires an API token, contact support@satelligence.com to request one. To authenticate your requests, set the Authorization: Bearer $token header in your requests.

The token is connected to a personal account, it will have the same permissions as the account that created it. If the linked user belongs to multiple projects, the token will default to the 'active project' for that user.

Languages
Servers
Mock server

https://docs.satelligence.com/_mock/api/

Production server

https://api.satelligence.com/

Bulk Uploads - New!

These endpoints give full control over supply chain data uploads and ingestion.

For a bulk upload, plots must be formatted as a GeoJSON file and uploaded to a secure location in Satelligence's Google Cloud Storage bucket through a signed URL. The complete process consists of three steps:

  1. Create a bulk upload with the POST /bulk-uploads endpoint, which generates signed URLs for each file you want to upload.
  2. Use the signed URLs to upload the files to the required place for this upload.
  3. Start the bulk upload with the POST /bulk-uploads/start endpoint.

The process can be automated with the scripts linked here.

Operations

Plots - New!

Operations

Risk Information

Operations

Get risk information

Request

Returns computed risk factors for a given geographic area, including deforestation history, remaining forest coverage, and overlap with protected/indigenous territories. The area must be within monitoring regions and meet size constraints.

Security
bearerAuth
Bodyapplication/jsonrequired
geometryobjectrequired

GeoJSON polygon with following constraints:

  • Not self-intersecting
  • Within monitoring region
  • Maximum 40 coordinates
  • Area between 0.1 and 100,000 ha
projectIdstring

Project ID (optional, defaults to user's 'active project')

import requests

url = "https://docs.satelligence.com/_mock/api/get-risk-info"

payload = {
  "geometry": {},
  "projectId": "string"
}

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <YOUR_TOKEN_HERE>"
}

response = requests.post(url, json=payload, headers=headers)

data = response.json()
print(data)

Responses

Successful risk assessment

Bodyapplication/json
riskInfoobject
Response
application/json
{
  "riskInfo": {
    "totalSizeHa": 10.4,
    "yearToMonthToDeforestationHa": { … },
    "remainingForestHa": 5.4,
    "protectedAreasHa": 1.2,
    "indigenousTerritoriesHa": 6.7
  }
}

Detections Export

Operations

Projects

These endpoints provide access to project information, useful for organizations with multiple projects.

Operations