Basic docs

Projects

Last updated: August 18, 2021

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
511	Unknown error
512	Can't find project with project_id {ID}
513	Invalid tool_id
515	Campaign already exists
519	Missing mandatory URL parameter
520	Invalid tag name
521	Projects limit exceed, projects created: {projects_count}, user limit are {projects_limit}
522	Keywords limit exceed, keywords limit {keywords_limit} already tracked keywords {keywords_count}
70	API key hash failure
120	Wrong key - ID pair
121	Wrong format or empty hash
122	Wrong format or empty key
130	Api disabled
131	Limit exceeded
132	API units balance is zero
134	Total limit exceeded

Show all

Basic docs

About

Auth

Response

Error messages