Satellite Data

PreviousParcels NextPlants

Last updated 1 month ago

get

Query parameters

access_keystring · min: 1Required

Obtain a key by calling Parcel or Farm API.

bandsstring · enum | nullableOptional

RGB - Default for all formats.
RAW - Only available for image/tiff format.

Default: RGBPossible values:

contentstring | nullableOptional

evalscript_urlinteger | nullableOptional

heightinteger | nullableOptional

layersstring · min: 1Required

Image of satellite index. All availbale optins on Layer API.

response_formatstring · enum | nullableOptional

image/png - lossless image format for 1 (grayscale) or 3 (RGB) components
image/jpeg - lossy image format for 1 (grayscale) or 3 (RGB) components, without alpha channel.
image/tiff - lossless image format for any number of the components.

Default: image/pngPossible values:

timestring | nullableOptional

If not indicated the latest image will be returned.

widthinteger | nullableOptional

Responses

get

GET /api/wms/?access_key=text&layers=text HTTP/1.1
Host: 
Accept: */*

200

The response will be returned according to the response_format parameter. If the response_format is not provided, the response will be returned as a PNG image.

No content

get

Query parameters

resolution_idintegerOptional

Filter by resolution ID

resolution_namestringOptional

Filter by resolution name

Responses

get

GET /api/layers/ HTTP/1.1
Host: 
Accept: */*

200Success

[
  {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "displayed_name": "text",
    "layer_stats": "text",
    "legend": null,
    "resolution": 1,
    "layer_resolution": "text"
  }
]

Retrieve GeoJSON index data for a parcel on a specific date

get

Fetches GeoJSON representation of a layer's data for a specific parcel and date. This endpoint is useful for retrieving spatial data that can be visualized on maps.

Path parameters

idstringRequired

layer_keystringRequiredPattern: ^[A-Za-z0-9-]+$

Query parameters

datestring · dateRequired

Date for which to retrieve the index data (YYYY-MM-DD).

nbinsintegerOptional

Number of bins for histogram data.

Default: 5

Responses

get

GET /api/parcels/{id}/layers/{layer_key}/json-index/?date=2025-04-27 HTTP/1.1
Host: 
Accept: */*

{
  "status": "text",
  "data": null
}

{
  "status": "text",
  "data": [
    {
      "basicStats": [
        {
          "max": 1,
          "min": 1,
          "mean": 1,
          "stDev": 1
        }
      ],
      "cloud_coverage": "text",
      "date": "text"
    }
  ]
}