Search Datasets Endpoint

GET

/search/datasets/

const url = 'https://example.com/api/search/datasets/?sort_by=relevance&offset=0&limit=10&cql2_filter_lang=cql2-text&exclude_synthetic=true&spatial_predicate=intersects';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '["example"]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/search/datasets/?sort_by=relevance&offset=0&limit=10&cql2_filter_lang=cql2-text&exclude_synthetic=true&spatial_predicate=intersects' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ "example" ]'

Search datasets with text, spatial, and faceted filters.

Authorizations

OAuth2PasswordBearer

Parameters

Query Parameters

Any of:

string
null

string

<= 1000 characters

bbox

Any of:

string
null

string

geometry_type

Any of:

string
null

string

srid

Any of:

integer
null

integer

source_organization

Any of:

string
null

string

record_type

Any of:

string
null

string

date_from

Any of:

string
null

string format: date

date_to

Any of:

string
null

string format: date

vintage_start

Any of:

string
null

string format: date

vintage_end

Any of:

string
null

string format: date

sort_by

Sort By

string

default: relevance

sort_desc

Any of:

boolean
null

boolean

offset

Offset

integer

limit

Limit

integer

default: 10 >= 1 <= 200

filter

Any of:

string
null

string

<= 10000 characters

cql2_filter_lang

Cql2 Filter Lang

string

default: cql2-text

datetime

Any of:

string
null

string

exclude_synthetic

Exclude Synthetic

boolean

default: true

spatial_predicate

Spatial Predicate

string

default: intersects

Allowed values: intersects within

geometry

Any of:

string
null

string

<= 50000 characters

collection_id

Any of:

string
null

string format: uuid

Request Body

application/json

Any of:

Array<string>
null

Array<string>

Example ^generated

[
  "example"
]

Responses

200

Successful Response

application/json

OGCFeatureCollectionResponse

OGC API Records FeatureCollection with match counts.

object

type

Type

string

default: FeatureCollection

timeStamp

Any of:

string
null

string

numberMatched

required

Numbermatched

Total records matching the query

integer

numberReturned

required

Numberreturned

Number of records in this response page

integer

features

required

Features

Array<object>

OGCRecordResponse

Single OGC API Records Feature.

object

type

Type

string

default: Feature

required

string

conformsTo

Any of:

Array<string>
null

Array<string>

time

Any of:

object
null

object

key

additional properties

any

geometry

Any of:

object
null

object

key

additional properties

any

properties

required

OGCRecordProperties

Properties block of an OGC API Records Feature.

object

type

Type

string

default: dataset

title

required

Title

string

description

Any of:

string
null

string

keywords

Any of:

Array<string>
null

Array<string>

created

Any of:

string
null

string format: date-time

updated

Any of:

string
null

string format: date-time

updated_by_display

Any of:

string
null

string

never_edited

Never Edited

boolean

crs

Any of:

string
null

string

record_type

Record Type

string

default: vector_dataset

band_count

Any of:

integer
null

integer

geometry_type

Any of:

string
null

string

feature_count

Any of:

integer
null

integer

row_count

Any of:

integer
null

integer

column_count

Any of:

integer
null

integer

license

Any of:

string
null

string

source_organization

Any of:

string
null

string

quality_detail

Any of:

object
null

object

key

additional properties

any

quality_statement

Any of:

string
null

string

formats

Any of:

Array<string>
null

Array<string>

language

Any of:

string
null

string

themes

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

rights

Any of:

string
null

string

contacts

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

time

Any of:

object
null

object

key

additional properties

any

lineage

Any of:

string
null

string

update_frequency

Any of:

string
null

string

constraints

Any of:

object
null

object

key

additional properties

any

distributions

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

record_status

Any of:

string
null

string

has_quicklook

Has Quicklook

boolean

gsd

Any of:

number
null

number

vrt_type

Any of:

string
null

string

source_count

Any of:

integer
null

integer

dataset_count

Any of:

integer
null

integer

links

required

Links

Array<object>

OGCRecordLink

Link object in OGC API Records.

object

rel

required

Rel

string

href

required

Href

string

type

required

Type

string

assets

Any of:

object
null

object

key

additional properties

OGCAsset

STAC-style asset entry for an OGC Record.

object

href

required

Href

string

type

required

Type

string

title

Any of:

string
null

string

roles

Any of:

Array<string>
null

Array<string>

bbox

Any of:

Array<number>
null

Array<number>

links

Any of:

Array<object>
null

Array<object>

OGCRecordLink

Link object in OGC API Records.

object

rel

required

Rel

string

href

required

Href

string

type

required

Type

string

Example

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "type": "dataset",
        "never_edited": false,
        "record_type": "vector_dataset",
        "has_quicklook": false
      }
    }
  ]
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

Search Datasets Endpoint

Authorizations

Parameters

Query Parameters

Request Body

Example generated

Responses

200

Example

422

Example generated

Example ^generated

Example ^generated