Run a Google search and return the top competing (rival) domains…
Run a Google search and return the top competing (rival) domains ranking for a phraseage of 10 results actually fetched)
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
Response
{
"pagesFetched": 39,
"rivals": [
"<rival>"
],
"status": "success",
"tokensDeducted": 60
}What it does
Run a Google search and return the top competing (rival) domains ranking for a phraseage of 10 results actually fetched)
Request
Body
| Field | Type | Required | Description |
|---|---|---|---|
country | string | yes | |
lang | string | yes | |
numResults | integer | no | |
phrase | string | yes |
Example request
{
"country": "PL",
"lang": "en",
"numResults": 10,
"phrase": "<phrase>"
}Response
| Field | Type | Description |
|---|---|---|
pagesFetched | integer | |
rivals | array<string> | |
status | string | |
tokensDeducted | integer |
Example response
{
"pagesFetched": 39,
"rivals": [
"<rival>"
],
"status": "success",
"tokensDeducted": 60
}Errors
Every error answers with the same envelope: an HTTP status, a machine code and a sentence.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream refused or timed out. The call is not billed. |
Code
curl -X POST 'https://app.castomapi.com/v1/serp/rivals' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"country": "PL", "lang": "en", "numResults": 10, "phrase": "<phrase>"}'const res = await fetch('https://app.castomapi.com/v1/serp/rivals', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"country": "PL", "lang": "en", "numResults": 10, "phrase": "<phrase>"})
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/serp/rivals', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"country": "PL", "lang": "en", "numResults": 10, "phrase": "<phrase>"})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/serp/rivals',
headers={'x-api-key': '<your-api-key>'},
json={"country": "PL", "lang": "en", "numResults": 10, "phrase": "<phrase>"},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/serp/rivals');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['country' => 'PL', 'lang' => 'en', 'numResults' => 10, 'phrase' => '<phrase>']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Cost and limits
This operation costs from 60 tokens. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire. 60 tokens per page of up to 10 results actually fetched. Available on the PRO and Enterprise plans: this operation spends castomAPI's own keys or quota. A key on the free plan is refused with 403 and is not billed.
Rate limits per minute
| No key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Questions
What does Run a Google search and return the top competing (rival) domains… cost?
from 60 tokens per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month. 60 tokens per page of up to 10 results actually fetched.
How do I authenticate?
Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.
Can I send an Authorization: Bearer token instead?
Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.
What are the limits?
10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.
OpenAPI: https://app.castomapi.com/docs/json