Skip to main content
GET
/
v1
/
signal
/
byCategory
Get Signals by Category
curl --request GET \
  --url https://api.shoal.xyz/v1/signal/byCategory \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.shoal.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Returns scored signal events filtered to a single event category. Use this when you want high-signal events of a specific type — for example, only security_incident signals for a risk monitoring dashboard.

​
Query Parameters

  • category (string, required) — Event category (e.g. partnership, regulation_legal, product_development, market_update, security_incident)
  • limit (integer, default: 50, max: 50)
  • offset (integer, default: 0, max: 500)
  • since (string, optional) — ISO 8601 timestamp. Only return events newer than this time. See Polling Guide.
  • cursor (string, optional) — Opaque cursor token from a previous next_cursor response. When provided, since is required and offset is ignored.

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/signal/byCategory?category=partnership" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

Same as /v1/signal/all but filtered by category. Includes next_cursor (string or null) for cursor-based pagination.

​
Errors

  • 400 if category missing
  • 500 on internal server error