Sentinel-1 API Documentation

The Sentinel-1 API allows you to search for, analyze, and retrieve Sentinel-1 radar imagery for your geometries.

Authentication: All API endpoints require an API key to be passed in the X-API-Key header.

Search for Imagery

Endpoint
POST /api/s1/search/
Description

Search for available Sentinel-1 imagery for a geometry within a date range.

Headers
Name Required Description
X-API-Key Yes Your API key in UUID format
Content-Type Yes application/json
Request Body
Parameter Type Required Description
geometry_id UUID Yes UUID of the geometry to search for
start_date string Yes Start date in YYYY-MM-DD format
end_date string Yes End date in YYYY-MM-DD format
polarization string No Polarization mode (VV, VH, HH, HV), default is all
orbit_direction string No Orbit direction (ASCENDING, DESCENDING), default is both
Example Request
{
  "geometry_id": "123e4567-e89b-12d3-a456-426614174000",
  "start_date": "2023-01-01",
  "end_date": "2023-01-31",
  "polarization": "VV",
  "orbit_direction": "ASCENDING"
}
Response

Returns a list of available Sentinel-1 images with date, polarization, and ID.

Example Response (200 OK)
{
  "results": [
    {
      "id": "S1A_IW_GRDH_1SDV_20230105T123456_20230105T123521_046956_05A3E2_5D6C",
      "date": "2023-01-05",
      "polarization": "VV+VH",
      "platform": "Sentinel-1A",
      "orbit_direction": "ASCENDING"
    },
    {
      "id": "S1B_IW_GRDH_1SDV_20230115T123456_20230115T123521_030228_03A1F5_3B8D",
      "date": "2023-01-15",
      "polarization": "VV+VH",
      "platform": "Sentinel-1B",
      "orbit_direction": "ASCENDING"
    }
  ],
  "count": 2
}
Error Responses
Status Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Missing API key
403 Forbidden - Invalid API key
404 Not Found - Geometry not found
500 Internal Server Error

Get Statistics

Endpoint
POST /api/s1/stats/
Description

Get statistics for available Sentinel-1 imagery for a geometry within a date range.

Headers
Name Required Description
X-API-Key Yes Your API key in UUID format
Content-Type Yes application/json
Request Body
Parameter Type Required Description
geometry_id UUID Yes UUID of the geometry to search for
start_date string Yes Start date in YYYY-MM-DD format
end_date string Yes End date in YYYY-MM-DD format
polarization string No Polarization mode (VV, VH, HH, HV), default is all
orbit_direction string No Orbit direction (ASCENDING, DESCENDING), default is both
Example Request
{
  "geometry_id": "123e4567-e89b-12d3-a456-426614174000",
  "start_date": "2023-01-01",
  "end_date": "2023-01-31",
  "polarization": "VV",
  "orbit_direction": "ASCENDING"
}
Response

Returns statistics for available Sentinel-1 images.

Example Response (200 OK)
{
  "total_images": 2,
  "date_range": {
    "start": "2023-01-05",
    "end": "2023-01-15",
    "days": 10
  },
  "platforms": {
    "Sentinel-1A": 1,
    "Sentinel-1B": 1
  },
  "polarizations": {
    "VV+VH": 2
  },
  "orbit_directions": {
    "ASCENDING": 2
  },
  "monthly_distribution": {
    "2023-01": 2
  },
  "results": [
    {
      "id": "S1A_IW_GRDH_1SDV_20230105T123456_20230105T123521_046956_05A3E2_5D6C",
      "date": "2023-01-05",
      "polarization": "VV+VH",
      "platform": "Sentinel-1A",
      "orbit_direction": "ASCENDING",
      "min_value": -25.5,
      "max_value": 5.2,
      "mean_value": -12.3,
      "std_value": 4.5
    },
    {
      "id": "S1B_IW_GRDH_1SDV_20230115T123456_20230115T123521_030228_03A1F5_3B8D",
      "date": "2023-01-15",
      "polarization": "VV+VH",
      "platform": "Sentinel-1B",
      "orbit_direction": "ASCENDING",
      "min_value": -24.8,
      "max_value": 4.9,
      "mean_value": -11.9,
      "std_value": 4.3
    }
  ]
}
Error Responses
Status Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Missing API key
403 Forbidden - Invalid API key
404 Not Found - Geometry not found
500 Internal Server Error

Get Imagery

Endpoint
GET /api/s1/image/{geometry_id}/
Description

Get radar image for a geometry based on item_id and image type.

Path Parameters
Parameter Type Required Description
geometry_id UUID Yes UUID of the geometry
Query Parameters
Parameter Type Required Description
item_id string Yes Item ID of the Sentinel-1 image
image_type string Yes Image format - png, jpeg or tiff
polarization string Yes Polarization to display (VV, VH)
colormap string No Color palette to use for visualization
min_value number No Minimum value for color scaling (dB)
max_value number No Maximum value for color scaling (dB)
Headers
Name Required Description
X-API-Key Yes Your API key in UUID format
Response

Returns the image file in the requested format (PNG, JPEG, or TIFF).

Error Responses
Status Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Missing API key
403 Forbidden - Invalid API key
404 Not Found - Geometry not found
500 Internal Server Error

Get Raw Band Data

Endpoint
GET /api/s1/raw-band/{geometry_id}/
Description

Get raw band data for a geometry from a specific Sentinel-1 image.

Path Parameters
Parameter Type Required Description
geometry_id UUID Yes UUID of the geometry
Query Parameters
Parameter Type Required Description
item_id string Yes Item ID of the Sentinel-1 image
polarization string Yes Polarization (VV, VH)
format string No Output format (json, tiff), default is json
Headers
Name Required Description
X-API-Key Yes Your API key in UUID format
Response

Returns the raw band data in the requested format (JSON or TIFF).

Example JSON Response (200 OK)
{
  "polarization": "VV",
  "values": [-15.23, -14.56, -16.78, ...],
  "width": 100,
  "height": 100,
  "stats": {
    "min": -25.5,
    "max": 5.2,
    "mean": -12.3,
    "std": 4.5
  },
  "metadata": {
    "resolution": 10,
    "unit": "dB",
    "description": "VV polarization backscatter"
  }
}
Error Responses
Status Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Missing API key
403 Forbidden - Invalid API key
404 Not Found - Geometry not found
500 Internal Server Error