Connection

Monitorank API: Your SEO API

Integrate data into your tools or create custom reports.

Getting started

The Monitorank API is REST based and returns JSON. Every call is a plain HTTP request: no library, no SDK, no token to refresh.

Base URL
https://api.monitorank.com/

Authentication

Every call is authenticated with your API key, passed in the key parameter. You will find it in the application, API menu, where you can also renew it.

Write and delete are disabled by default. Write and delete methods only respond once you have enabled them in the application, API menu. Read methods are always available.

Units

Every call consumes API units, reported in the units field of the response. The Resources for the next 12 months method tells you how many you have left.

Response format

Every method returns a JSON object built on the same model.

{"result": true,"data": [{"id_project": 1042,"name": "My website"}],"units": 1,"time_execution": 0.041}
FieldDescription
resulttrue: the call succeeded. false: an error occurred.
errorWhen result is false, gives the reason for the error.
dataWhen result is true, holds the returned data.
unitsNumber of API units consumed by the call.
time_executionExecution time of the call, in seconds.
On error, result is false and error describes the cause: invalid key, write method disabled, missing parameter or resource not found.

Projects

List projects

Read

Returns the list of your projects. Project IDs are required by most of the other methods.

Request
https://api.monitorank.com/?key={API_KEY}&module=project&action=list

Create a project

Write

Creates a project. Each project holds several sites and several keyword trackings.

Request
https://api.monitorank.com/?key={API_KEY}&module=project&action=create&name={NAME}&top={TOP*}
ParameterDescription
namerequiredName of the project.
topoptionalNumber of results collected on Google: 50 or 100. TOP100 is billed 30% more.

Rename a project

Write

Changes the name of a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=project&action=rename&id_project={ID_PROJECT}&name={NAME}
ParameterDescription
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
namerequiredNew name of the project.

Delete a project

Delete

Deletes a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=project&action=delete&id_project={ID_PROJECT}
ParameterDescription
id_projectrequiredIDs of the projects to delete, separated by commas. Get the IDs with the List projects method.

Sites

List sites

Read

Returns the list of your tracked sites: your own, your competitors and the ones you watch.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=list&id_project={ID_PROJECT*}&id_entity={ID_ENTITY*}
ParameterDescription
id_projectoptionalID of the project. You can get the list of projects with the List projects method.
id_entityoptionalLimits the result to a single site.

Positions of a site

Read

Returns the positions of a site over the period of your choice.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=get&id_entity={ID_ENTITY}&period={PERIOD*}&id_filter={ID_FILTER*}&id_group={ID_GROUP*}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
periodoptionalTwo dates, start and end, in the YYYYMMDD-YYYYMMDD format. Without a period, the last 7 days are returned.
Example: 20260101-20260131
id_filteroptionalFilters the data. Get your filters with the List filters method. If a period is attached to the filter, it is applied.
id_groupoptionalReturns only the positions of that topic. Get your topics with the List topics method.

Returned positions carry a rank_type: see the list of position types.

Positions of a domain name

Read

Returns the positions of a domain over the period of your choice.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=get&url={URL}&period={PERIOD*}&id_filter={ID_FILTER*}
ParameterDescription
urlrequiredDomain or URL belonging to one of your sites.
periodoptionalTwo dates, start and end, in the YYYYMMDD-YYYYMMDD format. Without a period, the last 7 days are returned.
Example: 20260101-20260131
id_filteroptionalFilters the data. Get your filters with the List filters method. If a period is attached to the filter, it is applied.

Returned positions carry a rank_type: see the list of position types.

Create a site

Write

Creates a site inside a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=create&name={NAME}&id_project={ID_PROJECT}&url={URL}&type={TYPE}&brand={BRAND*}
ParameterDescription
namerequiredName of the site.
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
urlrequiredOne or more domains / addresses, separated by commas.
typerequiredType of the site: My sites, Competitors or To watch. If you renamed your types in the application, use your own labels.
brandoptionalOne or more brands attached to the site, separated by commas.

Brands attach to the site the Google AI Overview citations that mention a brand without a clickable link, where the URL alone cannot make the match.

Add a URL to a site

Write

Adds one or more URLs to an existing site.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=addUrl&id_entity={ID_ENTITY}&url={URL}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
urlrequiredOne or more domains / addresses, separated by commas.

Update the brands of a site

Write

Replaces the brands of an existing site. The other details of the site - name, URL, type - are left untouched.

Brands attach to the site the Google AI Overview citations that mention a brand without a clickable link, where the URL alone cannot make the match.

The brands you send replace the previous ones entirely, they are not added to them.
Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=updateBrand&id_entity={ID_ENTITY}&brand={BRAND}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
brandrequiredOne or more brands, separated by commas. To add a brand to the ones already in place, send the full list back: the old ones and the new one.

Rename a site

Write

Changes the name of a site.

Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=rename&id_entity={ID_ENTITY}&name={NAME}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
namerequiredNew name of the site.

Delete a site

Delete

Deletes a site.

The positions of the site are deleted.
Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=delete&id_entity={ID_ENTITY}
ParameterDescription
id_entityrequiredIDs of the sites to delete, separated by commas.

Delete a URL from a site

Delete

Deletes one or more URLs from a site.

The positions of those URLs are deleted.
Request
https://api.monitorank.com/?key={API_KEY}&module=entity&action=deleteUrl&id_entity={ID_ENTITY}&url={URL}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
urlrequiredOne or more URLs to delete, separated by commas.

Keyword tracking

List tracked keywords

Read

Returns the list of the keywords you track.

Request
https://api.monitorank.com/?key={API_KEY}&module=query&action=list&id_project={ID_PROJECT*}
ParameterDescription
id_projectoptionalID of the project. You can get the list of projects with the List projects method.

Positions of a tracked keyword

Read

Returns the positions of a tracked keyword over the period of your choice.

Request
https://api.monitorank.com/?key={API_KEY}&module=rank&action=get&id_query={ID_QUERY}&period={PERIOD}
ParameterDescription
id_queryrequiredID of the tracked keyword. Get the IDs with the List tracked keywords method.
periodrequiredTwo dates, start and end, in the YYYYMMDD-YYYYMMDD format.
Example: 20260101-20260131

Returned positions carry a rank_type: see the list of position types.

Tracking status by project

Read

Returns how far along the position trackings are, project by project. Handy to check whether today's positions are available before fetching them.

Request
https://api.monitorank.com/?key={API_KEY}&module=query&action=status

Export the SERP view of a keyword

Read

Downloads the SERP view of a keyword, in HTML, PNG or JPG format.

Request
https://api.monitorank.com/?key={API_KEY}&module=serp&action=export&id_query={ID_QUERY}&output={OUTPUT}
ParameterDescription
id_queryrequiredID of the tracked keyword. Get the IDs with the List tracked keywords method.
outputrequiredFormat of the returned file.
  • html HTML page of the SERP
  • png Screenshot in PNG format
  • jpg Screenshot in JPG format

Track keywords

Write

Adds keywords to the tracking of a project. Every site of the project tracks those keywords.

Request
https://api.monitorank.com/?key={API_KEY}&module=query&action=create&id_project={ID_PROJECT}&id_service={ID_SERVICE}&version={VERSION}&keywords={KEYWORDS}&group={GROUP}&device={DEVICE*}&id_location={ID_LOCATION*}
ParameterDescription
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
id_servicerequiredEngine on which to track the keywords.
  • 1 Google Search
  • 2 Google Images
  • 3 Google News
  • 4 Google Videos
  • 12 Google Maps
  • 6 Google Play Store
  • 8 YouTube
  • 11 Bing Search
  • 13 Yandex
  • 14 Baidu
versionrequiredLanguage and version of the service.
Google France: fr-fr - Google Switzerland in German: de-ch
keywordsrequiredKeywords to track, separated by commas.
grouprequiredName of the topic. If it does not exist, it is created. Several topics allowed, separated by commas.
deviceoptionalTracking devices, separated by commas. Defaults to desktop.
  • 1 Desktop
  • 2 Mobile
id_locationoptionalGeolocates the search, for every city worldwide. Several IDs allowed, separated by commas. Get the IDs with the Search for a location method.

Attach a tag to keywords

Write

Creates a tag if it does not exist, then attaches it to keywords.

Request
https://api.monitorank.com/?key={API_KEY}&module=tag&action=query&tag={TAG}&id_query={ID_QUERY}&color={COLOR*}
ParameterDescription
tagrequiredName of the tag.
id_queryrequiredIDs of the tracked keywords, separated by commas.
coloroptionalColour of the tag, in RGB format.

Delete keywords

Delete

Deletes one or more keyword trackings.

Every position of those keywords is deleted, for every site.
Request
https://api.monitorank.com/?key={API_KEY}&module=query&action=delete&id_query={ID_QUERY}
ParameterDescription
id_queryrequiredIDs of the tracked keywords, separated by commas.

Statistics

Statistics of a site

Read

Returns the statistics of a site: average position, visibility and TOP 1 / 3 / 10 / 30 / 100.

Request
https://api.monitorank.com/?key={API_KEY}&module=statistics&action=get&id_entity={ID_ENTITY}&period={PERIOD}
ParameterDescription
id_entityrequiredID of the site. You can get the list of sites with the List sites method.
periodrequiredTwo dates, start and end, in the YYYYMMDD-YYYYMMDD format.
Example: 20260101-20260131

Filters

List filters

Read

Returns the list of your filters.

Request
https://api.monitorank.com/?key={API_KEY}&module=filter&action=list

Create a filter

Write

Creates a filter with the criteria of your choice. The filter can then be applied to the methods returning positions.

Request
https://api.monitorank.com/?key={API_KEY}&module=filter&action=create&name={NAME}&period={PERIOD*}&device={DEVICE*}&ranks={RANKS*}&ranks_min={RANKS_MIN*}&ranks_max={RANKS_MAX*}&evolution={EVOLUTION*}&evolution_min={EVOLUTION_MIN*}&evolution_max={EVOLUTION_MAX*}&id_service={ID_SERVICE*}&id_entity={ID_ENTITY*}&rank_type={RANK_TYPE*}
ParameterDescription
namerequiredName of the filter.
periodoptionalForces a period inside the filter. It will apply automatically every time the filter is used.
  • last_2 Yesterday / today
  • last_7 Last 7 days
  • last_30 Last 30 days
  • last_90 Last 90 days
  • last_365 Last 365 days
  • last_week Previous week
  • last_month Previous month
  • last_3_month Previous 3 months
  • last_12_month Previous 12 months
  • last_year Previous year
  • current_month Current month
  • current_year Current year
deviceoptionalFilters the data by device.
  • 1 Desktop
  • 2 Mobile
  • 3 Tablet
ranksoptionalKind of filter on positions.
  • ranks Positions
  • in New entry
  • out New exit
ranks_minrequired with ranksLowest value of the filter.
ranks_maxrequired with ranksHighest value of the filter.

Example - new entries in the TOP 10: ranks=in&ranks_min=1&ranks_max=10
evolutionoptionalKind of filter on the change in position.
  • up Rise
  • down Drop
evolution_minrequired with evolutionLowest value of the filter.
evolution_maxrequired with evolutionHighest value of the filter.

Example - strong rises, at least 10 places: evolution=up&evolution_min=10&evolution_max=100
id_serviceoptionalFilters the data by service.
  • 1 Google Search
  • 2 Google Images
  • 3 Google News
  • 4 Google Videos
  • 12 Google Maps
  • 6 Google Play Store
  • 8 YouTube
  • 11 Bing Search
  • 13 Yandex
  • 14 Baidu
id_entityoptionalCompares the positions with other sites. Several values allowed, separated by commas.
rank_typeoptionalCompares your positions with other position types: featured snippets, ads, AI Overviews… See the list of position types.

Rename a filter

Write

Changes the name of a filter.

Request
https://api.monitorank.com/?key={API_KEY}&module=filter&action=rename&id_filter={ID_FILTER}&name={NAME}
ParameterDescription
id_filterrequiredID of the filter. Get the IDs with the List filters method.
namerequiredNew name of the filter.

Delete a filter

Delete

Deletes a filter. Positions are left untouched.

Request
https://api.monitorank.com/?key={API_KEY}&module=filter&action=delete&id_filter={ID_FILTER}
ParameterDescription
id_filterrequiredID of the filter. Get the IDs with the List filters method.

Topics

List topics

Read

Returns the topics of your account or of a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=group&action=list&id_project={ID_PROJECT*}
ParameterDescription
id_projectoptionalID of the project. You can get the list of projects with the List projects method.

Create a topic

Write

Creates one or more topics inside a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=group&action=create&id_project={ID_PROJECT}&name={NAME}
ParameterDescription
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
namerequiredName of the topic. Several topics allowed, separated by commas.

Rename a topic

Write

Changes the name of a topic.

Request
https://api.monitorank.com/?key={API_KEY}&module=group&action=rename&id_group={ID_GROUP}&name={NAME}
ParameterDescription
id_grouprequiredID of the topic. You can get the list of topics with the List topics method.
namerequiredNew name of the topic.

Delete a topic

Delete

Deletes a topic. The keywords attached to it are not deleted.

Request
https://api.monitorank.com/?key={API_KEY}&module=group&action=delete&id_group={ID_GROUP}
ParameterDescription
id_grouprequiredID of the topic. You can get the list of topics with the List topics method.

Audits

List audits

Read

Returns the audits of your account. An up-to-date audit has the processed status.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=list&id_project={ID_PROJECT*}&id_audit={ID_AUDIT*}
ParameterDescription
id_projectoptionalID of the project. You can get the list of projects with the List projects method.
id_auditoptionalLimits the result to a single audit.

Keywords of an audit

Read

Returns the list of the keywords of an audit.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=query&id_audit={ID_AUDIT}
ParameterDescription
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.

Positions of an audit

Read

Returns the positions of every run of an audit. An up-to-date audit has the processed status.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=ranks&id_audit={ID_AUDIT}&id_entity={ID_ENTITY}&top={TOP*}&rank_type_all={RANK_TYPE_ALL*}&last_exec={LAST_EXEC*}&id_exec={ID_EXEC*}
ParameterDescription
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.
id_entityrequiredID of the site whose positions you want.
topoptionalIncludes the TOP X of each keyword, from 1 to 100.
rank_type_alloptionalIDs of the position types to include, separated by commas. See the list of position types.
last_execoptionalReturns only the positions of the latest run.
id_execoptionalReturns the positions of one or more runs, separated by commas.

Returned positions carry a rank_type: see the list of position types.

Create an audit

Write

Creates an audit inside a project.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=create&id_project={ID_PROJECT}&name={NAME}
ParameterDescription
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
namerequiredName of the audit.

Add keywords to an audit

Write

Adds keywords to an existing audit.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=createquery&id_project={ID_PROJECT}&id_audit={ID_AUDIT}&id_service={ID_SERVICE}&version={VERSION}&keywords={KEYWORDS}&device={DEVICE*}&id_location={ID_LOCATION*}
ParameterDescription
id_projectrequiredID of the project. You can get the list of projects with the List projects method.
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.
id_servicerequiredEngine on which to track the keywords.
  • 1 Google Search
  • 2 Google Images
  • 3 Google News
  • 4 Google Videos
  • 12 Google Maps
  • 6 Google Play Store
  • 8 YouTube
  • 11 Bing Search
  • 13 Yandex
  • 14 Baidu
versionrequiredLanguage and version of the service.
Google France: fr-fr - Google Switzerland in German: de-ch
keywordsrequiredKeywords to track, separated by commas.
deviceoptionalTracking devices, separated by commas. Defaults to desktop.
  • 1 Desktop
  • 2 Mobile
id_locationoptionalGeolocates the search, for every city worldwide. Several IDs allowed, separated by commas. Get the IDs with the Search for a location method.

Run an audit

Write

Starts a run of an audit. Once finished, the audit moves to the processed status.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=exec&id_audit={ID_AUDIT}
ParameterDescription
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.

Delete an audit

Delete

Deletes an audit.

Every position of the audit is deleted.
Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=delete&id_audit={ID_AUDIT}
ParameterDescription
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.

Delete a keyword from an audit

Delete

Deletes a keyword from an audit.

Request
https://api.monitorank.com/?key={API_KEY}&module=audit&action=deletequery&id_audit={ID_AUDIT}&id_query={ID_QUERY}
ParameterDescription
id_auditrequiredID of the audit. You can get the list of audits with the List audits method.
id_queryrequiredID of the keyword to delete.

Account

Resources for the next 12 months

Read

Returns how many resources are available over the next 12 months, and how many trackings have been created.

Request
https://api.monitorank.com/?key={API_KEY}&module=account&action=resources

Google

Google updates

Read

Returns the list of the algorithm updates announced by Google. Useful to correlate a change in positions with an update.

Request
https://api.monitorank.com/?key={API_KEY}&module=google&action=update

Appendices

Services

Values for the id_service parameter, used to pick the search engine.

  • 1 Google Search
  • 2 Google Images
  • 3 Google News
  • 4 Google Videos
  • 12 Google Maps
  • 6 Google Play Store
  • 8 YouTube
  • 11 Bing Search
  • 13 Yandex
  • 14 Baidu

Position types

Every position returned by the API carries a rank_type telling you which kind of result it is in the SERP: organic result, ad, featured snippet, AI Overview…

  • 1 Organic result
  • 2 Ad (top)
  • 3 Ad (bottom)
  • 4 Image block
  • 5 Right-hand block
  • 6 News block
  • 7 Local pack
  • 8 Featured snippet
  • 9 People Also Ask
  • 10 Sitelinks
  • 11 Shopping block
  • 12 Video block
  • 13 Search results for
  • 14 Places sites
  • 15 Recipes
  • 16 Visual summary
  • 18 AI Overview - Source panel
  • 19 AI Overview - Citations
  • 20 AI Overview - Citation sources

Periods

Methods returning positions expect a period in the YYYYMMDD-YYYYMMDD format. The named periods below can be used inside a filter, with the Create a filter method.

  • last_2 Yesterday / today
  • last_7 Last 7 days
  • last_30 Last 30 days
  • last_90 Last 90 days
  • last_365 Last 365 days
  • last_week Previous week
  • last_month Previous month
  • last_3_month Previous 3 months
  • last_12_month Previous 12 months
  • last_year Previous year
  • current_month Current month
  • current_year Current year

Devices

Values for the device parameter.

  • 1 Desktop
  • 2 Mobile
  • 3 Tablet
  • SEO Tools Partners
  • Semnaut
  • Linkuma
  • Monitorank
  • Changelog