CrawlCheck North Star API
The North Star API from CrawlCheck — 1 operation(s) for north star.
Operations 1
GET
/api/v1/north-star
The north-star dashboard as data (?days=1-90, default 30): signed decisions…
#
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-north-star-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 North Star 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 North Star 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: North Star
paths:
/api/v1/north-star:
get:
operationId: northStar
summary: 'The north-star dashboard as data (?days=1-90, default 30): signed decisions…'
parameters:
- name: days
in: query
required: false
schema:
type: integer
responses:
'200':
description: crawlcheck-north-star
content:
application/json:
examples:
worked:
summary: Shape; per_day shortened, signature shortened.
value:
kind: crawlcheck-north-star
v: 1
window_days: 30
funnel:
decisions_issued: 327
on_fresh_measured_answer: 40
receipts_checked_by_sites: 54
receipts_accepted_by_sites: 31
outcomes_reported: 3
outcomes_linked_to_a_receipt: 1
by_action:
- action: read
decisions: 120
receipts_checked: 22
by_decision:
warn: 150
allow: 60
block: 9
decision_vs_outcome:
cells:
allow|ok: 1
allowed_then_refused: 0
blocked_then_got_through: 0
sha256: …
signature:
v: 1
alg: Ed25519
kid: …
sig: …
schema:
type:
- object
- 'null'
properties:
kind:
type:
- string
- 'null'
v:
type:
- number
- 'null'
window_days:
type:
- number
- 'null'
funnel:
type:
- object
- 'null'
properties:
decisions_issued:
type:
- number
- 'null'
on_fresh_measured_answer:
type:
- number
- 'null'
receipts_checked_by_sites:
type:
- number
- 'null'
receipts_accepted_by_sites:
type:
- number
- 'null'
outcomes_reported:
type:
- number
- 'null'
outcomes_linked_to_a_receipt:
type:
- number
- 'null'
additionalProperties: true
by_action:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
action:
type:
- string
- 'null'
decisions:
type:
- number
- 'null'
receipts_checked:
type:
- number
- 'null'
additionalProperties: true
by_decision:
type:
- object
- 'null'
properties:
warn:
type:
- number
- 'null'
allow:
type:
- number
- 'null'
block:
type:
- number
- 'null'
additionalProperties: true
decision_vs_outcome:
type:
- object
- 'null'
properties:
cells:
type:
- object
- 'null'
properties:
allow|ok:
type:
- number
- 'null'
additionalProperties: true
allowed_then_refused:
type:
- number
- 'null'
blocked_then_got_through:
type:
- number
- 'null'
additionalProperties: true
sha256: {}
signature:
type:
- object
- 'null'
properties:
v:
type:
- number
- 'null'
alg:
type:
- string
- 'null'
kid: {}
sig: {}
additionalProperties: true
additionalProperties: true
x-schema-source: worked-example
x-codeSamples:
- lang: Shell
label: curl
source: curl -s 'https://crawlcheck.io/api/v1/north-star?days=30'
security: []
x-auth: public; no credential read
tags:
- North Star
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