For Developers
This section is for external integrators and technical reviewers — partners building on Surplus data, enterprise teams evaluating the platform, and connector authors wiring up MCP clients.
If you need to understand Surplus from an operator's perspective first, start with the Platform overview. This section assumes that context and focuses on how the system is structured and how to connect to it.
What you can integrate with
| Surface | Best for | Auth |
|---|---|---|
| MCP | AI assistants and read-only analytics tooling | OAuth 2.1 Bearer token (admin and advisor users) |
The web app's own API is not a public API; App API explains how it works and what that means for integrations.
Surplus is not an open-source project. These docs describe the public integration surfaces and enough architecture to use them responsibly — not internal contribution workflows.
Recommended reading order
- System architecture — components, trust boundaries, and how data flows
- Domain model — the entities and events you'll see in API responses
- App API — how the app's server calls work, auth, errors, and rate limits
- MCP integration — OAuth setup, tools, and resources (if you're building a connector)
Security and compliance
Reviewers evaluating authentication, access control, data handling, or infrastructure should read the Security & Compliance section. It complements this guide with the controls that protect the platform.
