contacts

Telephone

United States

dropdown button

United States

Canada

United Kingdom

Spain

France

Italy

Germany

Australia

+1 (800) 815 - 9959

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

Monday - Friday

mobile-menu

Projects

Projects divider Last updated: August 18, 2021

List All Existing Projects

Price: 100 API units per request info
Historical price:
free

This request allows you to get a list of all projects, including their ID, project name and domain name, as well as tools that have been activated for each project.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id ID

Project ID

project_name Name

The name of a project

url domain.com

The domain of a project

tools List

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/management/v1/projects

Request example

https://api.semrush.com/management/v1/projects?key=YOUR_API_KEY

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Get Information About An Existing Project

Price: 100 API units per request

This request allows you to get information regarding a project, including its ID, project name and domain name, as well as tools that have been activated for this project.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id ID

Project ID

project_name Name

The name of a project

url domain.com


The domain of a project

tools List


List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (GET)

https://api.semrush.com/management/v1/projects/

Request example

https://api.semrush.com/management/v1/projects/{id}?key=YOUR_API_KEY

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Create A New Project

Price: 100 API units per request

This request allows you to create a new project, which includes naming the project and choosing a domain.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

project_id* ID

Project ID

project_name Name


Name of a user's project. Forbidden characters are ~`!#%'^&*=[]\/{}|":<>?

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id ID

Project ID

project_name Name


The name of a project

url domain.com


The domain of a project

tools List


List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (POST)

https://api.semrush.com/management/v1/projects?key=YOUR_API_KEY

Request example

{
  "project_name": "myproject",
  "url": "mysite.com"
}

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Update An Existing Project

Price: 100 API units per request

This request allows you to update or change a project’s name.

Endpoint

https://api.semrush.com/management/v1/projects?key=YOUR_API_KEY

Request example

{
  "project_id": 643526670283248,
  "project_name": "my old project"
}

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "my old project"
}

Delete an existing project

Price: 100 API units per request

This request allows you to delete a project, including its all of tool campaigns.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

* Fields marked by an asterisk (*) are required

Endpoint (DELETE)

https://api.semrush.com/management/v1/projects/{id}?key=YOUR_API_KEY

Request example

https://api.semrush.com/management/v1/projects/{id}?key=YOUR_API_KEY

Add keywords to an existing project

Price: 100 API units per keyword added

This request allows you to add keywords to track to an existing project and group them with tags.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

keywords keyword

Keywords

tags tags

Tags for a keyword

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id ID

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (PUT)

https://api.semrush.com/management/v1/projects/{id}/keywords?key=YOUR_API_KEY

Request example

{
  "keywords": [
    {
      "keyword": "seo",
      "tags": [
        "seo"
      ]
    },
    {
      "keyword": "seotool",
      "tags": [
        "seo"
      ]
    }
  ]
}

Response example

{
  "url": "mysite.com",
  "keywords": [
    {
      "keyword": "search tool",
      "tags": [
        "search"
      ],
      "timestamp": 1391517755
    },
    {
      "keyword": "search engine",
      "tags": [
        "search"
      ],
      "timestamp": 1391517755
    },
    {
      "keyword": "seo",
      "tags": [
        "seo"
      ],
      "timestamp": 1491517755
    },
    {
      "keyword": "seotool",
      "tags": [
        "seo"
      ],
      "timestamp": 1491517755
    }
  ],
  "competitors": [
    "google.com",
    "ebay.com",
    "bing.com"
  ],
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "my old project"
}

Remove keywords from an existing project

Price: 100 API units per request

This request allows you to remove tracked keywords from an existing project.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

keywords keyword

Keywords

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id ID

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (DELETE)

https://api.semrush.com/management/v1/projects/{id}/keywords?key=YOUR_API_KEY

Request example

{
  "keywords": [
    {
      "keyword": "seo"
    },
    {
      "keyword": "seotool"
    }
  ]
}

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "my old project"
}

Add competitors to an existing project

Price: 100 API units per request
Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

competitors "google.com", "ebay.com", "bing.com", "…
"google.com", "ebay.com", "bing.com", "yahoo.com"

List of project competitors

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id 12345457

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (PUT)

https://api.semrush.com/management/v1/projects/{id}/competitors?key=YOUR_API_KEY

Request example

{
  "competitors": [
    "yahoo.com"
  ]
}

Response example

{
  "url": "mysite.com",
  "keywords": [
    {
      "keyword": "search tool",
      "tags": [
        "search"
      ],
      "timestamp": 1391517755
    },
    {
      "keyword": "search engine",
      "tags": [
        "search"
      ],
      "timestamp": 1391517755
    }
  ],
  "competitors": [
    "google.com",
    "ebay.com",
    "bing.com",
    "yahoo.com"
  ],
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Remove competitors from an existing project

Price: 100 API units per request
Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

competitors "google.com", "ebay.com", "bing.com", "…
"google.com", "ebay.com", "bing.com", "yahoo.com"

List of project competitors

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id 12345457

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (DELETE)

https://api.semrush.com/management/v1/projects/{id}/competitors?key=YOUR_API_KEY

Request example

{
  "competitors": [
    "bing.com",
    "yahoo.com"
  ]
}

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Group keywords with tags in an existing project

Price: 100 API units per request

This request allows you to apply up to 5 tags to your tracked keywords.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

keywords "search tool", "search engine"

keywords

tags "seo"

Tags for a keyword

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id 12345457

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (PUT)

https://api.semrush.com/management/v1/projects/{id}/tags?key=YOUR_API_KEY

Request example

[
  {
    "tag": "seo",
    "keywords": [
      "search tool",
      "search engine"
    ]
  }
]

Response example

{
  "url": "mysite.com",
  "keywords": [
    {
      "keyword": "search tool",
      "tags": [
        "search",
        "seo"
      ],
      "timestamp": 1391517755
    },
    {
      "keyword": "search engine",
      "tags": [
        "search",
        "seo"
      ],
      "timestamp": 1391517755
    }
  ],
  "competitors": [
    "google.com",
    "ebay.com"
  ],
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}

Remove tags from keywords in an existing project

Price: 100 API units per request

This request allows you to apply up to 5 tags to your tracked keywords.

Request parameters
Name Value/Type Description
key* API_KEY

An identification key assigned to a user after subscribing to SEMrush that is available via Profile page

id* ID

Project ID

keywords "search tool", "search engine"

keywords

tags "seo"

Tags for a keyword

* Fields marked by an asterisk (*) are required

Response parameters
Name Value/Type Description
project_id 12345457

Project ID

project_name "myproject"

The name of a project

url domain.com

The domain of a project

tools seotool, seo

List of project tools activated by a user

* Fields marked by an asterisk (*) are required

Endpoint (DELETE)

https://api.semrush.com/management/v1/projects/{id}/tags?key=YOUR_API_KEY

Request example

[
  {
    "tag": "seo",
    "keywords": [
      "search tool",
      "search engine"
    ]
  }
]

Response example

{
  "url": "mysite.com",
  "tools": [],
  "project_id": 643526670283248,
  "project_name": "myproject"
}