Keywords and SEO

curl --request POST \
  --url https://api.example.com/v1/solutions/gtm/seo_research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "keywords": [
    "<string>"
  ],
  "domain": "<string>",
  "country": "<string>",
  "limit": 50
}
'

import requests

url = "https://api.example.com/v1/solutions/gtm/seo_research"

payload = {
    "keywords": ["<string>"],
    "domain": "<string>",
    "country": "<string>",
    "limit": 50
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keywords: ['<string>'], domain: '<string>', country: '<string>', limit: 50})
};

fetch('https://api.example.com/v1/solutions/gtm/seo_research', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/solutions/gtm/seo_research",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keywords' => [
        '<string>'
    ],
    'domain' => '<string>',
    'country' => '<string>',
    'limit' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "idempotency-key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/solutions/gtm/seo_research"

	payload := strings.NewReader("{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("idempotency-key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/solutions/gtm/seo_research")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/solutions/gtm/seo_research")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "insufficient_balance",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "endpoint_not_permitted",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "rate_limited",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "service_unavailable",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

Solutions

Keywords and SEO

Keyword volume and difficulty, keyword ideas, Google results for a keyword, a domain’s organic overview, ranking keywords and organic competitors, backlink totals and rows, referring domains, domain rating. Providers: Semrush, Serpstat, DataForSEO, Ahrefs, Serper. Routes to one Endpoint per action; provider auto picks the first preferred Provider this key may run, a named provider forces it. The response is exactly the Run that POST /v1/runs returns — provider-native output, exact charge_usd, run_url; its provider, endpoint and input say which Endpoint served the call. Under auto, a Provider error, timeout or rate limit falls back to the next preferred Provider; a no-result answer does not. Each fallback hop is its own Run, visible in the runs list. Idempotency-Key is required and behaves exactly as on POST /v1/runs.

POST

solutions

gtm

seo_research

Keywords and SEO

curl --request POST \
  --url https://api.example.com/v1/solutions/gtm/seo_research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "keywords": [
    "<string>"
  ],
  "domain": "<string>",
  "country": "<string>",
  "limit": 50
}
'

import requests

url = "https://api.example.com/v1/solutions/gtm/seo_research"

payload = {
    "keywords": ["<string>"],
    "domain": "<string>",
    "country": "<string>",
    "limit": 50
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keywords: ['<string>'], domain: '<string>', country: '<string>', limit: 50})
};

fetch('https://api.example.com/v1/solutions/gtm/seo_research', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/solutions/gtm/seo_research",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keywords' => [
        '<string>'
    ],
    'domain' => '<string>',
    'country' => '<string>',
    'limit' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "idempotency-key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/solutions/gtm/seo_research"

	payload := strings.NewReader("{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("idempotency-key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/solutions/gtm/seo_research")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/solutions/gtm/seo_research")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keywords\": [\n    \"<string>\"\n  ],\n  \"domain\": \"<string>\",\n  \"country\": \"<string>\",\n  \"limit\": 50\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "insufficient_balance",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "endpoint_not_permitted",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "rate_limited",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "service_unavailable",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

Headers

idempotency-key

string

required

A caller-generated idempotency key (a UUID is recommended). One key binds to one run: a retry with the same key after a network timeout is a read, not a second execution.

Minimum string length: 1

Body

application/json

action

enum<string> | null

Default keyword_overview. keyword_overview takes keywords (several at once); keyword_ideas and serp take exactly one keyword in keywords; domain_overview, ranked_keywords, organic_competitors (domains ranking for the same keywords), backlinks_overview, backlinks, referring_domains and domain_rating take domain.

Available options:

keyword_overview,

keyword_ideas,

serp,

domain_overview,

ranked_keywords,

organic_competitors,

backlinks_overview,

backlinks,

referring_domains,

domain_rating

provider

enum<string> | null

Data provider: auto (default) or one of semrush, serpstat, dataforseo, ahrefs, serper. Name one only when the caller asks for that vendor.

Available options:

auto,

semrush,

serpstat,

dataforseo,

ahrefs,

serper

keywords

string[] | null

Required array length: 1 - 20 elements

Required string length: 1 - 200

domain

string | null

A website domain such as stripe.com. A full URL is accepted and reduced to its host.

Required string length: 3 - 253

country

string | null

Country as a two-letter ISO code or a country name, e.g. us, gb, de, Germany. Default us. An unsupported country is refused with the supported list.

Required string length: 2 - 60

limit

integer | null

Rows to return. Keep it small: the routed Endpoint's charge rule may read it. Each capability caps it further.

Required range: 1 <= x <= 100

Response

a terminal run: COMPLETED, FAILED or STOPPED

string

required

run_url

string

required

provider

string

required

Pattern: ^[a-z0-9][a-z0-9-]*$

endpoint

string

required

Pattern: ^\/.+$

endpoint_version

integer

required

status

enum<string>

required

Available options:

QUEUED,

RUNNING,

COMPLETED,

FAILED,

STOPPED

failure

object | null

required

Show child attributes

input

object

required

output

any

required

provider_response

object | null

required

Show child attributes

charge_usd

string | null

required

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$

charge_basis

object | null

required

Show child attributes

stoppable

boolean

required

stop_requested_at

string<date-time> | null

required

ISO-8601 UTC timestamp

created_at

string<date-time>

required

ISO-8601 UTC timestamp

started_at

string<date-time> | null

required

ISO-8601 UTC timestamp

completed_at

string<date-time> | null

required

ISO-8601 UTC timestamp

Solutions

Endpoints

Runs

Balance

Keywords and SEO

Headers

Body

Response