Skip to main content

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.

​
What Is Shoal?

Shoal is an API-first, AI-first semantic data layer for crypto intelligence. It resolves messy names into canonical entities, attaches events, timelines, research, media, and relationships to those entities, and exposes the result through API, CLI, and MCP. Most users should start with:
  • /v1/entities/byName to resolve a name into a stable Shoal entity id
  • /v1/timeline/byOrganizationId to inspect recent history for one resolved entity
  • /v1/search when they want broader topic or narrative discovery before choosing an entity

​
Who It’s For

  • Traders and researchers building entity-aware workflows
  • Bot and app developers wiring agents, alerts, and copilots
  • Data teams enriching internal systems with structured crypto intelligence

​
Core Concepts

  • Entities: canonical Shoal records for protocols, companies, funds, issuers, and public actors
  • Relationships: direct connections between canonical entities
  • Timeline: the recent ordered event history for one entity
  • Search: broad discovery across events, narratives, and market context
  • Radar and Signal: feed-style projections over the same underlying semantic layer
Shoal is designed so you can move from a human name like Ethereum or Binance to a stable Shoal entity id, then traverse its relationships, recent timeline, and attached context without building your own resolution layer first. The older organizations/* routes still exist for compatibility, but the entity family is the canonical direction for new integrations.

​
Start Here

  • Use Quickstart if you want to make a request in a few minutes.
  • Use API Reference if you already know which endpoint you need.
  • Use Integrations if you want Shoal inside an agent, bot, or workspace tool.

​
Base URL

https://api.shoal.xyz/v1