Query any dataset (generic form)

Filters are query parameters named after the dataset's filter keys (see GET /v1/datasets/{id}). The per-dataset operations below list them explicitly.

get/v1/datasets/{id}/query

Request

  • Base URL: https://datascoop.io
  • URL: https://datascoop.io/v1/datasets/{id}/query
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in query parameter api_key

Path parameters

id'cqc' | 'fsa' | 'us-food-inspections' | 'us-building-permits' | 'fhis-scotland' | 'charity-commission' | 'companies-house' | 'us-motor-carriers' | 'us-business-licenses' | 'us-liquor-licenses' | 'au-aged-care' required

Query parameters

limitinteger

Rows to return. Free plans are capped at 25; Pro up to 10,000 per JSON page.

offsetinteger

Rows to skip (paging).

format'json' | 'csv'

json (default) or csv. CSV opens in Excel and is never paged.

Response

Matching rows

datasetstring required
plan'free' | 'pro'
totalinteger required

Rows matching the filters

returnedinteger required
offsetinteger
truncatedboolean required

true when fewer rows than total were returned

ignoredstring[]

Filter keys the dataset does not know

rowsobject[] required
attributionstring required

Keep this with the data

licencestring

Changes

No recorded changes to this operation across all 1 revision of this API.