Documentation / API / account_calls_left

account_calls_left

POSThttps://api.oppalerts.com/v1/account/calls_left

How many calls this account has left today, from the server's own counts.

What it does

The tool returns the number of calls the account has left today. It reads the counts that the OppAlerts server keeps. It takes no parameters.

The response has these parts:

  • index_searches is the shared daily count for every news_ and prospects_ tool. It has used, limit, and left, plus tools, the list of tools that share the count.
  • tools holds every other tool with its own daily count. Each count has used, limit, and left.
  • resets_at is the next reset, in UTC.
  • unlimited is true for an administrator. An administrator has no limits, so the answer has no counts.

A limit of 0 means the tool is not included in the account’s plan.

Only one index search runs at a time for an account. A call to a news_ or prospects_ tool while another index search runs is refused (HTTP 429, one_at_a_time). Wait a few seconds and send the call again. A call of account_calls_left through the API or MCP counts against its own limit and is never logged.

Authentication

Send a token in the Authorization: Bearer header. Authentication and Limits explains the tokens.

Parameters

This tool has no parameters. Send an empty object.

Strict Rules

  • This tool accepts no fields. Any field you send is refused. The answer is HTTP 400 with the error code bad_param. The error names the field: "<field> is not a field of this tool."
  • An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error has only its own sentence.

Example

Request

curl -X POST https://api.oppalerts.com/v1/account/calls_left \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

The full sample answer. The unlimited field appears only for an administrator, and then the answer has no counts.

{
  "resets_at": "2026-11-07T09:00:00Z",
  "index_searches": {
    "used": 3,
    "limit": 10,
    "left": 7,
    "tools": [
      "news_search",
      "prospects_search",
      "news_brand_mentions"
    ]
  },
  "tools": {
    "account_calls_left": {
      "used": 2,
      "limit": 100,
      "left": 98
    },
    "backlinks": {
      "used": 0,
      "limit": 10,
      "left": 10
    },
    "campaigns_dashboard": {
      "used": 4,
      "limit": 100,
      "left": 96
    }
  },
  "unlimited": true
}

Errors

  • bad_param (HTTP 400): the request has a field. This tool accepts no fields, and the error names the field you sent.
  • daily_limit (HTTP 429): the account has used all its calls for this tool today. account_calls_left shows when the count resets.

This tool has its own daily count. A call through the API or MCP uses one call from this count. A web app page reading the same data does not count. It is not an index search, so it does not use the shared count of the news_ and prospects_ tools, and the error one_at_a_time does not apply to it.

Same tool in MCP

The MCP tool is account_calls_left. Read the MCP page.