Query a dataset
query_datasetReturn matching public records, their total count and the attribution to cite. Fields marked personal in our schema are excluded; published business names, addresses or phone numbers may still identify sole traders. Without a Pro key each call returns at most 25 rows; when more match, truncated=true and next_step explains how to buy a full CSV or use Pro. Pro calls return up to 1,000 rows, with offset for retrieving the rest. Ask for format "summary" to get counts only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows to return (default 25, max 1000 per call; free plans are capped at 25) | |
| format | No | "rows" (default) returns the rows; "summary" returns only the total and links | |
| offset | No | Rows to skip when paging through results; the per-request plan cap still applies | |
| dataset | Yes | Dataset id, e.g. fsa | |
| filters | No | Filter object keyed by the filter keys from get_dataset_schema (not column names), e.g. {"localAuthority":"Leeds","rating":"1"}. Text filters are case-insensitive unless their schema sets caseSensitive to true; "contains" filters match substrings; enum filters must use one of the listed options. | |
| strict_filters | No | Reject unknown or invalid nonempty filters instead of ignoring them. Recommended when exact scope matters. Empty values are omitted; true-only boolean filters cannot select false. Default false preserves existing behavior. |