Run a live Google search
Run a live Google search and return ranked resultsesults page actually fetched; a page holds up to 10 results, so respSize 10 = 60 tokens and respSize 100 = up to 600 tokens). `position` is the rank across all pages, duplicates removed. `country` is an ISO…
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
Response
{
"status": "success",
"query": "royalty free media api",
"engine": "google",
"results": [
{
"position": 1,
"title": "castomAPI Media — royalty-free media library",
"url": "https://media.castomapi.com/",
"snippet": "Search eleven providers, import with licence and attribution…"
},
{
"position": 2,
"title": "Openverse",
"url": "https://openverse.org/",
"snippet": "An extensive library of free stock photos, images, and audio…"
},
{
"position": 3,
"title": "Pexels API",
"url": "https://www.pexels.com/api/",
"snippet": "Free stock photos and videos for your projects…"
}
],
"totalResults": 4180000,
"tokensDeducted": 2
}What it does
A live search on Google or YouTube, from the country and language you name, returned as ranked results with title, URL and snippet — the raw material for rank tracking, competitor discovery and content research. The cost scales with the number of results asked for.
When to use it
A weekly rank report; checking whether a page you published is indexed; feeding FABLS a topic.
Request
Body
| Field | Type | Required | Description |
|---|---|---|---|
country | string | yes | |
lang | string | yes | |
location | string | no | |
phrase | string | yes | |
respSize | integer | no | |
searchEngine | enum | yes | One of: google, bing. |
Example request
{
"query": "royalty free media api",
"country": "pl",
"language": "en",
"limit": 3
}Response
| Field | Type | Description |
|---|---|---|
geocoded | boolean | |
pagesFetched | integer | |
results | array<object> | |
searchEngine | string | |
status | string | |
tokensDeducted | integer |
Example response
{
"status": "success",
"query": "royalty free media api",
"engine": "google",
"results": [
{
"position": 1,
"title": "castomAPI Media — royalty-free media library",
"url": "https://media.castomapi.com/",
"snippet": "Search eleven providers, import with licence and attribution…"
},
{
"position": 2,
"title": "Openverse",
"url": "https://openverse.org/",
"snippet": "An extensive library of free stock photos, images, and audio…"
},
{
"position": 3,
"title": "Pexels API",
"url": "https://www.pexels.com/api/",
"snippet": "Free stock photos and videos for your projects…"
}
],
"totalResults": 4180000,
"tokensDeducted": 2
}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/search' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"query": "royalty free media api", "country": "pl", "language": "en", "limit": 3}'const res = await fetch('https://app.castomapi.com/v1/serp/search', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"query": "royalty free media api", "country": "pl", "language": "en", "limit": 3})
});
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/search', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"query": "royalty free media api", "country": "pl", "language": "en", "limit": 3})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/serp/search',
headers={'x-api-key': '<your-api-key>'},
json={"query": "royalty free media api", "country": "pl", "language": "en", "limit": 3},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/serp/search');
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(['query' => 'royalty free media api', 'country' => 'pl', 'language' => 'en', 'limit' => 3]),
]);
$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 results actually fetched. A page holds up to 10 results, so respSize 10 costs 60 tokens and respSize 100 costs up to 600. 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 live Google search 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 results actually fetched. A page holds up to 10 results, so respSize 10 costs 60 tokens and respSize 100 costs up to 600.
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