---
title: "Ask one census frame (top1k, top10k, top100k) a question across every site it measured, with the census field ids (fields=1 lists them): where= (all hold), not= (none hold), any= (at least one), rank_max=. Returns the matching sites in rank order, the count, the denominator (sites where every named field could be measured) and its 95% interval, from one named run, signed. The first 100 matches are free; a licence key pages up to 2,000 at a time and adds format=csv."
method: GET
path: "/api/v1/query"
---

# Ask one census frame (top1k, top10k, top100k) a question across every site it measured, with the census field ids (fields=1 lists them): where= (all hold), not= (none hold), any= (at least one), rank_max=. Returns the matching sites in rank order, the count, the denominator (sites where every named field could be measured) and its 95% interval, from one named run, signed. The first 100 matches are free; a licence key pages up to 2,000 at a time and adds format=csv.

`GET /api/v1/query`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/v1/query`
- Auth: none required

## Query parameters

- `frame` 'top1k' | 'top10k' | 'top100k'
- `where` string
- `not` string
- `any` string
- `rank_max` integer
- `run` integer
- `offset` integer
- `limit` integer
- `format` 'json' | 'csv'
- `fields` '1'

## Response `200`

crawlcheck-query

- object, nullable
  - `kind` string, nullable
  - `v` number, nullable
  - `frame` string, nullable
  - `frame_label` string, nullable
  - `run` number, nullable
  - `run_complete` boolean, nullable
  - `measured` number, nullable
  - `frame_size` number, nullable
  - `question` object, nullable
    - `where` string[], nullable
    - `not` string[], nullable
    - `any` unknown[], nullable
      - unknown
    - `rank_max` number, nullable
  - `count` number, nullable
  - `of` number, nullable
  - `share` object, nullable
    - `k` number, nullable
    - `n` number, nullable
    - `share` number, nullable
    - `low` number, nullable
    - `high` number, nullable
    - `level` number, nullable
    - `method` string, nullable
  - `offset` number, nullable
  - `returned` number, nullable
  - `next` string, nullable
  - `matches` object[], nullable
    - `rank` number, nullable
    - `domain` string, nullable
  - `records` string, nullable
  - `access` string, nullable
  - `sha256` unknown
  - `signature` unknown

---

[API](https://skmtc.dev/crawlcheck/apis/crawlcheck-api.md) · [All operations](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/revisions/57acbd6d4489?raw)