v1

latestOpenAPI 3.1.02026-07-23103397.3 KB

Catalog

Search datasets

Search for datasets (packages) using Solr query syntax. Supports filtering, faceting, sorting, and pagination. No authentication required for public data.

Pass parameters as query string arguments (GET) or as a JSON body (POST).

get/package_search

Query parameters

qstring nullable

Solr search query. Supports Solr syntax. Defaults to "*:*" (all datasets).

fqstring nullable

Solr filter query. Restricts results without affecting relevance scoring.

fq_liststring[] nullable

Additional filter queries as a list. Each entry is ANDed with fq.

sortstring nullable

Sort order as a Solr sort string. Defaults to "score desc, metadata_modified desc".

rowsinteger nullable

Maximum number of datasets to return. Defaults to 10, maximum 1000.

startinteger nullable

Offset into the result set. Used for pagination.

facetstring nullable

Enable faceted results. Defaults to "true".

facet.mincountinteger nullable

Minimum count for a facet value to be included in the response.

facet.limitinteger nullable

Maximum number of values returned per facet field. Defaults to 50.

facet.fieldstring[] nullable

Fields to facet on.

include_draftsboolean nullable

Include draft datasets in results. Requires authentication as the owning user or org admin. Defaults to false.

include_deletedboolean nullable

Include deleted datasets in results. Defaults to false.

include_privateboolean nullable

Include private datasets in results. Requires authentication as a member of the owning organisation. Defaults to false.

use_default_schemaboolean nullable

Return results using the default package schema rather than any custom schema configured on the instance. Defaults to false.

Response

Successful response.

helpstring required

URL to the API documentation for this action.

successboolean required

Whether the request succeeded.

All 10 operations