Skip to content

Satelligence API (v1)

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

  1. Bulk uploads

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

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. Jurisdictions new!

Access jurisdiction-level deforestation risk assessments for administrative regions worldwide. Filter by country, risk level, and regulatory framework cutoff date (EUDR, RSPO, etc.) to get pre-computed values and risk information.

  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.

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

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

Operations

Risk Information

Operations

Projects

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

Operations

Jurisdictions - New!

These endpoints provide access to jurisdiction-level deforestation risk assessments. Jurisdictions are administrative regions for which risk assessments were pre-computed for different regulatory frameworks. For more information, visit the Resource Center page on Jurisdictions.

Operations

Get jurisdictions

Request

Retrieves a paginated list of jurisdictions matching the specified filters. Jurisdictions are administrative regions with pre-computed deforestation risk assessments.

Use this endpoint to:

  • Find jurisdictions by country and risk level
  • Filter by presence of risk factors (remaining forest, protected areas, indigenous territories)
  • Get jurisdiction-level deforestation data for a specific regulatory framework

Results are paginated with 100 jurisdictions per page. Use the nextUrl in the response to fetch subsequent pages.

Security
bearerAuth
Query
frameworkstringrequired

The regulatory framework cutoff date to use for risk assessment

Enum"NPDE""CFI""RSPO""EUDR""Fairtrade"
riskLevelstring

Comma-separated list of risk levels to filter by (maximum 3). Values are none, low, medium, high.

Example: riskLevel=low,medium,high
countrystring

Comma-separated list of ISO 3166-1 alpha-2 country codes to filter by (maximum 5)

Example: country=BR,ID,CO
hasRemainingForestboolean

Filter for jurisdictions with remaining forest presence

hasProtectedAreasboolean

Filter for jurisdictions with protected areas presence

hasIndigenousTerritoriesboolean

Filter for jurisdictions with indigenous territories presence

cursorstring

Pagination cursor for fetching subsequent pages of results

import requests

url = "https://docs.satelligence.com/_mock/api/v1/jurisdictions"

query = {
  "framework": "NPDE",
  "riskLevel": "low,medium,high",
  "country": "BR,ID,CO",
  "hasRemainingForest": "true",
  "hasProtectedAreas": "true",
  "hasIndigenousTerritories": "true",
  "cursor": "string"
}

headers = {"Authorization": "Bearer <YOUR_TOKEN_HERE>"}

response = requests.get(url, headers=headers, params=query)

data = response.json()
print(data)

Responses

Successful response with jurisdiction list

Bodyapplication/json
countinteger

Number of jurisdictions in the current page

Example: 100
nextUrlstring or null

URL to fetch the next page of results, null if no more results

resultsArray of objects
Response
application/json
{
  "count": 100,
  "nextUrl": "string",
  "results": [
    { … }
  ]
}

Get jurisdiction by ID

Request

Retrieves detailed information about a specific jurisdiction by its ID. Returns jurisdiction metadata, boundaries, and risk assessment data for the specified framework.

Security
bearerAuth
Path
idstringrequired

The Satelligence jurisdiction ID

Query
frameworkstringrequired

The regulatory framework cutoff date to use for risk assessment

Enum"NPDE""CFI""RSPO""EUDR""Fairtrade"
import requests

id = "YOUR_id_PARAMETER"
url = "https://docs.satelligence.com/_mock/api/v1/jurisdictions/" + id

query = {
  "framework": "NPDE"
}

headers = {"Authorization": "Bearer <YOUR_TOKEN_HERE>"}

response = requests.get(url, headers=headers, params=query)

data = response.json()
print(data)

Responses

Successful response with jurisdiction data

Bodyapplication/json
idstring

Internal Satelligence identifier for the jurisdiction

namestring

Display name of the jurisdiction

Example: "Acre"
administrationLevelinteger

GADM administration level (0=country, 1=state/province, 2=district, etc.)

Example: 1
administrationUnitNamestring

Name of the administration unit type at this level

Example: "State"
gadmIdstring

GADM identifier for this jurisdiction

Example: "BRA.1_1"
areaHanumber

Total area of the jurisdiction in hectares

Example: 16493200
countrystring

ISO 3166-1 alpha-2 country code

Example: "BR"
boundingBoxobject
assessmentobject
Response
application/json
{
  "id": "string",
  "name": "Acre",
  "administrationLevel": 1,
  "administrationUnitName": "State",
  "gadmId": "BRA.1_1",
  "areaHa": 16493200,
  "country": "BR",
  "boundingBox": {
    "minLng": 0,
    "minLat": 0,
    "maxLng": 0,
    "maxLat": 0
  },
  "assessment": {
    "assessmentDate": "2024-01-15",
    "framework": "NPDE",
    "riskLevel": "none",
    "deforestation": { … },
    "commodities": { … },
    "riskFactors": { … },
    "monthToLandCoverToDeforestationHa": { … }
  }
}