Developer
Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 5:00 PM (EST/EDT)
Monday - Friday
Introduction
Basics docs
Last updated: September 16, 2021
Last updated: September 16, 2021
Intro
Application Programming Interface (API) is a method of extracting raw Semrush data without having to manually log into the software.
Once you get your API key, you can start integrating with Semrush API.
Below you will find information about
- API versioning&changelog
- API packages
- List of available product APIs
- Useful links about API
API versioning & changelog
Currently there are available two API versions: version 3, version 4.
Each version consists of product groups, products themselves and product reports.
What we call Semrush products?
It`s a set of tools which solves particular user problems. You can find the entire list of Semrush products in left menu after authorizing in semrush.com.
The main difference between versions is authorization method, availability of major changes inside the feature APIs and list of available feature reports.
For more details, check the version description below.
API version 3
This is an older and more comprehensive API version. It's peculiar properties:
- Authorization via API key
- No major changes — methods, fields, errors and etc. can only be added and not deleted
- No changelog
- Amount of feature reports exceeds the version 4 (but only for now). In the closer future version 4 will become the main version and more expanded.
Version 3 practically unchangeable and consists of three product groups:
- Analytics API - allows you to pull data from products with analytics reports
- Projects API - can pull data from Position Tracking and Site Audit campaigns created in Projects
- Traffic Analytics API - allows you to pull raw data from the Traffic Analytics tool in Semrush
Each product group includes plenty of products, you can find detailed list in API documentation.
API version 4
This is the latest API version which we will expand and develop.
It's peculiar properties:
- Supports authorization with the Oauth2 flow
- No API key
- Backward compatibility
- General for all products Authentication and Response format
- Without product grouping
Version 4 consists of:
- Basic docs common for all products
- Products with list of reports
API packages
API package is a set of available reports that you will receive by fulfilling the conditions.
Semrush offers two main API options:
- Standard API package
- Traffic Analytics API
Learn more How to get API
Standard API package
This API is available as an add-on to a Business subscription. When you add API to your subscription you will have a limited amount of API units that you can use to make calls. Each call has a cost in API units.
Standard package consists of Analytics and Projects APIs version 3 & version 4.
Analytics API allows you to pull data from Analytics reports including:
- Domain Analytics
- Organic Research
- Advertising Research
- Keyword Gap Analysis
- Keyword Analytics
- Backlink Analytics
Projects API can pull data from Position Tracking and Site Audit campaigns created in Projects.
While using Standard API package your API key will be placed on your Subscription Info page.
Traffic Analytics API
Semrush Traffic Analytics API comes in two subscription plans based on the level of data supplied:
- Basic: provides only traffic summary data.
- Extended: provides traffic summary data + 8 distinct reports.
The monthly limit rate included by default is 10,000 requests. This API does not use any API units associated with the standard Semrush API for Business subscriptions.
Basic API
Traffic Overview data will be able to show you estimates of a website's visitor behavior. These include monthly visits, unique visits, pages per visit, average visit duration, mobile vs. desktop traffic %, and bounce rate.
In the same way, the Traffic Analytics Overview report can compare up to 5 domains at a time, you can pull this data for up to 200 domains in a single request using the Summary reports. This data gives you a quick look into the general level of interaction between a website and its visitors.
Extended API
The extended API offers 16 distinct reports in addition to the Traffic Overview from the Basic API:
- Traffic Sources: the website traffic broken down into direct, referral, search, social, and paid traffic.
- Traffic Destinations: where users are going after visiting the domain you are looking at.
- Geographic Distribution: the countries, regions, or subcontinents where a website gets most of its visitors.
- Subdomains: the subdomains of the website that are responsible for acquiring the most traffic.
- Top Pages: the number of unique page views, unique visitors, entrances, and traffic sources for up to a site’s top 1000 pages based on traffic.
- Domain Rankings: top websites in the target location for the target period sorted by traffic.
- Audience Insights: additional visited domains, unique audience, shared audience %, and shared audience for the domains you entered.
- Data Accuracy: the estimated accuracy of the report based on the size of the domain and any filters you have applied (historical data, location, device).
- Subfolders: the top subfolders of an analyzed domain getting the most traffic.
- Age and Sex Distribution: distribution of the domain audience by age and sex.
- Household Distribution: distribution of the domain audience by household.
- Income Distribution: distribution of the domain audience by income.
- Education Distribution: distribution of the domain audience by education.
- Occupation Distribution: distribution of the domain audience by occupation.
- Audience Interests: distribution of the domain audience by interest.
- Social Media: distribution of the domain audience by social media.
This data will show you more in-depth details of a website’s traffic coming from all angles.
