Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request GET \
  --url 'https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords?pageSize=1&query=nike&startingRow=1' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords', 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.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

SpyFu

Google keywords a domain ranks for — clicks, search volume

SpyFu has NO `/apis/keyword_api/v2/seo/getMostSuccessful` — that path does not exist; this is the organic counterpart of the PPC getMostSuccessful endpoint. Rows carry keyword, topRankedUrl, rank, rankChange, searchVolume, keywordDifficulty, seoClicks, seoClicksChange, the CPC triple and paidCompetitors. `/apis/serp_api/v2/seo/getSeoKeywords` is the generic form of the same report, with a REQUIRED `searchType` (MostValuable, GainedClicks, LostRanks, NewlyRanked …).  Usage-based billing; Default request estimate: $0.005 USD (not a fixed price). Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ.

GET

https://api.aisa.one

apis

spyfu

google-domain-ranked-keywords

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request GET \
  --url 'https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords?pageSize=1&query=nike&startingRow=1' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords', 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.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

Request contract

Method and path: GET /apis/v1/spyfu/google-domain-ranked-keywords
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/spyfu/google-domain-ranked-keywords
adultFilter: query; optional
compareDomain: query; optional
countryCode: query; optional
exactMatch: query; optional
excludeHomepageKeywords: query; optional
excludeTerms: query; optional
includeTerms: query; optional
pageSize: query; required
query: query; required
rank.max: query; optional
sortBy: query; optional
sortOrder: query; optional
startingRow: query; required
Runtime facts: ce753df3e0f9e74e5806dcbad1d277991749d173b751d37f28f4295fb56855a6

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "spyfu.google-domain-ranked-keywords",
  "method": "GET",
  "path": "/apis/v1/spyfu/google-domain-ranked-keywords",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "name": "adultFilter",
      "in": "query",
      "required": false,
      "schema": {
        "type": "boolean",
        "description": "default true"
      }
    },
    {
      "name": "compareDomain",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "description": "a second domain — adds yourRank, yourRankChange and yourUrl to every row, turning this into a gap report"
      }
    },
    {
      "name": "countryCode",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "description": "default US",
        "examples": [
          "US"
        ]
      }
    },
    {
      "name": "exactMatch",
      "in": "query",
      "required": false,
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "excludeHomepageKeywords",
      "in": "query",
      "required": false,
      "schema": {
        "type": "boolean",
        "description": "drop keywords whose ranking URL is the homepage"
      }
    },
    {
      "name": "excludeTerms",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "includeTerms",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "examples": {
        "default": {
          "value": 1
        },
        "minimal": {
          "value": 1
        }
      },
      "in": "query",
      "name": "pageSize",
      "required": true,
      "schema": {
        "maximum": 100,
        "minimum": 1,
        "type": "integer",
        "description": "COST DIAL — rows to return, 1 to 10,000, DEFAULT 5"
      }
    },
    {
      "examples": {
        "default": {
          "value": "nike"
        },
        "minimal": {
          "value": "nike"
        }
      },
      "in": "query",
      "name": "query",
      "required": true,
      "schema": {
        "minLength": 1,
        "type": "string",
        "description": "a domain, subdomain, URL or path"
      }
    },
    {
      "name": "rank.max",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "description": "range filters use this dotted form; also rank.min, searchVolume.min/max, keywordDifficulty.min/max, seoClicks.min/max, rankChange.min/max, costPerClick.min/max"
      }
    },
    {
      "name": "sortBy",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "description": "default SearchVolume"
      }
    },
    {
      "name": "sortOrder",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "description": "Ascending | Descending; default Descending"
      }
    },
    {
      "examples": {
        "default": {
          "value": 1
        },
        "minimal": {
          "value": 1
        }
      },
      "in": "query",
      "name": "startingRow",
      "required": true,
      "schema": {
        "enum": [
          1
        ],
        "maximum": 1,
        "minimum": 1,
        "type": "integer",
        "description": "1-based; default 1"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "response_units",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 0.005,
    "estimate_source": "profile_seed",
    "evidence_source": "response_header",
    "unit": "provider_credit",
    "unit_rate_usd": 1e-06
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Usage-based billing; Default request estimate: $0.005 USD (not a fixed price). Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.005
Declared unit rate (USD): 1e-06
Billing unit: provider_credit
Cost contract: response_units
Published reference multiplier: 1.0
Settlement evidence source: response_header

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

adultFilter

boolean

default true

compareDomain

string

a second domain — adds yourRank, yourRankChange and yourUrl to every row, turning this into a gap report

countryCode

string

default US

Example:

"US"

exactMatch

boolean

excludeHomepageKeywords

boolean

drop keywords whose ranking URL is the homepage

excludeTerms

string

includeTerms

string

pageSize

integer

required

COST DIAL — rows to return, 1 to 10,000, DEFAULT 5

Required range: 1 <= x <= 100

query

string

required

a domain, subdomain, URL or path

Minimum string length: 1

rank.max

integer

range filters use this dotted form; also rank.min, searchVolume.min/max, keywordDifficulty.min/max, seoClicks.min/max, rankChange.min/max, costPerClick.min/max

sortBy

string

default SearchVolume

sortOrder

string

Ascending | Descending; default Descending

startingRow

enum<integer>

required

1-based; default 1

Available options:

1

Required range: 1 <= x <= 1

Response

Successful response