REST API integration
Pull competitors, events, and plan info into your own systems.
Some teams want competitor signal inside the data warehouse, the internal admin tool, or the analyst notebook. The REST API exposes the same data the dashboard renders, with a stable JSON shape and offset/limit pagination on the events feed. It is the right surface when you need to join competitor events against your own pipeline data, or build a custom view your team already has muscle memory for.
What it does
- List and filter the competitors and events the dashboard shows, with the same severity, confidence, and source-link metadata.
- Manage the competitor set programmatically — POST a new competitor, PATCH its name, domain, aliases, or description, or DELETE one — with the same authorisation rules the dashboard enforces. Tracked URLs for a competitor are added and removed via the separate /sources endpoints.
- Read your workspace's current plan, seat count, and limits to gate features inside your own product or analytics layer.
- Bearer-token authentication using the same JWT the web app uses — issued by POST /auth/login and sent as Authorization: Bearer.
- JSON throughout, with consistent error envelopes and ISO-8601 timestamps in UTC. The events feed supports offset/limit pagination (?offset=&limit=, capped at 200); /competitors returns the full workspace list in one response.
Try it now
Three live endpoints to copy-paste. The full reference documents every endpoint with parameters, request bodies, and responses, generated from /openapi.json.
List the competitors in your workspace
Returns each tracked competitor with its discovery state and source count.
curl https://api.competitorintelligence.co/competitors \
-H "Authorization: Bearer $CI_API_TOKEN"Get the most recent events
Returns the live feed sorted by detected_at — pricing, product, hiring, and narrative shifts.
curl "https://api.competitorintelligence.co/events?limit=20" \
-H "Authorization: Bearer $CI_API_TOKEN"Read your current plan and seat usage
Returns the active plan, seat count, and the limits you are operating against.
curl https://api.competitorintelligence.co/me/plan \
-H "Authorization: Bearer $CI_API_TOKEN"How to set it up
During beta, the API is authenticated with the same JWT the web app uses. A first-class long-lived API token panel — with prefix display, rotation, and revocation — is on the roadmap and will land before we leave beta.
- 1Get a token by hitting POST /auth/login with your email and password — the response is { "access_token": "<jwt>" }. Anything that can call the dashboard can call the API.
- 2Export it as CI_API_TOKEN in your environment, then run any of the examples above.
- 3Read the OpenAPI spec at /openapi.json to discover every available endpoint and the JSON schema of each response.
- 4Tokens expire on the same schedule as the web app session. Hit /auth/login again to rotate; we'll add explicit rotation and revocation when the API token panel ships.
Available on the Growth plan and above.
See pricing →Add a competitor in two minutes.
First material change typically lands Under 24h. No credit card. Public sources only.