Katalyst provides a RESTful API for Pro and Enterprise users who want to build custom integrations, automate workflows, or feed trade data into external systems. The API follows standard REST conventions with JSON request and response bodies.
To get started, generate an API key in Settings under the Integrations tab. Click “Create API Key,” give it a name, and select the scopes (permissions) it needs: read trades, write trades, read analytics, manage connections, etc. The key is displayed once — copy it and store it securely. You can revoke a key at any time if it is compromised.
The API supports the following resources: trades (list, create, update, delete), accounts (list, create), analytics (equity curve, P&L summary, metrics), connections (list, status), and groups (list, members, shared trades). Each endpoint is documented with request and response examples.
Authentication is done via the Authorization header using a Bearer token. All requests must be made over HTTPS. The API enforces rate limits of 100 requests per minute for Pro users and 500 per minute for Enterprise users. If you exceed the limit, you will receive a 429 status code with a Retry-After header.
Webhooks are not managed through the API. Group webhooks — which post to Slack, Discord, or a custom endpoint — are configured on each trading group’s Webhooks page; see the Webhook Setup Guide for details. Full API documentation, including OpenAPI/Swagger specs, is available at docs.katalyst.app.