CrawlCheck Query API

The Query API from CrawlCheck — 1 operation(s) for query.

GitHub OpenAPI

Operations 1

GET /api/v1/query Ask one census frame (top1k, top10k, top100k) a question across every site it… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-query-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

crawlcheck-io-query-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Crawlcheck Io Query API
  version: '1'
  contact:
    name: CrawlCheck
    url: https://crawlcheck.io/policy
    email: hello@crawlcheck.io
  license:
    name: Terms
    url: https://crawlcheck.io/policy
  x-core-contract:
    promise: 'These operations are the core contract. They stay at /api/v1 and keep answering for at least 180 days after any /api/v2 is announced; their stable fields change only in a new major version, and their provisional fields only after 30 days'' notice, per /docs/api/compatibility. Verifying what they return needs none of these calls: crawlcheck-verify.mjs checks a document on your machine against the published keys (/.well-known/http-message-signatures-directory) and the rotation record, read once with --online or saved for --keys. Everything else documented here is useful but secondary, and may change with the notice its fields'' tags promise.'
    operations:
    - method: GET
      path: /api/v1/resolve
      operationId: resolveDomainV1
    - method: POST
      path: /api/v1/resolve
      operationId: resolveBatchV1
    - method: POST
      path: /api/v1/preflight
      operationId: preflightV1
    - method: GET
      path: /api/v1/decisions/{sha256}
      operationId: decisionCheckV1
    - method: GET
      path: /api/v1/revocations
      operationId: revocations
    - method: GET
      path: /api/v1/visitor
      operationId: visitorResolveV1
    - method: POST
      path: /api/v1/visitor
      operationId: visitorResolveBatchV1
    - method: GET
      path: /api/v1/mcp/scan
      operationId: mcpScanUrl
    - method: POST
      path: /api/v1/mcp/lock/check
      operationId: mcpLockCheck
    list: https://crawlcheck.io/api/v1/core
  description: 'Operations tagged Query across 2 of this provider''s published API definitions: crawlcheck-io-openapi.json, crawlcheck-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://crawlcheck.io
tags:
- name: Query
paths:
  /api/v1/query:
    get:
      operationId: crossDomainQuery
      summary: Ask one census frame (top1k, top10k, top100k) a question across every site it…
      parameters:
      - name: frame
        in: query
        schema:
          type: string
          enum:
          - top1k
          - top10k
          - top100k
      - name: where
        in: query
        schema:
          type: string
      - name: not
        in: query
        schema:
          type: string
      - name: any
        in: query
        schema:
          type: string
      - name: rank_max
        in: query
        schema:
          type: integer
      - name: run
        in: query
        schema:
          type: integer
      - name: offset
        in: query
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
      - name: format
        in: query
        schema:
          type: string
          enum:
          - json
          - csv
      - name: fields
        in: query
        schema:
          type: string
          enum:
          - '1'
      responses:
        '200':
          description: crawlcheck-query
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; counts and matches are illustrative.
                  value:
                    kind: crawlcheck-query
                    v: 1
                    frame: top10k
                    frame_label: top 10,000, daily
                    run: 1
                    run_complete: true
                    measured: 9776
                    frame_size: 9776
                    question:
                      where:
                      - blocks_GPTBot
                      not:
                      - blocks_ClaudeBot
                      any: []
                      rank_max: 0
                    count: 312
                    of: 8104
                    share:
                      k: 312
                      n: 8104
                      share: 0.039
                      low: 0.034
                      high: 0.043
                      level: 0.95
                      method: Wilson score interval
                    offset: 0
                    returned: 2
                    next: https://crawlcheck.io/api/v1/query?frame=top10k&where=blocks_GPTBot&not=blocks_ClaudeBot&offset=100
                    matches:
                    - rank: 41
                      domain: example-news.com
                    - rank: 97
                      domain: example-shop.com
                    records: https://crawlcheck.io/api/census/records?frame=top10k&run=1&domain=<domain>
                    access: 'public: the first 100 matches; a licence key pages further and adds CSV'
                    sha256: …
                    signature: …
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  v:
                    type:
                    - number
                    - 'null'
                  frame:
                    type:
                    - string
                    - 'null'
                  frame_label:
                    type:
                    - string
                    - 'null'
                  run:
                    type:
                    - number
                    - 'null'
                  run_complete:
                    type:
                    - boolean
                    - 'null'
                  measured:
                    type:
                    - number
                    - 'null'
                  frame_size:
                    type:
                    - number
                    - 'null'
                  question:
                    type:
                    - object
                    - 'null'
                    properties:
                      where:
                        type:
                        - array
                        - 'null'
                        items:
                          type:
                          - string
                          - 'null'
                      not:
                        type:
                        - array
                        - 'null'
                        items:
                          type:
                          - string
                          - 'null'
                      any:
                        type:
                        - array
                        - 'null'
                        items: {}
                      rank_max:
                        type:
                        - number
                        - 'null'
                    additionalProperties: true
                  count:
                    type:
                    - number
                    - 'null'
                  of:
                    type:
                    - number
                    - 'null'
                  share:
                    type:
                    - object
                    - 'null'
                    properties:
                      k:
                        type:
                        - number
                        - 'null'
                      n:
                        type:
                        - number
                        - 'null'
                      share:
                        type:
                        - number
                        - 'null'
                      low:
                        type:
                        - number
                        - 'null'
                      high:
                        type:
                        - number
                        - 'null'
                      level:
                        type:
                        - number
                        - 'null'
                      method:
                        type:
                        - string
                        - 'null'
                    additionalProperties: true
                  offset:
                    type:
                    - number
                    - 'null'
                  returned:
                    type:
                    - number
                    - 'null'
                  next:
                    type:
                    - string
                    - 'null'
                  matches:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - object
                      - 'null'
                      properties:
                        rank:
                          type:
                          - number
                          - 'null'
                        domain:
                          type:
                          - string
                          - 'null'
                      additionalProperties: true
                  records:
                    type:
                    - string
                    - 'null'
                  access:
                    type:
                    - string
                    - 'null'
                  sha256: {}
                  signature: {}
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/v1/query?frame=top10k&where=blocks_GPTBot&not=blocks_ClaudeBot'
      security: []
      x-auth: public; no credential read
      tags:
      - Query
    servers:
    - url: https://crawlcheck.io
components:
  securitySchemes:
    licenceKey:
      type: apiKey
      in: header
      name: x-crawlcheck-key
      description: 'Your licence key: cc_ followed by 32 hex characters. Sent on every keyed call.'
    bearer:
      type: http
      scheme: bearer
      description: The same licence key as a Bearer token. Accepted on /api/v1/* and /api/usage.
externalDocs:
  url: https://crawlcheck.io/docs/api
  description: Human-readable reference
x-refined-from:
- crawlcheck-io-openapi.json
- crawlcheck-io-openapi.yml