contacts

Telephone

United States

dropdown button

United States

Canada

United Kingdom

Spain

France

Italy

Germany

Australia

+1 (800) 815 - 9959

10:00 AM - 5:00 PM (EST/EDT)

Monday - Friday

mobile-menu

Glossary

Basic docs divider Last updated: April 29, 2024

About

Familiarizing yourself with the following basic terms will help you interact with the Semrush API.

API

Application Programming Interface. A set of rules and definitions that allows one piece of software to interact with another by sending requests and receiving responses.

The Semrush API lets users pull analytics and project data without interacting with the Semrush web interface directly.

API request

A "message" you send to the Semrush API asking for information or action. It includes a method, an endpoint, a secret API key, and a set of request parameters.

Three types of requests you can make via the Semrush API:

  • A line request to pull data from a report.
  • A call request to create, update, or delete a project.
  • A keyword request to add new search terms to your tracking campaign. You will be charged for each added keyword.

API request parameter

A piece of information you include with an API request to specify the data you want to retrieve or affect.

API unit

The currency for your API requests that is allocated to your account and consumed by making API requests. The unit cost of each API request varies depending on the request type, the number of lines in the response, and other considerations.

To check or top up your current API unit balance, go to Subscription info in your Semrush profile.

Endpoint

A specific URL of the Semrush API where requests are sent.

HTTP method

The type of action you want the Semrush API to take, such as GET (retrieve data), POST (create data), PUT (update data), or DELETE (remove data).

Line

A string of data in a Semrush API response. A line may contain keywords, domains, and analytical metrics.

A line example:

seobook.com;24041;5249;37332;143496;0;0;0

Response

The data sent back by the Semrush API after it processes your request. Responses include a status code indicating success or failure and, if successful, the requested data.

Status code

A number included in a response that indicates whether your API request was successful or encountered an error. Common codes include 200 (success), 404 (not found), and 500 (server error).

Was this page helpful?