Documentation / API / Authentication and Limits
Authentication and Limits
POSThttps://api.oppalerts.com/v1/{group}/{endpoint}
The base URL, tokens, daily limits, and errors for the OppAlerts API.
Base URL and routes
The API is at https://api.oppalerts.com/v1/. Each tool
responds on two routes. Both return the same response.
POST /v1/{group}/{endpoint}, for examplePOST /v1/news/brand_links.POST /v1/{tool}, for examplePOST /v1/news_brand_links.GET /v1/toolslists the tools.GET /v1/healthreports whether the API is up.
The request body is JSON. Each tool’s API page lists its parameters.
Authentication
Send a token in the Authorization header:
POST /v1/account/calls_left HTTP/1.1
Host: api.oppalerts.com
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{}
- Create a personal token at oppalerts.com/app/account/api_tokens.
It starts with
pat_live_. You choose whether it expires after 30, 90, or 365 days, or never. The default is 90 days. - The API needs the scope
api:read. A route that changes a campaign also needsapi:write. See Authentication. - An OAuth access token also works. OAuth 2.0 with PKCE is at
https://auth.oppalerts.com. Authentication has the details.
Rules for every call
- Authentication. Every call needs a token in the
Authorization: Bearerheader: a personal token or an OAuth access token. The API needs the scopeapi:read. A tool that changes data also needsapi:write. A missing or invalid token returns HTTP 401unauthorized. See Authentication. - Daily limits. The 14
news_andprospects_tools are index searches. All index searches for an account share one daily count. Every other tool has a daily count of its own. Team members use the account’s counts. The counts reset every day at 04:00 New York time.account_calls_leftshows the calls left today. A call over a count is refused withdaily_limit(HTTP 429). - What counts. Each tool call through the API or MCP uses one call from its daily count. A refused call with an HTTP status from 400 to 499 uses no daily call. Two responses are not refusals and use one call: a search stopped by the index (HTTP 422), and a server error (HTTP 500 to 599). The MCP messages
initialize,tools/list, andpingare not tool calls and use no daily call. Calls from web app pages use the same counts, except when one of these 12 tools reads data from your own account:campaigns_list,campaigns_settings,campaigns_organizations,campaigns_saved_opportunities,campaigns_dashboard,account_usage,account_team_members,account_calls_left,llm_answers_content_phrases,llm_answers_search_keywords,llm_answers_top_sites, andtaxonomy_taxonomies. - One search at a time. Only one index search runs at a time for each account. A call to a
news_orprospects_tool made while another index search runs is refused withone_at_a_time(HTTP 429) and uses no daily call. Wait a few seconds and send it again. - One change at a time. Only one change runs at a time for each account. A call to one of the 16 tools that change data, made while another change is running for the account, is refused with
one_at_a_time(HTTP 429) and uses no daily call. Send it again after a few seconds. The 16 tools:campaigns_create,campaigns_update,campaigns_finalize,campaigns_archive,campaigns_activate,campaigns_rerun_research,campaigns_rebuild_counts,campaigns_set_taxonomy_presets,campaigns_set_daily_opportunities_email,campaigns_organization_add,campaigns_organization_update,campaigns_organization_delete,campaigns_saved_opportunity_add,campaigns_saved_opportunity_update,campaigns_saved_opportunity_archive, andcampaigns_saved_opportunity_activate. - Request log. Each tool call with a valid token is written to the account’s request log: the time, the source, the token, the tool, the HTTP status, and whether it used a daily call. Refused calls are also logged. The MCP messages
initialize,tools/list, andpingare in the log withcountedfalse. A call ofaccount_calls_leftthrough the API or MCP is never logged.account_usageand the Usage page of the web app show the log for the last 14 days.
Limits
- Index searches per day, shared by the 14
news_andprospects_tools: OppAlerts 250, 300. OppAlerts 500, 1,000. OppAlerts 1000, 3,000. The free account, 10. - Each other tool, per day: OppAlerts 250, 300. OppAlerts 500, 1,000. OppAlerts 1000, 3,000. The free account, 10.
POST /v1/account/calls_lefthas more: OppAlerts 250, 3,000. OppAlerts 500, 10,000. OppAlerts 1000, 30,000. The free account, 100. - The counts reset every day at 04:00 New York time.
resets_atin the response fromPOST /v1/account/calls_leftgives the time in UTC. - A
results_limitabove your plan’s maximum is refused, and the error gives that maximum. On the free account the maximum of an index search is 100. When you do not sendresults_limit, the answer has at most 100 rows. - A request body is at most 1 MB (1,048,576 bytes). A larger body is refused with HTTP 413
request_body_too_large.
Errors
An error response has this body and the HTTP status of the error:
{"error": "no_campaign", "error_description": "That campaign is not in this account."}
bad_param(HTTP 400): a parameter is missing or out of range, a field is not accepted by the tool, or an optional field is sent with empty text, an empty list, or an empty object. The error names the field. A tool that needs a campaign returns this error when the call has none.unauthorized(HTTP 401): the token is missing or invalid.forbidden(HTTP 403): the token or the account has no API permissions, or a tool that changes a campaign is called with a token that does not have the scopeapi:write. When a scope is missing, the response also has aWWW-Authenticateheader witherror="insufficient_scope"and the scopes that the call needs.no_campaign(HTTP 404): the campaign is not in this account.daily_limit(HTTP 429): the daily count of this tool is used up.one_at_a_time(HTTP 429): another index search of the account is running, or, for a tool that changes data, another change of the account is running. Wait a few seconds and send the call again.backend_error(HTTP 502): a data server did not answer, or its answer could not be read. Send the call again later.db_error(HTTP 500): the data could not be read or saved. The sentence says which data.
All tools
The server has 50 tools, in 10 groups. Each tool has an MCP page and an API page.
Account (3)
POST /v1/account/calls_left(account_calls_left): Calls Left TodayPOST /v1/account/team_members(account_team_members): Team MembersPOST /v1/account/usage(account_usage): Account Usage
Backlinks (2)
POST /v1/backlinks(backlinks): Backlinks of One or More SitesPOST /v1/backlinks/link_gap(backlinks_link_gap): Backlink Gap
Campaigns (21)
POST /v1/campaigns/activate(campaigns_activate): Activate a CampaignPOST /v1/campaigns/archive(campaigns_archive): Archive a CampaignPOST /v1/campaigns/create(campaigns_create): Create a CampaignPOST /v1/campaigns/dashboard(campaigns_dashboard): Campaign DashboardPOST /v1/campaigns/finalize(campaigns_finalize): Finalize a CampaignPOST /v1/campaigns/list(campaigns_list): Campaign ListPOST /v1/campaigns/organization_add(campaigns_organization_add): Add an OrganizationPOST /v1/campaigns/organization_delete(campaigns_organization_delete): Delete an OrganizationPOST /v1/campaigns/organization_update(campaigns_organization_update): Update an OrganizationPOST /v1/campaigns/organizations(campaigns_organizations): Campaign OrganizationsPOST /v1/campaigns/rebuild_counts(campaigns_rebuild_counts): Rebuild the Daily CountsPOST /v1/campaigns/rerun_research(campaigns_rerun_research): Run Stopped Research AgainPOST /v1/campaigns/saved_opportunities(campaigns_saved_opportunities): Saved OpportunitiesPOST /v1/campaigns/saved_opportunity_activate(campaigns_saved_opportunity_activate): Activate a Saved OpportunityPOST /v1/campaigns/saved_opportunity_add(campaigns_saved_opportunity_add): Add a Saved OpportunityPOST /v1/campaigns/saved_opportunity_archive(campaigns_saved_opportunity_archive): Archive a Saved OpportunityPOST /v1/campaigns/saved_opportunity_update(campaigns_saved_opportunity_update): Update a Saved OpportunityPOST /v1/campaigns/set_daily_opportunities_email(campaigns_set_daily_opportunities_email): Set the Daily Opportunities EmailPOST /v1/campaigns/set_taxonomy_presets(campaigns_set_taxonomy_presets): Set Taxonomy PresetsPOST /v1/campaigns/settings(campaigns_settings): Campaign SettingsPOST /v1/campaigns/update(campaigns_update): Update a Campaign
Link Graph (1)
POST /v1/linkgraph/history(linkgraph_history): PageRank History
LLM Answers (3)
POST /v1/llm_answers/content_phrases(llm_answers_content_phrases): AI Content PhrasesPOST /v1/llm_answers/search_keywords(llm_answers_search_keywords): AI Search KeywordsPOST /v1/llm_answers/top_sites(llm_answers_top_sites): Top Sites Named by AI
News Index (7)
POST /v1/news/brand_link_gap(news_brand_link_gap): News Link GapPOST /v1/news/brand_links(news_brand_links): News Pages Linking to BrandsPOST /v1/news/brand_mentions(news_brand_mentions): News Brand MentionsPOST /v1/news/opportunities(news_opportunities): News OpportunitiesPOST /v1/news/search(news_search): News SearchPOST /v1/news/similar_to_id(news_similar_to_id): Similar News PagesPOST /v1/news/unlinked_brand_mentions(news_unlinked_brand_mentions): News Unlinked Brand Mentions
Prospect Index (7)
POST /v1/prospects/brand_link_gap(prospects_brand_link_gap): Prospect Link GapPOST /v1/prospects/brand_links(prospects_brand_links): Prospect Pages Linking to BrandsPOST /v1/prospects/brand_mentions(prospects_brand_mentions): Prospect Brand MentionsPOST /v1/prospects/opportunities(prospects_opportunities): Prospect OpportunitiesPOST /v1/prospects/search(prospects_search): Prospect SearchPOST /v1/prospects/similar_to_id(prospects_similar_to_id): Similar Prospect PagesPOST /v1/prospects/unlinked_brand_mentions(prospects_unlinked_brand_mentions): Prospect Unlinked Brand Mentions
Site Info (1)
POST /v1/siteinfo/site(siteinfo_site): Site Contact Details
Taxonomies (3)
POST /v1/taxonomy/categories(taxonomy_categories): Taxonomy CategoriesPOST /v1/taxonomy/semantic_content_analyzer(taxonomy_semantic_content_analyzer): Semantic Content AnalyzerPOST /v1/taxonomy/taxonomies(taxonomy_taxonomies): Available Taxonomies
Types (2)
POST /v1/types/content_types(types_content_types): Content TypesPOST /v1/types/opportunity_types(types_opportunity_types): Opportunity Types