Skip to main content
GET
/
v1
/
satellite
List projects with satellite data
curl --request GET \
  --url https://vcm-fyi-api.fly.dev/v1/satellite/ \
  --header 'X-API-KEY: <api-key>'
[
  {
    "project_id": "<string>",
    "has_boundary": true,
    "boundary_source": "<string>",
    "area_km2": 123,
    "integrity_score": 123,
    "risk_level": "<string>",
    "risk_trajectory": "<string>",
    "total_loss_ha": 123,
    "total_loss_pct": 123,
    "loss_by_year": {},
    "peak_loss_year": 123,
    "peak_loss_ha": 123,
    "alert_count_12m": 123,
    "alert_area_ha": 123,
    "fire_count_12m": 123,
    "last_updated": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
risk_level
string | null
Pattern: ^(VERY_LOW|LOW|MEDIUM|HIGH)$
​
has_boundary
boolean
default:true
​
limit
integer
default:100
Required range: 1 <= x <= 1000
​
offset
integer
default:0
Required range: x >= 0

Response

List of projects with satellite verification metrics

​
project_id
string
required
​
has_boundary
boolean
required
​
boundary_source
string | null
required
​
area_km2
number | null
required
​
integrity_score
number | null
required
​
risk_level
string | null
required
​
risk_trajectory
string | null
required
​
total_loss_ha
number | null
required
​
total_loss_pct
number | null
required
​
loss_by_year
Loss By Year · object
required
​
peak_loss_year
integer | null
required
​
peak_loss_ha
number | null
required
​
alert_count_12m
integer | null
required
​
alert_area_ha
number | null
required
​
fire_count_12m
integer | null
required
​
last_updated
string<date-time> | null
required