https://app.chainpatrol.io/api/v2 and authenticated
with an API key — see Authentication for how to send it.
Agents can load these docs from llms.txt.
Start here
Create Report
File a report against a scam.
Asset Check
Check if an asset is allowed or blocked.
Asset List
Fetch our entire allowlist/blocklist for use in your own application.
Asset Changelog
Fetch the latest changes to our allowlist/blocklist.
Create Dispute
Create a dispute for an asset that has been incorrectly flagged.
Configure Webhook
Receive real-time notifications instead of polling.
Assets
Look up, submit, scan, and unblock individual assets.Asset Check
Check whether an asset is allowed or blocked.
Asset List
Fetch the full allowlist/blocklist.
Asset Changelog
Fetch recent allowlist/blocklist changes.
Asset Search
Search across assets.
Asset Submit
Submit an asset for review.
Unblock Asset
Unblock one of your assets, or open a dispute.
Asset Parse
Parse raw content into ChainPatrol asset types.
Start Asset Scan
Kick off a scan, optionally with a callback URL.
Get Scan Result
Retrieve enrichments, checks, and labels for a scan.
Get Asset Details
Deprecated — use Asset Check or Asset Search.
Blocklist sync
Sync the blocklist as hashed prefixes, so clients never download the full list of blocked content. This is the mechanism the ChainPatrol browser extension uses.Get Blocklist Version
Discover the current snapshot, recent-additions feed, and algorithm version.
Confirm Prefix Matches
Resolve full hashes for local prefix hits.
Reports
Create Report
File a report against a scam.
Search Reports
Check for an existing report before creating a new one.
Disputes
Create Dispute
Dispute an asset that has been incorrectly flagged.
Webhooks
Configure Webhook
Receive real-time notifications for asset status updates and threat detections.
Organization brands
List Organization Brands
List every brand on your organization, with terms, tickers, legal documents, and
trademark registrations.
Organization assets
Manage the assets and asset groups your organization owns.List Assets
List your organization’s assets.
Add Asset
Add an asset to your organization.
Update Asset
Update an organization asset.
Remove Asset
Remove an organization asset.
List Asset Groups
List your organization’s asset groups.
Create Asset Group
Create an asset group.
Update Asset Group
Update an asset group.
Delete Asset Group
Delete an asset group.
Organization reports
List Organization Reports
Retrieve your organization’s reports (
GET /organization/reports).Get Organization Reports
Deprecated — use List Organization Reports.
Detections
List detections, inspect their sources, and manage the detection configs that produce them.List Detections
List detection results.
List Detection Sources
Discover the sources you can configure and their config schemas.
List Detection Configs
List detection sources and their configs.
Create Detection Config
Create a new config for a source.
Update Detection Config
Change a config’s status, schedule, or fields.
Delete Detection Config
Delete an org-scoped config so it stops scanning.
Run Detection Configs
Run one or many configs on demand.
Validate Detection Configs
Check configs against their recent results.
Detection Drift
Surface zero-result, noisy, and stale configs.
List Threats
List threats for your organization.
Takedowns
List Takedowns
List takedowns for your organization.
Metrics
Get Metrics Summary
Customer-facing metrics and blocked threat breakdowns for a date range.
Get Metrics Breakdown
Blocked threat counts grouped by day, asset type, or brand.
Get Found Threats Count
The default
found metric — customer-facing new threats.Get Blocked Threats by First-Report Source
Blocked threat counts split by who reported them first — you or ChainPatrol.
List Organization Metrics
Retrieve your organization’s metrics (
GET /organization/metrics).Get Organization Metrics
Deprecated — use List Organization Metrics.
Account and access
Validate API Key
Check whether an API key is valid.
Get Current User
Details of the authenticated user.
Update Current User
Update the authenticated user’s profile and settings.
List User Organizations
Organizations the caller can access, with services and integrations.
Get User Organization
Fetch a single organization by slug.
Operations
Queue Snapshot
Pending review and takedown queue state, with SLA and age buckets.
Healthchecks
Healthchecks grade a single operational signal and all return the same result shape, so you can call them in a loop and handle the responses with shared code. Start from the registry:List Healthchecks
The registry of available healthchecks — only call the ones where
implemented is
true.- Silent Detection Configs — enabled configs producing too few recent results
- Reviewing Backlog — pile-up of unreviewed proposals
- Old Proposals in Review — proposals waiting past the age thresholds
- TODO Takedown Volume — pile-up of
takedowns in
TODO - IN_PROGRESS Takedown Volume —
pile-up of takedowns in
IN_PROGRESS - Stale IN_PROGRESS Takedowns — takedowns stuck past the staleness threshold
- Cancelled Takedown Count — excess cancellations over a rolling window
- Automated Takedowns Disabled — automation off for too long
- Dead Asset Spike — spike in assets detected as dead
- Missing Contact URL — no main communication channel configured
Two
POST endpoints are deprecated and kept only for backwards compatibility:
/public/getOrganizationReports — use
GET /organization/reports — and
/public/getOrganizationMetrics — use
GET /organization/metrics.
POST /asset/details is deprecated in the spec itself.