Competitors

API only

POST/v3/management/project-competitors

Requests to this endpoint are free and do not consume any API units.

Query parameters

project_idintegerRequired

The unique identifier of the project. You can find it in the URL of your Rank Tracker project in Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Request body

competitorsarray<object>Required

A list of competitors to add.

urlstringrequired

The URL of the project's target.

modestringrequired

The scope of the target.

Allowed values:exactprefixdomainsubdomains

Responses

competitorsarray<object>

urlstring

The URL of the project's target.

modestring

The scope of the target. Possible values: exact, prefix, domain, subdomains.

Parameters

project_idRequired

output

Request Body

{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}

API key

Request

curl "https://api.ahrefs.com/v3/management/project-competitors" \
  -X POST \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}'

import requests

url = "https://api.ahrefs.com/v3/management/project-competitors"
headers = {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json={
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/project-competitors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
})
});

const data = await response.json();
console.log(data);

body := []byte(`{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}`)
req, _ := http.NewRequest("POST", "https://api.ahrefs.com/v3/management/project-competitors", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer $AHREFS_API_KEY")
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

data, _ := io.ReadAll(resp.Body)
fmt.Println(string(data))

Response

200 OK

{
  "competitors": [
    {
      "url": "string",
      "mode": "string"
    }
  ]
}