Search Datasets Endpoint

GET

/search/datasets/

const url = 'https://example.com/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: {'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/search/datasets/?sort_by=relevance&offset=0&limit=10&cql2_filter_lang=cql2-text&exclude_synthetic=true&spatial_predicate=intersects' \
  --header 'Content-Type: application/json' \
  --data '[ "example" ]'

Search datasets with text, spatial, and faceted filters.

Authorizations

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

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

features

required

Features

Array<object>

OGCRecordResponse

Single OGC API Records Feature.

object

assets

Any of:

object
null

object

key

additional properties

OGCAsset

STAC-style asset entry for an OGC Record.

object

href

required

Href

string

roles

Any of:

Array<string>
null

Array<string>

title

Any of:

string
null

string

type

required

Type

string

bbox

Any of:

Array<number>
null

Array<number>

conformsTo

Any of:

Array<string>
null

Array<string>

geometry

Any of:

object
null

object

key

additional properties

any

required

string

links

required

Links

Array<object>

OGCRecordLink

Link object in OGC API Records.

object

href

required

Href

string

rel

required

Rel

string

type

required

Type

string

properties

required

OGCRecordProperties

Properties block of an OGC API Records Feature.

object

band_count

Any of:

integer
null

integer

column_count

Any of:

integer
null

integer

constraints

Any of:

object
null

object

key

additional properties

any

contacts

required

Contacts

Array<object>

object

key

additional properties

any

created

Any of:

string
null

string format: date-time

crs

Any of:

string
null

string

crs_is_geographic

Any of:

boolean
null

boolean

dataset_count

Any of:

integer
null

integer

description

required

Description

string

distributions

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

externalIds

Externalids

Identifiers assigned by the described resource’s source system.

Array<string>

feature_count

Any of:

integer
null

integer

formats

Any of:

Array<string>
null

Array<string>

geometry_type

Any of:

string
null

string

gsd

Any of:

number
null

number

has_quicklook

Has Quicklook

boolean

keywords

required

Keywords

Array<string>

language

Any of:

string
null

string

license

required

License

string

lineage

Any of:

string
null

string

never_edited

Never Edited

boolean

quality_detail

Any of:

object
null

object

key

additional properties

any

quality_statement

Any of:

string
null

string

record_status

Any of:

string
null

string

record_type

Record Type

string

default: vector_dataset

rights

Any of:

string
null

string

row_count

Any of:

integer
null

integer

source_count

Any of:

integer
null

integer

source_format

Any of:

string
null

string

source_organization

Any of:

string
null

string

themes

required

Themes

Array<object>

object

key

additional properties

any

time

required

Time

object

key

additional properties

any

title

required

Title

string

type

Type

string

default: dataset

update_frequency

Any of:

string
null

string

updated

Any of:

string
null

string format: date-time

updated_by_display

Any of:

string
null

string

vrt_type

Any of:

string
null

string

time

required

Time

object

key

additional properties

any

type

Type

string

default: Feature

links

Any of:

Array<object>
null

Array<object>

OGCRecordLink

Link object in OGC API Records.

object

href

required

Href

string

rel

required

Rel

string

type

required

Type

string

numberMatched

required

Numbermatched

Total records matching the query

integer

numberReturned

required

Numberreturned

Number of records in this response page

integer

timeStamp

Any of:

string
null

string

type

Type

string

default: FeatureCollection

Example

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

400

Bad request — invalid query parameters or payload

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

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

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Search Datasets Endpoint

Authorizations

Parameters

Query Parameters

Request Body

Example generated

Responses

200

Example

400

Example

422

Example generated

429

Example

Headers

500

Example

503

Example

Example ^generated

Example ^generated