v5

latestOpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Public Finance & Government

Search the portal catalog

Free-text plus Solr filter search across the target portal catalog. Backed by CKAN package_search. Use q for keywords and fq for Solr-style filter queries (e.g. organization:office-for-national-statistics, groups:economia, tags:budget). Page with rows and start; the upstream CKAN action caps rows at 1000. Use sort to control ordering (e.g. metadata_modified desc, score desc, name asc).

get/api/v1/opendata/{portal}/search

Path parameters

portalstring required

Portal slug.

Portal slug.

Query parameters

qstring nullable

Solr query string - keywords, phrases, or Solr field queries. Empty = all datasets.

Solr query string - keywords, phrases, or Solr field queries. Empty = all datasets.

fqstring nullable

CKAN filter query in Solr syntax (e.g. organization:moj, groups:transport, tags:energy). Compound supported with AND / OR.

CKAN filter query in Solr syntax (e.g. organization:moj, groups:transport, tags:energy). Compound supported with AND / OR.

rowsinteger

Page size (max 1000 per CKAN cap).

Page size (max 1000 per CKAN cap).

startinteger

Page offset for pagination.

Page offset for pagination.

sortstring nullable

CKAN sort directive (e.g. metadata_modified desc, score desc, metadata_modified desc).

CKAN sort directive (e.g. metadata_modified desc, score desc, metadata_modified desc).

Response

Matched datasets, upstream total count, and facet counts when requested.

Example response

{
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}