Skip to content

Paged Query Existing Images ​

API Information ​

  • Request Path: /market/page/query
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

FieldTypeRequiredDescriptionConstraints
startDateStringNoStart date-
endDateStringNoEnd date-
timeZoneStringNoTime zone used for date conversion and output formattinge.g. UTC+3 / GMT+3 / Asia/Riyadh
geometryList<String>NoGeometry (single or multiple GeoJSON geometry strings)-
aoiIdsList<Long>NoAOI IDs, overrides geometry when provided-
sensorTypeIntegerYesSensor type1=SAR, 2=Optical
pageNumberintYesPage number>=1
pageSizeintYesPage size>0
cloudPercentDoubleNoCloud cover percentage-
resolutionLevelIntegerNoResolution level: 1-Ultra High, 2-High Resolution - Submeter, 3-High Resolution, 4-Medium-Low Resolution1/2/3/4

Request Body Example ​

json
{
  "startDate": "2023-01-01",
  "endDate": "2026-12-31",
  "geometry": ["{\"type\":\"Polygon\",\"coordinates\":[[[102.61282157031928,21.488503948497097],[106.99114976403081,21.488503948497097],[106.99114976403081,18.594746845159506],[102.61282157031928,18.594746845159506],[102.61282157031928,21.488503948497097]]]}"],
  "sensorType": 1,
  "resolutionLevel": 2,
  "pageNumber": 1,
  "pageSize": 10,
  "cloudPercent": 20.0
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataImageListRespResponse data

ImageListResp Object ​

FieldTypeDescription
totalLongTotal count
contentList<ImageListRespItem>Product list
timeItemsList<String>Time items

ImageListRespItem Object ​

FieldTypeDescription
idLongProduct ID
productIdStringProduct ID string
thumbStringThumbnail URL
nameStringProduct name
resolutionStringResolution
imageTimeStringImage acquisition time
minSizeBigDecimalMinimum size
deliveryInBigDecimalDelivery time
unitPriceBigDecimalUnit price
geometryStringGeometry WKT
areaBigDecimalArea size
amountBigDecimalTotal amount
discountBigDecimalDiscount rate
discountAmountBigDecimalDiscounted amount
discountUnitPriceBigDecimalDiscounted unit price
satelliteAngleBigDecimalSatellite angle
centerLongitudeBigDecimalCenter longitude
centerLatitudeBigDecimalCenter latitude

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 100,
    "content": [
      {
        "id": 12345,
        "productId": "product_1",
        "thumb": "http://example.com/thumb.jpg",
        "name": "SAR Image",
        "resolution": "0.5m",
        "imageTime": "2023-06-15 12:00:00",
        "minSize": 25,
        "deliveryIn": 24,
        "unitPrice": 100.00,
        "geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[102.6886899850927,20.21950658516742],[102.451897801616,20.16874196097035],[102.56974195534,19.67552515468356],[102.8057902075779,19.72608503057904],[102.6886899850927,20.21950658516742]]]}",
        "area": 50.5,
        "amount": 5050.00,
        "discount": 0.9,
        "discountAmount": 4545.00,
        "discountUnitPrice": 90.00,
        "satelliteAngle": 15.5,
        "centerLongitude": 120.5,
        "centerLatitude": 30.5
      }
    ],
    "timeItems": ["2023-06-15"]
  }
}

Failure Response ​

json
{
  "code": 400,
  "message": "Invalid date format",
  "data": null
}

Error Code Description ​

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions ​

  1. This API is used to query market products with pagination
  2. User authentication is required
  3. Supports filtering by date range, geometry, AOI, sensor type, and cloud cover.
  4. Returns a paginated list of products

Notes ​

  • Geometry should be in WKT format
  • Date format should be YYYY-MM-DD