# Shoal API

## Docs

- [Authentication](https://docs.shoal.xyz/api-reference/authentication.md): API key and pay-per-request authentication
- [Batch Brief](https://docs.shoal.xyz/api-reference/brief/batch.md): Get combined radar and signal events for multiple organizations in one call
- [Get Brief](https://docs.shoal.xyz/api-reference/brief/get-brief.md): Get combined radar and signal events for a single organization
- [Get All Categories](https://docs.shoal.xyz/api-reference/categories/get-all.md): List all event categories and subcategories
- [Get Entity by ID](https://docs.shoal.xyz/api-reference/entities/by-id.md): Get one canonical Shoal entity by id
- [Get Entity by Name](https://docs.shoal.xyz/api-reference/entities/by-name.md): Resolve a canonical Shoal entity by canonical name or alias
- [Get Entity Media](https://docs.shoal.xyz/api-reference/entities/media.md): List media-classified entity content for one Shoal entity
- [Get Entity References](https://docs.shoal.xyz/api-reference/entities/references.md): List external references attached to one Shoal entity
- [Get Entity Relationships](https://docs.shoal.xyz/api-reference/entities/relationships.md): List canonical relationships attached to one Shoal entity
- [Get Entity Research](https://docs.shoal.xyz/api-reference/entities/research.md): List research and commentary-classified entity content for one Shoal entity
- [Create Export Job](https://docs.shoal.xyz/api-reference/export/create-job.md): Request an explicit historical export job for enterprise workflows
- [Get Export Job](https://docs.shoal.xyz/api-reference/export/get-job.md): Retrieve one export job by id
- [List Export Jobs](https://docs.shoal.xyz/api-reference/export/list-jobs.md): List export jobs requested by the current authenticated account
- [Get Organization by ID](https://docs.shoal.xyz/api-reference/organizations/by-organization-id.md): Get canonical organization info by ID
- [Get Organization by Name](https://docs.shoal.xyz/api-reference/organizations/by-organization-name.md): Resolve an organization by canonical name or alias
- [Get All Organizations](https://docs.shoal.xyz/api-reference/organizations/get-all.md): Get all organizations
- [Signal History](https://docs.shoal.xyz/api-reference/organizations/signal-history.md): Get daily signal and radar activity for an organization
- [Get Radar by Category](https://docs.shoal.xyz/api-reference/radar/by-category.md): Get radar events filtered by event category
- [Get Radar by Organization ID](https://docs.shoal.xyz/api-reference/radar/by-organization-id.md): Get radar events for a specific organization by ID
- [Get All Radar](https://docs.shoal.xyz/api-reference/radar/get-all.md): Get all radar events
- [Get Global Replay](https://docs.shoal.xyz/api-reference/replay/global.md): Get a recent merged replay across radar and signal
- [Search Events](https://docs.shoal.xyz/api-reference/search/get.md): Search Shoal events by topic, organization, protocol, or narrative
- [Get Signals by Category](https://docs.shoal.xyz/api-reference/signal/by-category.md): Get signal items filtered by event category
- [Get Signals by Organization ID](https://docs.shoal.xyz/api-reference/signal/by-organization-id.md): Get signal events for a specific organization by ID
- [Get All Signals](https://docs.shoal.xyz/api-reference/signal/get-all.md): Get all signal events
- [Get Top Signals](https://docs.shoal.xyz/api-reference/signal/get-top.md): Get the highest-scoring signal events
- [Get Timeline by Entity ID](https://docs.shoal.xyz/api-reference/timeline/by-organization-id.md): Get a recent merged event timeline for a single Shoal entity
- [Get Usage Stats](https://docs.shoal.xyz/api-reference/usage.md): Get request usage statistics and budget info for your API key
- [Create Webhook](https://docs.shoal.xyz/api-reference/webhooks/create.md): Register a new webhook to receive real-time event notifications
- [Delete Webhook](https://docs.shoal.xyz/api-reference/webhooks/delete.md): Delete a webhook and all its delivery history
- [Get Webhook](https://docs.shoal.xyz/api-reference/webhooks/get.md): Get a single webhook with recent delivery history
- [List Webhooks](https://docs.shoal.xyz/api-reference/webhooks/list.md): List all webhooks registered to your account
- [Update Webhook](https://docs.shoal.xyz/api-reference/webhooks/update.md): Update a webhook URL, event types, or active status
- [Best Practices](https://docs.shoal.xyz/guides/best-practices.md): Integration tips for reliability and performance
- [CLI Tool](https://docs.shoal.xyz/guides/cli.md): Query the Shoal API from your terminal
- [Errors](https://docs.shoal.xyz/guides/errors.md): Error responses, status codes, and troubleshooting
- [SDK Examples](https://docs.shoal.xyz/guides/examples.md): Code samples in cURL, Python, and JavaScript
- [Pagination](https://docs.shoal.xyz/guides/pagination.md): limit/offset pagination across list endpoints
- [Efficient Polling with since](https://docs.shoal.xyz/guides/polling.md): How to use the since parameter to only fetch new events
- [Rate Limits & Monthly Credits](https://docs.shoal.xyz/guides/rate-limits.md): Request limits, monthly credit system, and retry guidance
- [Versioning](https://docs.shoal.xyz/guides/versioning.md): API version and compatibility guidance
- [Webhooks](https://docs.shoal.xyz/guides/webhooks.md): Receive real-time push notifications for radar and signal events
- [Claude Code](https://docs.shoal.xyz/integrations/claude-code.md): Use Shoal in Claude Code through the Shoal plugin marketplace or hosted MCP
- [Claude Web](https://docs.shoal.xyz/integrations/claude-web.md): Connect Shoal to Claude Web with the hosted Shoal MCP connector
- [Claude for Work](https://docs.shoal.xyz/integrations/claude-work.md): Connect Shoal to Claude Team and Enterprise through workspace connectors
- [CLI + Skills](https://docs.shoal.xyz/integrations/cli-skills.md): Use Shoal from the terminal and install the Shoal skill locally
- [Hosted MCP](https://docs.shoal.xyz/integrations/mcp.md): Connect the hosted Shoal MCP server from Claude and other MCP clients
- [MPP/x402](https://docs.shoal.xyz/integrations/mpp.md): Pay-per-request API access through MPP and x402
- [OpenClaw](https://docs.shoal.xyz/integrations/openclaw.md): Use Shoal Intelligence as a data source for OpenClaw AI agents and autonomous workflows
- [Integrations Overview](https://docs.shoal.xyz/integrations/overview.md): Choose the right Shoal integration path for Claude, Claude Code, terminal workflows, and delivery channels
- [Slack](https://docs.shoal.xyz/integrations/slack.md): Push Shoal intelligence alerts to Slack channels with a bot that supports real-time events and slash commands
- [Telegram](https://docs.shoal.xyz/integrations/telegram.md): Deliver daily intelligence digests and real-time alerts to Telegram channels and groups
- [Shoal API Documentation](https://docs.shoal.xyz/introduction.md): The semantic data layer for crypto intelligence
- [Quickstart](https://docs.shoal.xyz/quickstart.md): Get an API key and make your first request
- [Business Development](https://docs.shoal.xyz/use-cases/business-development.md): Track partnerships, funding, and product updates to find opportunities
- [Exchange Asset Intelligence](https://docs.shoal.xyz/use-cases/exchange-asset-intelligence.md): Track news for exchange-listed assets via entity monitoring
- [Lead & Company Enrichment](https://docs.shoal.xyz/use-cases/lead-enrichment.md): Enrich CRM contacts with Shoal intelligence — match companies to tracked orgs and surface recent events
- [Prediction Market Intelligence](https://docs.shoal.xyz/use-cases/prediction-market-intelligence.md): Use entity tracking to surface news that moves prediction markets

## OpenAPI Specs

- [openapi](https://docs.shoal.xyz/openapi.json)