Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Brain

Find competitors

Gives the Competitor watcher, or else the Researcher, a task: find the competitors of the business on the web. It suggests each one that it finds, for a person to add. While a search goes on, it answers with the task of that search. 5 an hour.

post/api/v1/brand/competitors/find

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy brand competitors-find
MCP tooltroopy_find_competitors
Rate limit5 calls in 3600 seconds, for each key

Response

202 · application/json
data*object
1 properties
task*string

The key of the task of the search

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.