CCLEAR Developer Portal

The CCLEAR public data API is read-only, unauthenticated, and JSON-only — including every error response. It exposes the published research briefs, weekly tear-sheet issues, and service metadata drawn from the same hand-verified record of U.S. Regulation Crowdfunding that institutions license.

Static JSON snapshots are served from https://cclear.ai/api/v1 and the live endpoints, including the structured error contract, are served from the dynamic API described in https://cclear.ai/openapi.json.

Quickstart

• Discovery document: https://cclear.ai/api/v1/index.json lists every endpoint, the error shape, and the data license.
• Specification: https://cclear.ai/openapi.json is a complete OpenAPI 3.1 description of the surface.
• Research briefs: https://cclear.ai/api/v1/briefs.json returns every published brief as structured JSON; one document per brief is available at /api/v1/briefs/{slug}.json.
• Live endpoints: /health, /briefs, /briefs/{slug}, and /weekly-issues?limit=20 return live JSON and require no API key.

Error contract

Errors are never HTML. Every failure returns an application/json body containing a stable machine-readable code, a human-readable message, a resolution hint, the HTTP status, and a documentation_url pointing at the OpenAPI specification. The HTTP status always matches error.status.

• not_found — no endpoint matches the requested path (HTTP 404).
• brief_not_found — the endpoint exists but no brief has that slug (HTTP 404).
• invalid_parameter — a query parameter is out of range or malformed (HTTP 400).
• method_not_allowed — the API is read-only; use GET (HTTP 405).
• upstream_unavailable — a published snapshot could not be retrieved (HTTP 502).
• internal_error — unexpected server error; retry, then contact CCLEAR (HTTP 500).

Keys, rate limits, and sandbox

The public endpoints need no key or token, are cached for five minutes at the edge, and are intended for polite, cached use. They double as the sandbox: read-only, same schema as licensed delivery, and unable to mutate any CCLEAR record. Licensed delivery of the full transaction-level corpus, custom cuts, and scheduled feeds is provisioned per organisation during onboarding.

Engage CCLEAR

Commissioned research, full-corpus data licensing, and custom analytical cuts are scoped in a single conversation.

Machine-readable indexes

• Sitemap
• llms.txt
• OpenAPI specification
• API index

CCLEAR · Research Library · Methodology · License the data · Commission research