Scenes

Returns a paginated list of scene resources.

get/scenes

Query parameters

providerstring required

Provider name of scene data. Supported value: SentinelHub.

partyIdstring required

PartyId.

associatedResourceIdstring required

Associated Resource Id of the resource.

associatedResourceTypestring required

Resource Types of the resource. i.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.

collectionstring required

Collection name of scene data, Available Values: sentinel-2-l2a, sentinel-2l1c.

itemIdstring

Item Id.

startDateTimestring date-time

Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.

endDateTimestring date-time

Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.

maxCloudCoveragePercentagenumber double

Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].

maxDarkPixelCoveragePercentagenumber double

Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].

imageNamesstring[]

List of image names to be filtered.

imageResolutionsnumber[]

List of image resolutions in meters to be filtered.

imageFormatsstring[]

List of image formats to be filtered.

maxPageSizeinteger

Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.

skipTokenstring

Skip token for getting next set of results.

api-versionstring required

The requested API version

Response

Success

skipTokenstring

Token used in retrieving the next page. If null, there are no additional pages.

nextLinkstring

Continuation link (absolute URI) to the next page of results in the list.

Changes

Changed in 2 of the 6 revisions of this API.543

  • 2021-03-31-preview33cf1de6e0c4311See the full diff
    • added the new required query request parameter collection

      new-required-request-parameter

    • the query request parameter associatedResourceId became required

      request-parameter-became-required

    • the query request parameter associatedResourceType became required

      request-parameter-became-required

    • deleted the query request parameter source

      request-parameter-removed

    • added the new optional query request parameter itemId

      new-optional-request-parameter

  • 2021-03-31-previewaae0a90ec457232See the full diff
    • added the new required query request parameter partyId

      new-required-request-parameter

    • the query request parameter source became required

      request-parameter-became-required

    • deleted the query request parameter $maxPageSize

      request-parameter-removed

    • deleted the query request parameter $skipToken

      request-parameter-removed

    • deleted the query request parameter farmerId

      request-parameter-removed

    • added the new optional query request parameter maxPageSize

      new-optional-request-parameter

    • added the new optional query request parameter skipToken

      new-optional-request-parameter