> ## Documentation Index > Fetch the complete documentation index at: https://chainpatrol.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # ChainPatrol External API for scam URL and address blocking > Index of every ChainPatrol External API endpoint for blocklist integrators, covering asset checks, reports, takedowns, metrics, and organization data. We work with leading browsers, antivirus tools, security apps, marketplaces, and wallets to block scam links, contract addresses, and wallet addresses before a user interacts with the scam. The API also lets customers pull all of ChainPatrol's threat data — suspected threats, reports, takedowns, and blocklist changes — directly into their own SOC for centralized monitoring. ChainPatrol's APIs are offered as a free service to browsers, antivirus tools, security apps, marketplaces, and wallets. Every endpoint below is served from `https://app.chainpatrol.io/api/v2`. Most need an API key — see [Authentication](https://chainpatrol.com/docs/external-api/authentication.md) for how to send it. A few public lookups, such as [Check Asset](https://chainpatrol.com/docs/external-api/asset-check.md) and [List Assets](https://chainpatrol.com/docs/external-api/asset-list.md), also answer without one. See the [Deprecation Policy](https://chainpatrol.com/docs/external-api/deprecation-policy.md) for how we version the API and notify you of breaking changes. Agents can load these docs from [llms.txt](https://chainpatrol.com/docs/llms.txt). ## Start here > [card] [Create Report](https://chainpatrol.com/docs/external-api/report-create.md) > > File a report against a scam. > [card] [Creating Reports](https://chainpatrol.com/docs/external-api/creating-reports.md) > > Guide to the whole reporting flow, including uploading evidence files. > [card] [Asset Check](https://chainpatrol.com/docs/external-api/asset-check.md) > > Check if an asset is allowed or blocked. > [card] [Asset List](https://chainpatrol.com/docs/external-api/asset-list.md) > > Fetch our entire allowlist/blocklist for use in your own application. > [card] [Asset Changelog](https://chainpatrol.com/docs/external-api/asset-changelog.md) > > Fetch the latest changes to our allowlist/blocklist. > [card] [Create Dispute](https://chainpatrol.com/docs/external-api/dispute-create.md) > > Create a dispute for an asset that has been incorrectly flagged. > [card] [Configure Webhook](https://chainpatrol.com/docs/external-api/webhook-config.md) > > Receive real-time notifications instead of polling. ## Assets Look up, submit, scan, unblock, and follow individual assets. > [card] [Asset Check](https://chainpatrol.com/docs/external-api/asset-check.md) > > Check whether an asset is allowed or blocked. > [card] [Asset List](https://chainpatrol.com/docs/external-api/asset-list.md) > > Fetch the full allowlist/blocklist. > [card] [Asset Changelog](https://chainpatrol.com/docs/external-api/asset-changelog.md) > > Fetch recent allowlist/blocklist changes. > [card] [Asset Search](https://chainpatrol.com/docs/external-api/asset-search.md) > > Search across assets. > [card] [Asset Submit](https://chainpatrol.com/docs/external-api/asset-submit.md) > > Submit an asset for review. > [card] [Unblock Asset](https://chainpatrol.com/docs/external-api/asset-unblock.md) > > Unblock one of your assets, or open a dispute. > [card] [Asset Parse](https://chainpatrol.com/docs/external-api/asset-parse.md) > > Parse raw content into ChainPatrol asset types. > [card] [Start Asset Scan](https://chainpatrol.com/docs/external-api/asset-scan.md) > > Kick off a scan, optionally with a callback URL. > [card] [Get Scan Result](https://chainpatrol.com/docs/external-api/scan-result.md) > > Retrieve enrichments, checks, and labels for a scan. > [card] [Get Asset Details](https://chainpatrol.com/docs/external-api/asset-details.md) > > Deprecated — use Asset Check or Asset Search. > [card] [Follow Asset](https://chainpatrol.com/docs/external-api/asset-follow.md) > > Get emailed when an asset's status changes or its takedown completes. > [card] [Unfollow Asset](https://chainpatrol.com/docs/external-api/asset-unfollow.md) > > Stop the emails for an asset. > [card] [List Followed Assets](https://chainpatrol.com/docs/external-api/asset-follows-list.md) > > See every asset you follow, with its status and takedown. ## Reports > [card] [Creating Reports](https://chainpatrol.com/docs/external-api/creating-reports.md) > > Step-by-step guide to filing a report, with evidence files attached. > [card] [Create Report](https://chainpatrol.com/docs/external-api/report-create.md) > > File a report against a scam. > [card] [Upload Attachment](https://chainpatrol.com/docs/external-api/attachment-upload.md) > > Upload evidence files (`.eml`, screenshots, PDFs) and get a URL to attach to a report. > [card] [Search Reports](https://chainpatrol.com/docs/external-api/reports-search.md) > > Check for an existing report before creating a new one. ## Disputes > [card] [Create Dispute](https://chainpatrol.com/docs/external-api/dispute-create.md) > > Dispute an asset that has been incorrectly flagged. ## Webhooks > [card] [Configure Webhook](https://chainpatrol.com/docs/external-api/webhook-config.md) > > Receive real-time notifications for asset status updates and new suspected threats. ## Organization brands > [card] [List Organization Brands](https://chainpatrol.com/docs/external-api/organization-brands.md) > > 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. > [card] [List Assets](https://chainpatrol.com/docs/external-api/organization-assets-list.md) > > List your organization's assets. > [card] [Add Asset](https://chainpatrol.com/docs/external-api/organization-assets-add.md) > > Add an asset to your organization. > [card] [Update Asset](https://chainpatrol.com/docs/external-api/organization-assets-update.md) > > Update an organization asset. > [card] [Remove Asset](https://chainpatrol.com/docs/external-api/organization-assets-remove.md) > > Remove an organization asset. > [card] [List Asset Groups](https://chainpatrol.com/docs/external-api/organization-asset-groups-list.md) > > List your organization's asset groups. > [card] [Create Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-create.md) > > Create an asset group. > [card] [Update Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-update.md) > > Update an asset group. > [card] [Delete Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-delete.md) > > Delete an asset group. ## Organization reports > [card] [List Organization Reports](https://chainpatrol.com/docs/external-api/organization-reports-list.md) > > Retrieve your organization's reports (`GET /organization/reports`). > [card] [Get Organization Reports](https://chainpatrol.com/docs/external-api/organization-reports.md) > > Deprecated — use List Organization Reports. ## Threat detection List suspected threats, inspect their sources, and manage the detection configs that find them. > [card] [List Suspected Threats](https://chainpatrol.com/docs/external-api/detection-list.md) > > List unconfirmed results from automated detection. > [card] [List Detection Sources](https://chainpatrol.com/docs/external-api/detection-sources-list.md) > > Discover the sources you can configure and their config schemas. > [card] [List Detection Configs](https://chainpatrol.com/docs/external-api/detection-configs-list.md) > > List detection sources and their configs. > [card] [Create Detection Config](https://chainpatrol.com/docs/external-api/detection-configs-create.md) > > Create a new config for a source. > [card] [Update Detection Config](https://chainpatrol.com/docs/external-api/detection-configs-update.md) > > Change a config's status, schedule, or fields. > [card] [Delete Detection Config](https://chainpatrol.com/docs/external-api/detection-configs-delete.md) > > Delete an org-scoped config so it stops scanning. > [card] [Run Detection Configs](https://chainpatrol.com/docs/external-api/detection-configs-run.md) > > Run one or many configs on demand. > [card] [Validate Detection Configs](https://chainpatrol.com/docs/external-api/detection-configs-validate.md) > > Check configs against their recent results. > [card] [Detection Drift](https://chainpatrol.com/docs/external-api/detection-drift.md) > > Surface zero-result, noisy, and stale configs. > [card] [List Threats](https://chainpatrol.com/docs/external-api/threats-list.md) > > List threats for your organization. ## Dark Web Search leaked credentials for targets already tracked by a brand. > [card] [List Dark Web Credential Targets](https://chainpatrol.com/docs/external-api/dark-web-credentials-targets.md) > > Find the email domains, email addresses, and wallet addresses available to search. > [card] [Search Dark Web Credentials](https://chainpatrol.com/docs/external-api/dark-web-credentials-search.md) > > Search for leaked credentials tied to a tracked target. ## Takedowns > [card] [List Takedowns](https://chainpatrol.com/docs/external-api/takedowns-list.md) > > List takedowns for your organization. ## Metrics > [card] [Get Metrics Summary](https://chainpatrol.com/docs/external-api/metrics-summary.md) > > Customer-facing metrics and blocked threat breakdowns for a date range. > [card] [Get Metrics Breakdown](https://chainpatrol.com/docs/external-api/metrics-breakdown.md) > > Blocked threat counts grouped by day, asset type, or brand. > [card] [Get Found Threats Count](https://chainpatrol.com/docs/external-api/metrics-found.md) > > The default `found` metric — customer-facing new threats. > [card] [Get Blocked Threats by First-Report Source](https://chainpatrol.com/docs/external-api/metrics-found-by-source.md) > > Blocked threat counts split by who reported them first — you or ChainPatrol. > [card] [List Organization Metrics](https://chainpatrol.com/docs/external-api/organization-metrics-list.md) > > Retrieve your organization's metrics (`GET /organization/metrics`). > [card] [Get Organization Metrics](https://chainpatrol.com/docs/external-api/organization-metrics.md) > > Deprecated — use List Organization Metrics. ## Account and access > [card] [Validate API Key](https://chainpatrol.com/docs/external-api/validate.md) > > Check whether an API key is valid. > [card] [Get Current User](https://chainpatrol.com/docs/external-api/user-me.md) > > Details of the authenticated user. > [card] [Update Current User](https://chainpatrol.com/docs/external-api/user-me-update.md) > > Update the authenticated user's profile and settings. > [card] [List User Organizations](https://chainpatrol.com/docs/external-api/user-orgs.md) > > Organizations the caller can access, with services and integrations. > [card] [Get User Organization](https://chainpatrol.com/docs/external-api/user-orgs-get.md) > > Fetch a single organization by slug. ## Operations > [card] [Queue Snapshot](https://chainpatrol.com/docs/external-api/operations-queues-snapshot.md) > > 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: > [card] [List Healthchecks](https://chainpatrol.com/docs/external-api/healthchecks-list.md) > > The registry of available healthchecks — only call the ones where `implemented` is > true. The individual checks: * [Silent Detection Configs](https://chainpatrol.com/docs/external-api/healthchecks-detections-silent-configs.md) — enabled configs producing too few recent results * [Reviewing Backlog](https://chainpatrol.com/docs/external-api/healthchecks-reviewing-backlog.md) — pile-up of unreviewed proposals * [Old Proposals in Review](https://chainpatrol.com/docs/external-api/healthchecks-reviewing-old-proposals.md) — proposals waiting past the age thresholds * [TODO Takedown Volume](https://chainpatrol.com/docs/external-api/healthchecks-takedowns-todo-volume.md) — pile-up of takedowns in `TODO` * [IN\_PROGRESS Takedown Volume](https://chainpatrol.com/docs/external-api/healthchecks-takedowns-in-progress-volume.md) — pile-up of takedowns in `IN_PROGRESS` * [Stale IN\_PROGRESS Takedowns](https://chainpatrol.com/docs/external-api/healthchecks-takedowns-stale-in-progress.md) — takedowns stuck past the staleness threshold * [Cancelled Takedown Count](https://chainpatrol.com/docs/external-api/healthchecks-takedowns-cancelled-count.md) — excess cancellations over a rolling window * [Automated Takedowns Disabled](https://chainpatrol.com/docs/external-api/healthchecks-takedowns-automation-off.md) — automation off for too long * [Dead Asset Spike](https://chainpatrol.com/docs/external-api/healthchecks-assets-dead-asset-spike.md) — spike in assets detected as dead * [Missing Contact URL](https://chainpatrol.com/docs/external-api/healthchecks-organization-missing-contact-url.md) — no main communication channel configured > [!NOTE] > > Two `POST` endpoints are deprecated and kept only for backwards compatibility: > [`/public/getOrganizationReports`](https://chainpatrol.com/docs/external-api/organization-reports) — use > [`GET /organization/reports`](https://chainpatrol.com/docs/external-api/organization-reports-list) — and > [`/public/getOrganizationMetrics`](https://chainpatrol.com/docs/external-api/organization-metrics) — use > [`GET /organization/metrics`](https://chainpatrol.com/docs/external-api/organization-metrics-list). > [`POST /asset/details`](https://chainpatrol.com/docs/external-api/asset-details) is deprecated in the spec itself. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.