Authentication

All API endpoints require authentication using either:

You’ll need to include the key or token in the request headers for all API calls.

Workspace API Key

Find your API key in your workspace settings. Create one with the appropriate scope if you don’t have one yet.

Workspace API keys require a Scale or Enterprise plan. Upgrade your workspace to create one.

To access the Profiles and Query API, include your workspace API key in your request headers as a Bearer token:

Authorization: Bearer <your_workspace_api_key>

When creating a Workspace API Key, select the scopes your key needs. Each API endpoint requires a specific scope.

Scope	Description
`profiles:read`	Search and get wallet profiles
`profiles:write`	Import wallet addresses (requires profiles:read)
`query:read`	Execute SQL analytics queries
`alerts:read`	List and get alerts
`alerts:write`	Create, update, delete alerts (requires alerts:read)
`boards:read`	List and get boards and charts
`boards:write`	Create, update, delete boards and charts (requires boards:read)
`contracts:read`	List contracts
`contracts:write`	Create, update, delete contracts (requires contracts:read)
`segments:read`	List segments
`segments:write`	Create and delete segments (requires segments:read)

Write scopes automatically require the corresponding read scope. Create keys with the required scopes in Team Settings > API Keys.

Find your SDK Write Key in your project settings.

To send events through the Events API, include the SDK Write Key in your request headers:

Authorization: Bearer <token>