CrawlCheck Usage API
The Usage API from CrawlCheck — 1 operation(s) for usage.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-usage-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
openapi: 3.2.0
info:
title: Crawlcheck Io Usage 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 Usage 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: Usage
paths:
/api/usage:
get:
operationId: usage
summary: This key's monthly scan quota and usage; every keyed response also carries…
parameters:
- name: x-crawlcheck-key
in: header
required: true
schema:
type: string
responses:
'200':
description: '{plan, month, used, limit, remaining, resets_at}'
content:
application/json:
examples:
worked:
summary: Produced by the production Worker code against a stored copy of a real record; ids, keys and tokens are placeholders.
value:
ok: true
plan: growth
month: 2026-10
used: 0
limit: 20000
remaining: 20000
resets_at: '2026-11-01T00:00:00.000Z'
lookups:
limit: 1000000
used: 0
remaining: 1000000
resets_at: '2026-11-01T00:00:00.000Z'
counts: one per keyed Resolve lookup, one per domain in a keyed batch, one per keyed preflight and private lookup; without a key these are free and not counted
counts: one per keyed scan (/api/scan/licensed, /api/v1/scan), one per deep crawl, one per domain in a batch (charged at submission)
burst: 60 scans per ten minutes per key, separate from the monthly quota
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
plan:
type:
- string
- 'null'
month:
type:
- string
- 'null'
used:
type:
- number
- 'null'
limit:
type:
- number
- 'null'
remaining:
type:
- number
- 'null'
resets_at:
type:
- string
- 'null'
lookups:
type:
- object
- 'null'
properties:
limit:
type:
- number
- 'null'
used:
type:
- number
- 'null'
remaining:
type:
- number
- 'null'
resets_at:
type:
- string
- 'null'
counts:
type:
- string
- 'null'
additionalProperties: true
counts:
type:
- string
- 'null'
burst:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'404':
description: No valid licence key
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s \\\n -H \"x-crawlcheck-key: $CRAWLCHECK_KEY\" \\\n 'https://crawlcheck.io/api/usage'"
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:
- Usage
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