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 example POST /v1/news/brand_links.
  • POST /v1/{tool}, for example POST /v1/news_brand_links.
  • GET /v1/tools lists the tools.
  • GET /v1/health reports 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 needs api: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: Bearer header: a personal token or an OAuth access token. The API needs the scope api:read. A tool that changes data also needs api:write. A missing or invalid token returns HTTP 401 unauthorized. See Authentication.
  • Daily limits. The 14 news_ and prospects_ 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_left shows the calls left today. A call over a count is refused with daily_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, and ping are 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, and taxonomy_taxonomies.
  • One search at a time. Only one index search runs at a time for each account. A call to a news_ or prospects_ tool made while another index search runs is refused with one_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, and campaigns_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, and ping are in the log with counted false. A call of account_calls_left through the API or MCP is never logged. account_usage and 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_ and prospects_ 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_left has 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_at in the response from POST /v1/account/calls_left gives the time in UTC.
  • A results_limit above 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 send results_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 scope api:write. When a scope is missing, the response also has a WWW-Authenticate header with error="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)

Backlinks (2)

Campaigns (21)

Link Graph (1)

LLM Answers (3)

News Index (7)

Prospect Index (7)

Site Info (1)

Taxonomies (3)

Types (2)