Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 5:00 PM (EST/EDT)
Monday - Friday
Need help?
Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 5:00 PM (EST/EDT)
Monday - Friday
Projects API allows users to create, edit and manage projects that use The Site Audit and Position Tracking tools. By using Projects API, you can track your web rivals’ and your own keyword rankings, discover local competitors, and fix websites’ on-page issues from one location, and much more.
All API requests use such HTTP methods such as POST, PUT, GET or DELETE with JSON parameters and must contain your API Key. You can find info how to get your in How to get API documentation.
If you sent an API call example, replace your key with a placeholder (e.g. https://api.semrush.com/?key=<key>
).
Your API key also gives an access to your API units balance, so please don’t share it publicly.
Exposing your credentials can result in your account being compromised, which leads to unexpected charges.
Result | Code | |
---|---|---|
Success | HTTP 200 | |
Error | HTTP 400 |
Projects API error messages are returned in a specific format:
{ "code": "{ERROR_CODE}", "message": "{ERROR_MESSAGE}" }
ERROR_CODE | integer | Machine-parseable codes. |
---|---|---|
ERROR_MESSAGE | string | Descriptive error text. |
In addition to descriptive error text, error messages contain machine-parsable codes. While the text for an error message may change, the codes will stay the same.
Error code | Error message | Recommended action |
---|---|---|
70 | API key hash failure | Double-check that your API key is correct and valid. |
120 | Wrong key-ID pair | Check that the API key is correct. You can find your key in the Subscription info section. |
121 | Wrong format or empty hash | Check that the API key is correct. You can find your key in the Subscription info section. |
122 | Wrong format or empty key | Check that the API key is correct. You can find your key in the Subscription info section. |
130 | API disabled | Upgrade your subscription plan to get access to the API. |
131 | Limit exceeded | The API request limit for the requested report has been reached. Contact the Semrush Support Team. |
132 | API units balance is zero | You have used all your API units. To continue using the API, recharge your API unit balance or upgrade your subscription. |
134 | Total limit exceeded | The total API request limit has been reached. Contact the Semrush Support Team. |
511 | Unknown error | Contact the Semrush Support Team and provide them with your API request. |
512 | Can't find project with project_id {ID} | Check that the project ID is correct. |
513 | Invalid 'tool_id' | Check that the tool ID is correct. |
515 | Campaign already exists | A campaign with the same parameters already exists. Create a new one. |
519 | Missing mandatory URL parameter | Check that you have added all the required parameters in the request URL. |
520 | Invalid tag name | Check that the tag name is correct. |
521 | Projects limit exceed, projects created: {projects_count}, user limit are {projects_limit} | You have reached the limit of projects for your account. To create a new project, delete an existing one. |
522 | Keywords limit exceed, keywords limit {keywords_limit} already tracked keywords {keywords_count} | You have reached the limit of keywords for your account. To add new keywords, buy more keywords or remove some of the existing ones. |