Overview
Exchanges, trading desks, and portfolio managers need structured intelligence on listed assets. Shoal’s entity model lets you map tokens and projects to organizations and monitor them for regulatory, security, and development events — all through a single API.You’ll need an API key to follow along. See the Quickstart guide to create one.
Endpoints Used
Workflow
Step 1: Map Your Portfolio
Resolve each asset to a Shoal org ID via name lookup and store the mapping.cURL
Python
JavaScript
Step 2: Batch-Poll for Updates
Use/v1/brief/batch with all org IDs and since for efficient single-call monitoring when batch brief is available on your plan.
cURL
Python
JavaScript
Step 3: Filter by Risk Category
Use/v1/radar/byCategory for regulation_legal and security_incident to surface compliance-relevant events.
cURL
Python
JavaScript
Example Output
The/v1/brief/batch response groups events by organization. See the full schema for all available fields.
Tips
The
since parameter is required on batch and polling endpoints. Always pass it to avoid fetching stale data.- Use
compact=trueon batch calls to reduce payload size. - Poll regulatory categories (
regulation_legal,security_incident) more frequently than general radar — these events often require immediate action. - Use
/v1/organizations/:id/signal-historyto detect unusual activity on a specific asset before it hits mainstream news. - The batch endpoint supports up to 25 org IDs per call — group assets by priority tier if you have more.