All API endpoints require authentication using either:Documentation Index
Fetch the complete documentation index at: https://docs.formo.so/llms.txt
Use this file to discover all available pages before exploring further.
- a Workspace API Key to query data and fetch profiles
- a SDK Write Key to send events
Workspace API Key
Find your API key in your workspace settings. Create one with the appropriate scope if you don’t have one yet.
API Scopes
When creating a Workspace API Key, select the scopes your key needs. Each API endpoint requires a specific scope.| Scope | Description | Required Plan |
|---|---|---|
profiles:read | Search and get wallet profiles | Scale / Enterprise |
profiles:write | Import wallet addresses (requires profiles:read) | Scale / Enterprise |
query:read | Execute SQL analytics queries | Scale / Enterprise |
mcp:read | MCP protocol access | Scale / Enterprise |
alerts:read | List and get alerts | Scale / Enterprise |
alerts:write | Create, update, delete alerts (requires alerts:read) | Scale / Enterprise |
boards:read | List and get boards and charts | Growth / Scale / Enterprise |
boards:write | Create, update, delete boards and charts (requires boards:read) | Growth / Scale / Enterprise |
contracts:read | List contracts | Growth / Scale / Enterprise |
contracts:write | Create, update, delete contracts (requires contracts:read) | Growth / Scale / Enterprise |
segments:read | List segments | Growth / Scale / Enterprise |
segments:write | Create and delete segments (requires segments:read) | Growth / Scale / Enterprise |
Write scopes automatically require the corresponding read scope. Profiles, Query, MCP, and Alerts scopes require a Scale or Enterprise plan; Boards, Contracts, and Segments scopes require Growth or above. Create keys with the required scopes in Team Settings > API Keys.
SDK Write Key
Find your SDK Write Key in your project settings.