Basic docs

• To use the Projects API, you must have the Business subscription and available API units. Learn more about the Standard API ›
• The Listing Management API is available for all Semrush Local Premium Plan users. You don't need to buy API units to use it. Learn more about the Listing Management API ›

Semrush API supports authorization with the Oauth2 flow. Please pass your Oauth2 authorization token in the HTTP request header.

Authorization: Bearer ****

The Semrush API supports two ways to grant OAuth2 credentials:

• Device Authorization Grant flow (RFC 8628)
• Semrush Auth flow

Use one of these options to authenticate in the Semrush API.

Step 1. Device Authorization request

1. The client initiates the authorization flow by requesting a set of verification codes from the authorization server, making an HTTP POST request to the https://oauth.semrush.com/dag/device/code endpoint.
2. The client makes a device authorization request to the device authorization endpoint by including the following scope parameter.

Request parameters

Step 2. User interaction

1. After receiving a successful authorization response, the client displays user_code and verification_uri to the end user and instructs them to visit the URI.
2. The authorizing user navigates to verification_uri and is redirected to the authorization server with the session state code.
3. The authorization server redirects the user to the DAG authentication service with the authorization code granted and the original state parameter.
4. The DAG authentication service substitutes the returned authorization code with the access token using its client_id and secret.

Step 3. Device Access Token request

During the user interaction, the device continuously polls the https://oauth.semrush.com/dag/device/token token endpoint using the POST HTTP method with the device_code provided, until the user completes the interaction, the code expires, or another error occurs. The device_code value is not intended for the end user directly; thus, it shouldn't be displayed during the interaction to avoid confusing the end user.

Request parameters

If the user has approved the grant, the token endpoint responds with a success response defined in Section 5.1 of RFC 6749. Otherwise, it responds with an error, as defined in Section 5.2 of RFC 6749. In addition to the error codes defined in Section 5.2 of RFC 6749, the following error codes are specified for use with the device authorization grant in token endpoint responses.

Step 1. Get code

1. Contact the Semrush Tech Support to obtain your client_id and client_secret.
2. Replace YOUR_CLIENT_ID with your client_id and open the link in your browser:
   https://oauth.semrush.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=%2Foauth2%2Fsuccess&response_type=code&scope=user.id
3. Log in to Semrush, if needed, and click Approve to provide access to the data. You will then be redirected to a new page with the Authorization provided title. Its URL will look similar to this: https://oauth.semrush.com/oauth2/success?code=UTyWR6YQAPUbtLIX9jWM4OifmK1ODVWDOVUt8hlk.
4. Copy the value of the code parameter. In the earlier example, it's UTyWR6YQAPUbtLIX9jWM4OifmK1ODVWDOVUt8hlk.

Step 2. Get access token

Make a POST request using the value you copied as the code parameter value. In addition, replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the ones you received from Tech Support:

Use the access_token value when making requests to the API. To get a new one when it expires, use refresh_token:

The response body contains a JSON-encoded object, which has a top-level object called meta, followed by either a data object or an error object, but not both.

The API version 4 returns a corresponding HTTP status code with every request response, whether it succeeds or fails.