Search CKAN Packages

Searches for packages (datasets) satisfying a given search criteria using Solr query parameters. Returns matching datasets, count, and facet information.

byCKAN API

660calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDckan.package.search.v3.4276a761

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

qstringOptional

The Solr query. Optional. Default: "*:*"

bfstringOptional

Boost functions for scoring.

fqstringOptional

Any filter queries to apply. Note: +site_id:{ckan_site_id} is added automatically.

mmstringOptional

Minimum match parameter for dismax/edismax.

qfstringOptional

Query fields for dismax/edismax parsing.

wtstringOptional

Writer type for Solr response format.

tiestringOptional

Tie parameter for dismax/edismax.

rowsintegerOptional

Maximum number of matching rows (datasets) to return. Default: 10, max: 1000

sortstringOptional

Sorting of the search results. Default: 'score desc, metadata_modified desc'

booststringOptional

Boost query for scoring.

facetstringOptional

Whether to enable faceted results. Default: 'true'

startintegerOptional

Offset in the complete result for where the returned datasets should begin.

defTypestringOptional

Defines the query parser to use.

fq_listarrayOptional

Additional filter queries to apply.

facet.fieldarrayOptional

Fields to facet upon. Default: empty.

facet.limitintegerOptional

Maximum number of values the facet fields return. Default: 50

facet.mincountintegerOptional

Minimum counts for facet fields to be included in results.

include_draftsbooleanOptional

Include draft datasets in results. Default: false

include_deletedbooleanOptional

Include deleted datasets in results. Default: false

include_privatebooleanOptional

Include private datasets in results. Default: false

use_default_schemabooleanOptional

Use default package schema instead of custom schema. Default: false