API limits: Requests and results

Requests and results limits are defined in your contract and help manage system resources while ensuring usage across all users.
Depending on your needs, we can set request limits by second, minute, day, week, or month. Additionally, a limit may be applied to the maximum results per response.

Maximum results per response

For the Autosuggest API and Documents API, the results limit determines the maximum number of items that a single API response can contain.
There is a default limit set to 10 for the Autosuggest API and 30 for the Documents API.

  • If the maximum results per response for the Autosuggest API is 10, each request will return a maximum of 10 suggested terms.
  • If the maximum results per response for the Documents API is 30, you will get a maximum of 30 documents per request.

This is sufficient for most applications, but if your team needs more, please contact us. 

We currently do not offer paging. However, if you want to retrieve a larger data set for your query without exceeding the result limit, you may either use the date_from and date_to parameters in the Documents API to filter results within a specific timeframe or continuously monitor the response of a given query over time.

Request limits 

Every interaction with the MAPEGY API that retrieves data is considered a data request.

Working with the Panel API often requires more requests due to the interactive nature of the interface: Each panel load counts as 2 requests. The first request is the HTML load, which displays the panel's structure. The second request is the table load, which retrieves and populates the data displayed in the panel. If a panel includes a trend chart, loading it adds 1 more request, as the system needs to retrieve and render the trend data separately.

Requests and filters

Most filters in the interface work on the client side, meaning that they are applied to already loaded data, which doesn’t generate additional requests.
However, server-side filters require the panel to reload with new content, which counts as additional requests. Similarly, some filter options may be loaded via the API too. 

Server-side filters that trigger new requests:

  • Time filter using trend charts (News, Patents, Research, Projects, Investments panels)
  • Genre (News)
  • Source (News)
  • Tag (News)
  • Patent office (Patents panel). Opening this filter will count as 1 request as it loads its options from the server to show estimated patent counts per office. 
  • Granted (Patents)
  • Publisher (Research)
  • Series (Research)
  • Type (Research) 
  • Grantor (Projects)
  • Publisher (Standards)
  • Ranking Type (Companies, Startups and Public institutions)
  • Country (Projects, Companies, Public Institutions, Startups panels)
  • City (Companies, Public Institutions, Startups panels)

Example: A user loads the Patents panel, opens the Patent office filter, and selects options to reload the panel.

  1. User loads the Patent Panel: 3 requests (HTML + table + trend chart)
  2. User opens the Patent Office filter: 1 request
  3. User selects a filter, causing the panel to reload: 2 requests (table + trend chart reload)

Total Requests: 6. 

Monitor remaining requests

You can monitor your usage and remaining requests directly in the API Demo Page, and in the response header of the panel. After running test queries, you’ll see:

  • Your assigned request limits (based on your contract).
  • The remaining requests are available for the given period (day, week, or month).

 If your request limit is exceeded, the server will respond with status code 429 (too many requests).

Related articles