CrawlCheck

CrawlCheck Data API

The Data API from CrawlCheck — 4 operation(s) for data.

Documentation GitHub OpenAPI

Operations 4

GET /api/data/inventory Everything held about a domain, signed: each family of stored keys with counts… #

GET /api/data/export Export everything held about a domain in signed parts: part 0 = the inventory… #

POST /api/data/delete Delete everything held about a domain: {domain, confirm: domain… #

GET /api/data/deletion A signed deletion record: counts per family and the digest of the deleted-key… #

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-data-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Crawlcheck Io Data 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 Data 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: Data
paths:
  /api/data/inventory:
    get:
      operationId: dataInventory
      summary: 'Everything held about a domain, signed: each family of stored keys with counts…'
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-data-inventory
        '403':
          description: needs a licence for the domain
          content:
            application/json:
              examples:
                worked:
                  summary: Captured from production on 2026-10-02; without the domain's licence the inventory is locked; with it, every family of stored keys with counts and bytes, signed.
                  value:
                    ok: false
                    locked: true
                    error: Exporting or deleting a domain's data needs a licence for crawlcheck.io (the x-crawlcheck-key header or the /manage session) or the owner's session.
                    trace_id: 05579f2ce017fe516ffa8189e09c7c8c
                    span_id: 67506ba64b7fbf79
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  locked:
                    type:
                    - boolean
                    - 'null'
                  error:
                    type:
                    - string
                    - 'null'
                  trace_id:
                    type:
                    - string
                    - 'null'
                  span_id:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/data/inventory?domain=crawlcheck.io'
      security:
      - licenceKey: []
      - bearer: []
      x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
      tags:
      - Data
    servers:
    - url: https://crawlcheck.io
  /api/data/export:
    get:
      operationId: dataExport
      summary: 'Export everything held about a domain in signed parts: part 0 = the inventory…'
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
      - name: part
        in: query
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          description: crawlcheck-data-export-part
        '403':
          description: OK
          content:
            application/json:
              examples:
                worked:
                  summary: Captured from production on 2026-10-02; locked without the domain's licence; with it, signed parts starting from the inventory.
                  value:
                    ok: false
                    locked: true
                    error: Exporting or deleting a domain's data needs a licence for crawlcheck.io (the x-crawlcheck-key header or the /manage session) or the owner's session.
                    trace_id: 42de8bf243c849d697f0618356844e0f
                    span_id: ddb2c7567dd838c1
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  locked:
                    type:
                    - boolean
                    - 'null'
                  error:
                    type:
                    - string
                    - 'null'
                  trace_id:
                    type:
                    - string
                    - 'null'
                  span_id:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/data/export?domain=crawlcheck.io&part=0'
      security:
      - licenceKey: []
      - bearer: []
      x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
      tags:
      - Data
    servers:
    - url: https://crawlcheck.io
  /api/data/delete:
    post:
      operationId: dataDelete
      summary: 'Delete everything held about a domain: {domain, confirm: domain…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: job state; record when done
        '403':
          description: OK
          content:
            application/json:
              examples:
                worked:
                  summary: Captured from production on 2026-10-02; a deletion needs the domain's licence and an inventory issued in the last 24 hours.
                  value:
                    ok: false
                    locked: true
                    error: Exporting or deleting a domain's data needs a licence for example.com (the x-crawlcheck-key header or the /manage session) or the owner's session.
                    trace_id: 2e9b948dea8c287eae60fd5047327f3b
                    span_id: 0d522f9755af8800
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  locked:
                    type:
                    - boolean
                    - 'null'
                  error:
                    type:
                    - string
                    - 'null'
                  trace_id:
                    type:
                    - string
                    - 'null'
                  span_id:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
        '409':
          description: no recent inventory
      x-codeSamples:
      - lang: Shell
        label: curl
        source: "curl -s -X POST \\\n  -H \"content-type: application/json\" \\\n  -d '{\"domain\":\"example.com\",\"confirm\":\"example.com\",\"inventory_sha256\":\"…\"}' \\\n  'https://crawlcheck.io/api/data/delete'"
      security:
      - licenceKey: []
      - bearer: []
      x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Data
    servers:
    - url: https://crawlcheck.io
  /api/data/deletion:
    get:
      operationId: dataDeletionRecord
      summary: 'A signed deletion record: counts per family and the digest of the deleted-key…'
      parameters:
      - name: sha256
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-deletion-record
        '404':
          description: OK
          content:
            application/json:
              examples:
                worked:
                  summary: Captured from production on 2026-10-02; an unknown digest; a real one returns the signed deletion record (counts per family, never the data).
                  value:
                    ok: false
                    error: No deletion record with that digest.
                    trace_id: cc5582e5f95991a3355d42bbbeb791a1
                    span_id: 81c6454cfab7dee4
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  error:
                    type:
                    - string
                    - 'null'
                  trace_id:
                    type:
                    - string
                    - 'null'
                  span_id:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/data/deletion?sha256=0000000000000000000000000000000000000000000000000000000000000000'
      security: []
      x-auth: public; no credential read
      tags:
      - Data
    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