Ctrlk

Standard Images API

Collections

The collections endpoint returns all imagery datasets accessible through your account. This endpoint serves as the discovery mechanism for available imagery and must be called before querying specific images. Usually, you'll have access to only one or two collections that cover the full extent of the geographic area available to your account.

Common Use Cases

  • Application initialization - retrieve and cache available collections

  • Geographic discovery - identify which collections cover your areas of interest

  • Permission validation - confirm access to specific datasets before building user interfaces

Response Highlights

Each collection in the response includes:

  • id - unique identifier required for all subsequent image queries

  • extent - geographic boundaries for the collection

  • title and description - human-readable metadata for user interfaces

  • links - includes the items endpoint URL for querying images within this collection

Implementation Notes

💡 Cache collections data - this endpoint returns relatively static information that changes infrequently. Cache the response to avoid unnecessary API calls. Collection IDs are stable over time, so once you have it saved, you may not need to revisit this endpoint.

💡 Check extent data - use the spatial extent information to verify the collection's region aligns with your project location.

Retrieve a list of all collections

get

Access and browse available feature collections accessible to the authenticated user.

Authorizations
AuthorizationstringRequired

Enter your Bearer token

Path parameters
fstring · enumOptional

Response format type

Possible values:
Header parameters
Acceptstring · enumOptional

Response format (unless specified by the f parameter)

Possible values:
AuthorizationstringOptional

Bearer token for authenticated requests

Responses
200

Successful response

application/json
get
/api/ogc/v1/collections

Items

The items endpoint retrieves imagery from a specific collection. This endpoint supports extensive filtering capabilities to find precisely the images you need based on location, camera parameters, and capture attributes.

Common Use Cases

  • Location-based queries - find all images containing a specific point or area

  • Camera angle filtering - retrieve images captured at specific pitch or heading angles

  • Temporal searches - get images captured within date ranges

  • Quality filtering - use focused parameter to get the best images for your area of interest

  • Systematic processing - iterate through large datasets with pagination

Key Parameters

While this endpoint supports many parameters, these handle the majority of use cases:

Spatial Filtering:

  • p - find images containing a specific point (with optional buffer radius)

  • bbox - retrieve images within a rectangular geographic area

Smart Filtering:

  • focused - apply intelligent filtering to get the most relevant images

    • Use focused=focused for most practical applications

    • Use focused=5-view when you need multiple perspectives of the same location

Camera Parameters:

  • pitch - filter by camera angle (-90° for straight down, -60° for oblique views)

  • heading - filter by compass direction the camera was facing

  • altitude - filter by flight height above ground level

  • captured_at - filter by image capture date

Response Highlights

Each image feature includes:

  • geometry - precise geographic footprint showing the area captured in the image

  • properties - comprehensive metadata including flight parameters and capture information

  • links - download URLs for the actual image file (look for "title": "Raw Image")

Implementation Notes

💡 Always use focused filtering - unless you specifically need all overlapping images, add &focused=focused to all queries. This dramatically improves response relevance and reduces processing overhead.

💡 Extract download URLs from links - to download the actual image file, iterate through the links array in each feature and find the object with "title": "Raw Image" and "type": "image/jpeg". The href field contains the direct download URL.

💡 Handle pagination - large queries return paginated results. Check for "rel": "next" links in the response and follow them to retrieve complete datasets.

💡 Combine parameters wisely - all filter parameters use AND logic. For example, ?pitch=-90&heading=0&focused=focused returns only nadir images facing north that prominently feature your query area.

Retrieve image features from a collection

get

Discover and download high-quality drone imagery based on geographic location and camera parameters. This endpoint allows you to find precise aerial views of specific points or regions of interest, with filters for camera orientation, angle, and coverage area.

Authorizations
AuthorizationstringRequired

Enter your Bearer token

Path parameters
collectionIdstringRequired

Collection identifier, discoverable from the /api/ogc/v1/collections endpoint

Pattern: ^[a-z0-9]+$
fstring · enumOptional

Response format type

Possible values:
Query parameters
bboxstringOptional

An area of interest to query in the format minLon,minLat,maxLon,maxLat. Returns images that view any portion of the specified area.

Example: -122.5,37.7,-122.3,37.8
pstringOptional

A point of interest to query with an optional radius search parameter in the format longitude,latitude[,radiusMeters]. Returns images that view any portion of the specified point or radius area.

Example: -123.103885,49.27341,100
headingstringOptional

Camera heading in degrees, expressed as an inclusive range [hmin, hmax], or as a single value. Range: [0, 360), where 0 is north, 90 is east, etc. By default, no filter is applied. Note that a slight margin is applied to the edges to avoid filtering images at the edges of the range.

Example: 0,360
pitchstringOptional

Camera angle below horizontal in degrees, expressed as an inclusive range [pmin, pmax], or as a single value. Range: [-135, 45], where -90 is directly downward (nadir), -60 is oblique, and -30 is more horizontal. By default, no filter is applied. Note that a slight margin is applied to the edges to avoid missing images at the edges of the range.

Example: -135,45
altitudestringOptional

Camera altitude above ground level in meters, expressed as an inclusive range [amin, amax], or as a single value. Range: [0, 10000], where 0 is ground level and 10000m is the practical maximum. By default, no filter is applied. Note that a slight margin is applied to the edges to avoid missing images at the edges of the range.

Example: 50,200
captured_atstringOptional

Image capture timestamp, expressed as an inclusive range [start, end], or as a single value. Format: Any valid JavaScript date format (e.g., "2023-01-01T00:00:00Z", "2023-01-01", "Jan 1, 2023"). By default, no filter is applied.

Example: 2023-01-01T00:00:00Z,2023-12-31T23:59:59Z
capture_typestringOptional

Filter by image capture type(s). Can be a single type or comma-separated list. Valid values: panorama, orthomosaic, oblique. Example: "panorama" or "panorama,oblique". By default, no filter is applied.

Example: panorama,oblique
focusedstring · enumOptional

Filtering mode: 'none' (no filtering), 'focused' (prioritize images where the point/area of interest is prominently featured), or '5-view' (return up to 5 images representing different viewing angles: nadir, north, east, south, west). Note: pagination is not supported for 'focused' and '5-view' modes.

Default: nonePossible values:
limitinteger · min: 1Optional

Maximum number of features to return. The default is 50, the maximum is 100.

cursorstringOptional

Pagination token for retrieving subsequent result sets. Obtained from previous response when additional results exist.

Pattern: ^[aV64kbEPFOzgpjAGnN710Bvw8sucxrIQyXtdRJfMqK39CZUhoiLS2DWeH5mYlT]+$
Header parameters
Acceptstring · enumOptional

Response format (unless specified by the f parameter)

Possible values:
AuthorizationstringOptional

Bearer token for authenticated requests

Responses
200

Successful response

application/json
idstringRequired
titlestringRequired
typestring · enumRequiredPossible values:
numberReturnednumberRequired

The number of features in the response.

get
/api/ogc/v1/collections/{collectionId}+standard-images/items

Last updated