Get an API Key
- Sign in at https://app.shoal.xyz
- Create an API key and copy it somewhere secure
https://api.shoal.xyz/v1
Install the CLI (Optional)
The fastest way to explore the API — no code required.Make Your First Request
Test Request (Python)
Test Request (JavaScript)
Next Steps
- Browse organizations:
/v1/organizations/all - Get radar events:
/v1/radar/all?since=2026-02-01T00:00:00Z - Get scored signals:
/v1/signal/all?since=2026-02-01T00:00:00Z - Get top signals:
/v1/signal/top - Filter by category:
/v1/radar/byCategory?category=partnership
The
since parameter is required on /v1/radar/all and /v1/signal/all. Use an ISO 8601 timestamp (e.g. 2026-02-01T00:00:00Z).Common Errors
- 400 Bad Request: missing required parameter (e.g.,
since,id,category) or invalid timestamp - 401 Unauthorized: missing or malformed Authorization header
- 403 Forbidden: invalid API key
- 404 Not Found: invalid endpoint path
- 429 Too Many Requests: rate limit exceeded (100 req/min per key)
- 500 Internal Server Error: temporary issue; retry with backoff