Sign in
Search

Search Datasets Endpoint

Changed on

Search datasets with text, spatial, and faceted filters.

get/search/datasets/

Request

  • The document declares no server URL.
  • Auth: one of:
    • none
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

qstring nullable

Full-text search query

bboxstring nullable

Bounding box: minx,miny,maxx,maxy

keywordsstring[] nullable

Filter by keywords

geometry_typestring nullable

Filter by geometry type

sridinteger nullable

Filter by SRID

source_organizationstring nullable

Filter by source organization

record_typestring nullable

Filter by record type (vector_dataset, raster_dataset)

date_fromstring date nullable

Filter created_at >=

date_tostring date nullable

Filter created_at <=

vintage_startstring date nullable

Filter data_vintage_start >=

vintage_endstring date nullable

Filter data_vintage_end <=

sort_bystring

Sort: relevance, date_added, name, last_updated

sort_descboolean nullable

Sort direction override

offsetinteger

Pagination offset

limitinteger

Page size. Values above the maximum (200) are clamped to it rather than rejected, per OGC API Features Core /req/core/fc-limit-response-1(C).

filterstring nullable

CQL2 filter expression

filter-langstring

Filter language: cql2-text or cql2-json

datetimestring nullable

OGC datetime interval: instant, start/end, ../end, start/..

exclude_syntheticboolean

Exclude synthetic/test datasets

spatial_predicate'intersects' | 'within'

Spatial predicate: intersects or within

geometrystring nullable

GeoJSON geometry for spatial filter

collection_idstring uuid nullable

Filter by collection membership

Response

Successful Response

typestring
timeStampstring nullable
numberMatchedinteger required

Total records matching the query

numberMatchedAllTypesinteger nullable

Total records matching the query with record_type removed and every other filter kept; present only when record_type is set

numberReturnedinteger required

Number of records in this response page

featuresOGCRecordResponse[] required(unresolved $ref)

Changes