Envie requisicoes POST JSON e passe a API key em X-API-Key. Sucesso e erro retornam JSON.
Resposta comum
1 ou 2 creditos por requisicao bem-sucedida
support trace id
curl -X POST https://test-api.serpbase.dev/google/search \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{"q":"openai realtime api","hl":"en","gl":"us"}'Respostas bem-sucedidas retornam a mesma metadata superior. Os dados especificos ficam em organic, images, news, videos, places ou place.
statusnumberobrigatorio
Codigo de status de negocio. 0 significa sucesso.
request_idstringobrigatorio
ID estavel para suporte, retentativas e correlacao de logs.
elapsed_msnumberobrigatorio
Latencia observada pelo gateway em milissegundos.
credits_chargednumberobrigatorio
Creditos cobrados apos aplicar reembolsos.
search_typestringobrigatorio
Tipo resolvido: search, images, news, videos, maps_search ou maps_detail.
/google/searchResultados organicos no estilo Google e modulos SERP.
/google/imagesURLs de imagem, miniaturas, paginas de origem e dominios.
/google/newsArtigos com fonte, tempo, snippet e miniatura.
/google/videosResultados de video com fonte, duracao, tempo e miniatura.
/google/maps/searchBusca local com coordenadas, contato, categorias, horarios e fotos.
/google/maps/detailDetalhes de um lugar por feature_id do Google Maps.
/google/searchSearch
Resultados organicos no estilo Google e modulos SERP.
qstringobrigatorio
Texto da busca.
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
pagenumberopcional
Numero da pagina a partir de 1. Padrao: 1.
querystringobrigatorio
Consulta normalizada da requisicao.
pagenumberobrigatorio
Numero da pagina atual a partir de 1.
organicOrganicResult[]When organic results are parsed.
Organic search results.
top_storiesTopStory[]When the SERP contains top stories.
Top stories module.
people_also_askPAA[]When People Also Ask is present.
Question, answer, and source links.
knowledge_graphKnowledgeGraphWhen a knowledge panel is parsed.
Entity panel data.
related_searchesstring[]When related search suggestions are found.
Related search queries.
ranknumberobrigatorio
Posicao no ranking a partir de 1 nesta resposta.
positionnumberAlias de rank quando disponivel.
Alias normalizado para clientes que esperam position.
titlestringobrigatorio
Titulo do resultado.
linkstringobrigatorio
Link principal retornado pelo parser.
urlstringPresente quando o link pode ser normalizado.
URL canonica de destino, normalmente igual a link.
source_urlstringSomente quando uma URL fonte do Google e observada.
URL original do Google para depuracao e procedencia.
display_urlstringQuando texto visivel ou dominio pode ser derivado.
URL visivel ou dominio de origem.
display_linkstringWhen Google display text is present.
Raw Google display link text.
snippetstringWhen a snippet is parsed.
Organic result summary.
datestringWhen Google includes a date in the snippet.
Raw date text extracted from snippet.
published_atstringAlias for parsed date when available.
Normalized date alias.
iconstringWhen a favicon/image is exposed.
Result icon URL.
sitelinks{ title, link, url, source_url?, display_url? }[]When sitelinks are present.
Nested sitelinks for the organic result.
curl -X POST https://test-api.serpbase.dev/google/search \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"q": "python asyncio",
"hl": "en",
"gl": "us",
"page": 1
}'Grounding, SEO e extracao de respostas.
Search can also return ai_overview, weather, finance, flight, and result_stats when those modules appear in the SERP.
/google/imagesImagens
URLs de imagem, miniaturas, paginas de origem e dominios.
qstringobrigatorio
Texto da busca.
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
pagenumberopcional
Numero da pagina a partir de 1. Padrao: 1.
querystringobrigatorio
Consulta normalizada da requisicao.
pagenumberobrigatorio
Numero da pagina atual a partir de 1.
imagesImageResult[]When image results are parsed.
Google Images results.
ranknumberobrigatorio
Posicao no ranking a partir de 1 nesta resposta.
positionnumberAlias de rank quando disponivel.
Alias normalizado para clientes que esperam position.
titlestringQuando titulo ou alt da imagem e analisado.
Titulo do resultado.
linkstringobrigatorio
Link principal retornado pelo parser.
urlstringPresente quando o link pode ser normalizado.
URL canonica de destino, normalmente igual a link.
source_urlstringSomente quando uma URL fonte do Google e observada.
URL original do Google para depuracao e procedencia.
display_urlstringQuando texto visivel ou dominio pode ser derivado.
URL visivel ou dominio de origem.
image_urlstringobrigatorio
Full image URL.
thumbnail_urlstringQuando o Google expoe uma miniatura.
URL da miniatura.
thumbnailstringAlias de thumbnail_url quando disponivel.
Alias normalizado da miniatura.
sourcestringWhen source text is parsed.
Image source label.
domainstringWhen source page domain can be derived.
Source page domain.
curl -X POST https://test-api.serpbase.dev/google/images \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"q": "iphone 15 pro blue",
"hl": "en",
"gl": "us",
"page": 1
}'Busca visual, monitoramento de produtos e fontes.
Some Google Images payload shapes expose rank/link but not every normalized alias. Treat url, display_url, source_url, position, and thumbnail as optional.
/google/newsNoticias
Artigos com fonte, tempo, snippet e miniatura.
qstringobrigatorio
Texto da busca.
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
pagenumberopcional
Numero da pagina a partir de 1. Padrao: 1.
querystringobrigatorio
Consulta normalizada da requisicao.
pagenumberobrigatorio
Numero da pagina atual a partir de 1.
newsNewsResult[]When news results are parsed.
Google News results.
ranknumberobrigatorio
Posicao no ranking a partir de 1 nesta resposta.
positionnumberAlias de rank quando disponivel.
Alias normalizado para clientes que esperam position.
titlestringobrigatorio
Titulo do resultado.
linkstringobrigatorio
Link principal retornado pelo parser.
urlstringPresente quando o link pode ser normalizado.
URL canonica de destino, normalmente igual a link.
source_urlstringSomente quando uma URL fonte do Google e observada.
URL original do Google para depuracao e procedencia.
display_urlstringQuando texto visivel ou dominio pode ser derivado.
URL visivel ou dominio de origem.
sourcestringWhen publisher text is parsed.
Publisher/source label.
timestringWhen Google exposes time text.
Raw published time text.
published_atstringAlias for parsed time when available.
Normalized published time alias.
snippetstringWhen a snippet is parsed.
Article summary snippet.
thumbnail_urlstringQuando o Google expoe uma miniatura.
URL da miniatura.
thumbnailstringAlias de thumbnail_url quando disponivel.
Alias normalizado da miniatura.
curl -X POST https://test-api.serpbase.dev/google/news \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"q": "apple event",
"hl": "en",
"gl": "us",
"page": 1
}'Monitoramento de marca, tendencias e midia.
Source and time are parsed from compact Google metadata text, so clients should treat both as optional.
/google/videosVideos
Resultados de video com fonte, duracao, tempo e miniatura.
qstringobrigatorio
Texto da busca.
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
pagenumberopcional
Numero da pagina a partir de 1. Padrao: 1.
querystringobrigatorio
Consulta normalizada da requisicao.
pagenumberobrigatorio
Numero da pagina atual a partir de 1.
videosVideoResult[]When video results are parsed.
Google Videos results.
ranknumberobrigatorio
Posicao no ranking a partir de 1 nesta resposta.
positionnumberAlias de rank quando disponivel.
Alias normalizado para clientes que esperam position.
titlestringobrigatorio
Titulo do resultado.
linkstringobrigatorio
Link principal retornado pelo parser.
urlstringPresente quando o link pode ser normalizado.
URL canonica de destino, normalmente igual a link.
source_urlstringSomente quando uma URL fonte do Google e observada.
URL original do Google para depuracao e procedencia.
display_urlstringQuando texto visivel ou dominio pode ser derivado.
URL visivel ou dominio de origem.
sourcestringWhen source/channel can be parsed.
Video source or channel label.
durationstringWhen duration appears in result text.
Video duration text.
timestringWhen posted time can be parsed.
Raw posted time text.
published_atstringAlias for parsed time when available.
Normalized posted time alias.
thumbnail_urlstringQuando o Google expoe uma miniatura.
URL da miniatura.
thumbnailstringAlias de thumbnail_url quando disponivel.
Alias normalizado da miniatura.
curl -X POST https://test-api.serpbase.dev/google/videos \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"q": "python asyncio tutorial",
"hl": "en",
"gl": "us",
"page": 1
}'Busca de videos, tutoriais e monitoramento.
If no dedicated video cards are parsed, the parser falls back to news-style extraction for compatible Google layouts.
/google/maps/searchMaps Search
Busca local com coordenadas, contato, categorias, horarios e fotos.
qstringobrigatorio
Texto da busca.
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
pagenumberopcional
Numero da pagina a partir de 1. Padrao: 1.
latnumberopcional
Latitude do centro do mapa. Deve ser enviada com lng.
lngnumberopcional
Longitude do centro do mapa. Deve ser enviada com lat.
zoomnumberopcional
Zoom do mapa de 1 a 21. Padrao: 14 com coordenadas.
querystringobrigatorio
Consulta normalizada da requisicao.
pagenumberobrigatorio
Numero da pagina atual a partir de 1.
placesMapsPlace[]When local places are parsed.
Local place results.
positionnumberMaps Search only.
Place rank in the local result list.
namestringobrigatorio
Place name.
titlestringobrigatorio
Alias for name.
feature_idstringobrigatorio
Google Maps feature id.
place_idstringWhen Google exposes it.
Google place id.
data_idstringAlias for feature_id.
Maps data id.
cidstringDerived from feature_id when possible.
Google CID.
kgmidstringWhen present in Maps payload.
Knowledge graph machine id.
google_maps_urlstringWhen Google exposes a Maps URL.
Google Maps URL.
urlstringgoogle_maps_url or website fallback.
Primary place URL.
ratingnumberWhen rating is present.
Google rating.
typesstring[]When categories are present.
Place type labels.
categoryobjectWhen category block is parsed.
Structured category data.
addressstringWhen address is present.
Formatted address.
address_componentsobjectWhen components are present.
Street, city, postal code, country code.
plus_codeobjectWhen plus code is present.
Global and compound plus codes.
phonestringWhen phone is present.
Local phone number.
phone_internationalstringWhen present.
International phone number.
phone_uristringWhen present.
Telephone URI.
websitestringWhen website is present.
Business website.
website_domainstringWhen website domain is present.
Business website domain.
latitudenumberWhen coordinates are present.
Latitude.
longitudenumberWhen coordinates are present.
Longitude.
imagestringWhen image is present.
Primary place image.
thumbnailstringAlias for image when available.
Primary image alias.
photosMapsPhoto[]When photos are parsed.
Photo id, URL, size, and optional coordinates.
hoursRecord<string,string>When hours are parsed.
Opening hours by day.
open_statusobjectWhen status is present.
Open status text and current hours.
attributesobject[]When attributes are parsed.
Grouped place attributes.
related_placesobject[]When related places are present.
Related places from Maps payload.
short_descriptionstringWhen description block is present.
Short place description.
descriptionstringWhen description block is present.
Longer place description.
snippetstringshort_description or description fallback.
Normalized text summary.
timezonestringWhen present.
Place timezone.
regionstringWhen present.
Region label.
country_codestringWhen present.
Country code.
languagestringWhen present.
Language code from Maps payload.
curl -X POST https://test-api.serpbase.dev/google/maps/search \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"q": "coffee",
"hl": "en",
"gl": "us",
"page": 1,
"lat": 37.7749,
"lng": -122.4194,
"zoom": 14
}'Descoberta local, lojas e auditorias geo.
lat and lng must be sent together. zoom is valid only with coordinates and defaults to 14.
/google/maps/detailMaps Detail
Detalhes de um lugar por feature_id do Google Maps.
feature_idstringobrigatorio
Feature id do Google Maps, no formato 0x...:0x....
hlstringopcional
Codigo de idioma. Padrao: en.
glstringopcional
Codigo do pais. Padrao: us.
feature_idstringobrigatorio
Feature id resolved from the Maps detail request.
pagenumberobrigatorio
Always 1 for maps detail.
placeMapsPlaceWhen place details are parsed.
Single place detail object.
positionnumberMaps Search only.
Place rank in the local result list.
namestringobrigatorio
Place name.
titlestringobrigatorio
Alias for name.
feature_idstringobrigatorio
Google Maps feature id.
place_idstringWhen Google exposes it.
Google place id.
data_idstringAlias for feature_id.
Maps data id.
cidstringDerived from feature_id when possible.
Google CID.
kgmidstringWhen present in Maps payload.
Knowledge graph machine id.
google_maps_urlstringWhen Google exposes a Maps URL.
Google Maps URL.
urlstringgoogle_maps_url or website fallback.
Primary place URL.
ratingnumberWhen rating is present.
Google rating.
typesstring[]When categories are present.
Place type labels.
categoryobjectWhen category block is parsed.
Structured category data.
addressstringWhen address is present.
Formatted address.
address_componentsobjectWhen components are present.
Street, city, postal code, country code.
plus_codeobjectWhen plus code is present.
Global and compound plus codes.
phonestringWhen phone is present.
Local phone number.
phone_internationalstringWhen present.
International phone number.
phone_uristringWhen present.
Telephone URI.
websitestringWhen website is present.
Business website.
website_domainstringWhen website domain is present.
Business website domain.
latitudenumberWhen coordinates are present.
Latitude.
longitudenumberWhen coordinates are present.
Longitude.
imagestringWhen image is present.
Primary place image.
thumbnailstringAlias for image when available.
Primary image alias.
photosMapsPhoto[]When photos are parsed.
Photo id, URL, size, and optional coordinates.
hoursRecord<string,string>When hours are parsed.
Opening hours by day.
open_statusobjectWhen status is present.
Open status text and current hours.
attributesobject[]When attributes are parsed.
Grouped place attributes.
related_placesobject[]When related places are present.
Related places from Maps payload.
short_descriptionstringWhen description block is present.
Short place description.
descriptionstringWhen description block is present.
Longer place description.
snippetstringshort_description or description fallback.
Normalized text summary.
timezonestringWhen present.
Place timezone.
regionstringWhen present.
Region label.
country_codestringWhen present.
Country code.
languagestringWhen present.
Language code from Maps payload.
curl -X POST https://test-api.serpbase.dev/google/maps/detail \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"feature_id": "0x8085809c2c6fdc63:0x4b3f2d70e4f5a123",
"hl": "en",
"gl": "us"
}'Enriquecimento de locais, CRM local e detalhes.
Use feature_id from Maps Search results to request a detail record.
errorstringobrigatorio
Mensagem de erro legivel.
Request completed successfully.
Missing or invalid body or parameters.
Missing, invalid, or revoked API key.
Account balance is not enough.
QPS or concurrency limit exceeded.
Unexpected internal server error.
Worker returned an upstream fetch or parse error.
No worker session is available.
Gateway timed out waiting for a worker result.
{
"status": 1001,
"error": "unauthorized",
"request_id": "0f3576b2-6e2e-4f1e-bb0e-8cb0d4a60195",
"elapsed_ms": 0,
"credits_charged": 0
}