Skip to main content
Competitors

SERP competitors for a set of keywords

View Markdown

Returns the domains competing for the given keywords in Google search, ranked by visibility, with average position and estimated traffic value. Costs 5 credits.

POST/v1/competitors/

Authorization

accessKey
x-access-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/competitors/" \  -H "Content-Type: application/json" \  -d '{    "keywords": [      "string"    ]  }'
{
  "success": true,
  "credits": {
    "charged": 0,
    "remaining": 0
  },
  "data": {
    "keywords": [
      "string"
    ],
    "location": "string",
    "total": null,
    "competitors": [
      {
        "domain": "string",
        "avg_position": null,
        "visibility": null,
        "etv": null,
        "keywords_count": null
      }
    ]
  }
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}