SerpApi

Visão geral

SerpApi é uma API em tempo real para resultados estruturados de mecanismos de busca, permitindo que desenvolvedores raspe, analise e processe dados de SERP para SEO e pesquisa. Com a integração SerpApi no SquadOS, seus agentes podem buscar resultados do Google, Bing, DuckDuckGo, Yahoo, YouTube, Google Maps, Google Scholar, eBay, Walmart e muitos outros mecanismos, obtendo dados prontos para análise sem precisar lidar com bloqueios anti-bot ou parsing de HTML.

• Site oficial: https://serpapi.com/
• Documentação na Composio: docs.composio.dev/toolkits/serpapi

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API da sua conta SerpApi, usada para autenticar todas as requisições de busca.

Como obter a credencial

1. Acesse serpapi.com e clique em Sign Up para criar uma conta.
2. Confirme seu e-mail e faça login no painel em dashboard.serpapi.com.
3. Na seção API Key, copie a chave exibida.

Dica

O plano gratuito do SerpApi inclui 100 buscas por mês. Para uso intensivo em agentes, considere um plano pago que ofereça mais créditos.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por SerpApi.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Busca no Baidu

SERPAPI_BAIDU_SEARCH

Busca no Baidu (mecanismo de busca chinês) e recupera resultados de pesquisa. Requer uma string de consulta no parâmetro ‘q’. Retorna resultados orgânicos, caixas de resposta e informações de paginação em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
f	string	Não	Define o tipo de busca de origem. (ex.: “8” é uma busca normal, “3” é da lista de sugestões e “1” é uma busca relacionada.
q	string	Sim	Define a consulta de busca, incluindo todos os operadores do Baidu (ex.: inurl:, site:, intitle:, etc.).
bs	string	Não	Define a consulta de busca anterior.
ct	string	Não	Define o idioma para restringir os resultados. Opções disponíveis: “1” (Todos os idiomas), “2” (Chinês simplificado), “3” (Chinês tradicional).
oq	string	Não	Define a consulta de busca original quando navegado a partir de uma busca relacionada.
pn	integer	Não	Define o deslocamento de resultados para paginação. (ex.: 0 (padrão) é a primeira página, 10 é a segunda página, 20 é a terceira, etc.). Deve ser um inteiro não negativo.
q5	string	Não	Similar a usar inurl: ou intitle:. (ex.: “1” para buscar por título da página, “2” para buscar por endereço web).
q6	string	Não	Similar a usar site:. (ex.: q6=serpapi.com para buscar resultados apenas do domínio serpapi.com).
rn	integer	Não	Define o número máximo de resultados a retornar, limitado a 50. Disponível apenas para buscas em desktop e tablet. Deve ser entre 1 e 50.
gpc	string	Não	Define o período de tempo para os resultados. (ex.: stf=1749303572,1749908372|stftype=1 retorna apenas resultados dos últimos 7 dias).
async	boolean	Não	Define o modo de submissão da busca ao SerpApi. Pode ser false (padrão) para conexão síncrona ou true para submissão assíncrona.
device	string	Não	Define o dispositivo para obter os resultados. Pode ser “desktop” (padrão), “tablet” ou “mobile”.
output	string	Não	Define o formato de saída. Pode ser json (padrão) para JSON estruturado ou html para o HTML bruto recuperado.
no_cache	boolean	Não	Força o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível. O cache expira após 1h.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Bing Maps

SERPAPI_BING_MAPS

Ferramenta para raspar resultados do Bing Maps via SerpApi. Use quando precisar encontrar empresas locais, lugares ou obter informações detalhadas de localização incluindo endereços, telefones, avaliações e mais. Suporta busca por consulta ou ID de local específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para o Bing Maps (ex.: ‘café’, ‘restaurantes’, ‘hotéis perto da Times Square’). Use consultas de localização específicas para melhores resultados.
cp	string	Não	Coordenadas GPS no formato ‘latitudelongitude’ (ex.: ‘40.7455096-74.0083012’). Especifica o ponto central da área de busca.
count	integer	Não	Número de resultados por página (máximo 30).
first	integer	Não	Deslocamento de resultados para paginação (padrão 0).
setlang	string	Não	Código de idioma ISO 3166-1 de 2 caracteres para localização (ex.: ‘us’, ‘de’, ‘gb’).
no_cache	boolean	Não	Definir como true para ignorar resultados em cache e forçar uma chamada de API atualizada.
place_id	string	Não	Identificador de referência único para um local específico. Pode ser usado independentemente do parâmetro q.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Bing

SERPAPI_BING_SEARCH

Recupera resultados do mecanismo de busca Bing via SerpAPI. Consome créditos SerpAPI por chamada; limite a ~1–2 chamadas/segundo com backoff exponencial em HTTP 429. Suporta parâmetros de consulta, localização, idioma e dispositivo. Defina location, mkt ou cc explicitamente quando a relevância local for importante.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	A string de consulta de busca.
cc	string	Não	Define o país a partir do qual buscar. Segue o formato ISO_3166-1 de 2 caracteres. Exemplo: ‘us’, ‘de’, ‘gb’.
mkt	string	Não	O mercado de onde os resultados provêm (ex.: ‘en-US’). Formato: código-de-idioma-código-de-país.
first	integer	Não	Controla o deslocamento de paginação. Padrão: 1.
device	string	Não	Define o dispositivo para obter os resultados. Pode ser ‘desktop’ (padrão), ‘tablet’ ou ‘mobile’.
filters	string	Não	Habilita filtros complexos, como filtrar por intervalo de datas.
location	string	Não	Define a localização para usar na busca. Pode ser uma cidade, estado, país ou CEP.
safeSearch	string	Não	Níveis de filtragem para conteúdo adulto. Pode ser ‘Off’, ‘Moderate’ ou ‘Strict’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca leve no DuckDuckGo

SERPAPI_DUCK_DUCK_GO_LIGHT_SEARCH

Ferramenta para acessar a API de busca DuckDuckGo mais rápida via SerpApi. Retorna resultados em JSON com dados críticos para tempos de resposta mais rápidos, sem resultados extras ricos. Use quando precisar de resultados rápidos do DuckDuckGo com informações essenciais. Suporta buscas baseadas em localização, filtragem por data e paginação (15 resultados por página).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para o DuckDuckGo. Máximo 500 caracteres. Suporta sintaxe de busca do DuckDuckGo incluindo inurl:, site:, intitle:, etc.
df	string	Não	Filtragem de resultados por data. Use ‘d’ (dia), ‘w’ (semana), ‘m’ (mês), ‘y’ (ano), ou intervalo customizado ‘YYYY-MM-DD..YYYY-MM-DD’.
kl	string	Não	Código de região no formato país-idioma (ex.: ‘us-en’, NÃO ‘en-us’).
async	boolean	Não	Submeter busca de forma assíncrona. Padrão: false. Incompatível com modo Ludicrous Speed.
output	string	Não	Formato de resposta: ‘json’ (padrão) ou ‘html’.
no_cache	boolean	Não	Forçar resultados atualizados, ignorando o cache. Duração do cache: 1 hora.
zero_trace	boolean	Não	Recurso enterprise para não armazenar dados da busca. Requer conta enterprise.
next_page_token	string	Não	Token de paginação para recuperar páginas subsequentes. Retorna 15 resultados por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no DuckDuckGo Maps

SERPAPI_DUCK_DUCK_GO_MAPS

Raspa resultados do DuckDuckGo Maps via SerpApi. Use quando buscar informações baseadas em localização como empresas, restaurantes ou serviços em uma área geográfica específica. Retorna dados estruturados incluindo avaliações, endereços, horários de funcionamento e informações de contato.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para o DuckDuckGo Maps (ex.: ‘Café’, ‘Restaurantes italianos’, ‘Hotéis’).
lat	number	Não	Coordenada GPS de latitude para o ponto central da busca. Deve ser usado junto com o parâmetro lon.
lon	number	Não	Coordenada GPS de longitude para o ponto central da busca. Deve ser usado junto com o parâmetro lat.
bbox	string	Não	Coordenadas de bounding box no formato ‘latitude_tl,longitude_tl,latitude_br,longitude_br’. Não pode ser usado com os parâmetros lat/lon.
strict_bbox	integer	Não	Controla a aderência estrita ao bounding box. Defina como 1 (padrão) para limitar resultados estritamente dentro do bbox, ou 0 para permitir resultados fora do bbox.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no DuckDuckGo

SERPAPI_DUCK_DUCK_GO_SEARCH

Realiza uma busca no DuckDuckGo via SerpApi para recuperar dados de SERP, incluindo resultados orgânicos, anúncios e informações estruturadas. Os resultados podem ser localizados por região por padrão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Termo ou frase de busca para o DuckDuckGo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no eBay

SERPAPI_EBAY_SEARCH

Recupera resultados de busca do eBay via SerpApi. Suporta parâmetros como nkw (consulta), localização, etc. Retorna dados de SERP de produtos em formato JSON. Preços e taxas de listagem podem estar incompletos; verifique o custo total na página de origem antes de comparar resultados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
gl	string	Não	Código de país para os resultados de busca.
hl	string	Não	Idioma para os resultados de busca.
nkw	string	Sim	A consulta de busca (palavras-chave). Este é um parâmetro obrigatório.
num	integer	Não	Número de resultados por página. Opções válidas: 25, 50 (padrão), 100, 200.
page	integer	Não	Número de página para paginação. Começa em 1.
device	string	Não	Tipo de dispositivo a simular (ex.: desktop, mobile, tablet).
location	string	Não	A localização para a busca. Define de onde a busca é realizada.
ebay_domain	string	Não	O domínio específico do eBay para buscar (ex.: ebay.com, ebay.co.uk).
ebay_buyer_country	string	Não	O país para o qual os resultados devem ser adaptados.
ebay_marketplace_id	string	Não	O ID do marketplace do eBay (ex.: EBAY-US, EBAY-GB, EBAY-DE).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de eventos no Google

SERPAPI_EVENT_SEARCH

Busca eventos (ex.: shows, festivais, conferências) por consulta, recuperando dados estruturados dos resultados de busca de eventos do Google via o motor Google Events da SerpApi.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Consulta de busca de eventos, especificando o tópico, tipo ou nome.
start	integer	Não	Deslocamento de resultados para paginação. Padrão: 0. Incrementar por 10 para cada página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de finanças

SERPAPI_FINANCE_SEARCH

Recupera informações financeiras estruturadas (ex.: dados de empresas, detalhes de ações, tendências de mercado, notícias) do Google Finance via SERP API com base em uma consulta. Resultados vazios para ativos deslistados, ilíquidos ou recém-listados são respostas válidas de ‘sem dados’. Altos volumes de consultas podem acionar limites de taxa HTTP 429.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	A consulta de busca financeira. Pode ser um nome de empresa, símbolo de ticker (ex.: ‘AAPL’, ‘GOOG’), ou um tópico financeiro mais amplo. Prefira símbolos de ticker com prefixo de bolsa (ex.: ‘NASDAQ:AAPL’) — consultas apenas por nome podem retornar resultados vazios ou genéricos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter opções de localização disponíveis

SERPAPI_GET_AVAILABLE_LOCATION_OPTIONS_FOR_GOOGLE_SEARCHES

Ferramenta para obter opções de localização disponíveis para buscas no Google. Retorna nomes, códigos e identificadores de localização que podem ser usados no parâmetro de localização. Use quando precisar encontrar valores de localização válidos para consultas de busca.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Restringe sua busca a localizações que contenham a string fornecida. Por exemplo, ‘Austin’ encontrará ‘Austin, TX’, ‘The University of Texas at Austin’, etc. Se não fornecido, retorna opções gerais de localização.
limit	integer	Não	Limita o número de localizações retornadas. Deve ser entre 1 e 10.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter informações de perfil do Facebook

SERPAPI_GET_FACEBOOK_PROFILE

Ferramenta para recuperar informações públicas de um perfil ou página do Facebook usando SerpAPI. Use quando precisar buscar detalhes de perfil, bio, fotos, seguidores, avaliações ou informações de contato.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
no_cache	boolean	Não	Força o SerpAPI a buscar resultados atualizados em vez de retornar dados em cache.
profile_id	string	Sim	ID de perfil do Facebook ou nome de usuário para recuperar informações. Pode ser um ID numérico (ex.: ‘100080376596424’) ou um nome de usuário (ex.: ‘Meta’).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter “Sobre este resultado” do Google

SERPAPI_GET_GOOGLE_ABOUT_THIS_RESULT

Ferramenta para obter informações “Sobre este resultado” do Google para um site. Use quando precisar de informações detalhadas sobre uma URL específica, incluindo detalhes da empresa, perfis sociais, citações web e avaliações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	URL do site para obter informações, formatada como ‘About <URL>’ (ex.: ‘About https://www.starbucks.com/‘)
async	boolean	Não	Submeter busca de forma assíncrona (true) ou aguardar resultados (false, padrão).
engine	string	Não	Deve ser definido como ‘google_about_this_result’ para usar este motor.
output	string	Não	Formato de saída: json (padrão) ou html.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
google_domain	string	Não	Domínio do Google a usar para a busca. Padrão: google.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter sugestões de autocomplete do Google Hotels

SERPAPI_GET_GOOGLE_HOTELS_AUTOCOMPLETE_SUGGESTIONS

Ferramenta para obter sugestões de autocomplete para buscas de destinos no Google Hotels. Use quando usuários precisarem buscar destinos de hotéis, propriedades ou localizações antes de realizar uma busca completa de hotel.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para autocomplete de destino (ex.: ‘Nova York’, ‘Hotéis Paris’, ‘Resorts Bali’).
gl	string	Não	Código de país para a busca de autocomplete. Padrão: ‘us’.
hl	string	Não	Código de idioma para os resultados de autocomplete. Padrão: ‘en’.
async	boolean	Não	Submeter busca de forma assíncrona e recuperar resultados mais tarde.
currency	string	Não	Código de moeda para informações de preço (ex.: ‘USD’, ‘EUR’, ‘BRL’). Padrão: ‘USD’.
no_cache	boolean	Não	Força o SerpAPI a buscar resultados atualizados mesmo se uma versão em cache existir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter conteúdo relacionado de imagens do Google

SERPAPI_GET_GOOGLE_IMAGES_RELATED_CONTENT

Obtém conteúdo relacionado para um resultado específico do Google Imagens. Requer um related_content_id obtido de uma busca no Google Imagens. Use quando precisar encontrar imagens semelhantes ou conteúdo visual relacionado para uma imagem específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Consulta de busca que corresponde à busca original do Google Imagens. Recomendado para melhores resultados.
gl	string	Não	Código de país para os resultados de busca.
hl	string	Não	Código de idioma para os resultados de busca.
async	boolean	Não	Submeter a busca de forma assíncrona.
output	string	Não	Formato de resposta: ‘json’ (padrão) ou ‘html’.
no_cache	boolean	Não	Forçar resultados atualizados ignorando o cache do SerpApi.
related_content_id	string	Sim	ID único para recuperar o conteúdo relacionado de uma imagem. Obtido da resposta da API do Google Imagens (campo ‘related_content_id’).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter detalhes de patente do Google

SERPAPI_GET_GOOGLE_PATENT_DETAILS

Ferramenta para recuperar informações detalhadas sobre uma patente específica ou documento do Google Scholar via SerpApi. Use quando precisar de detalhes de patente, reivindicações, citações, inventores, cessionários, eventos legais ou informações de publicação acadêmica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
async	boolean	Não	Submeter busca de forma assíncrona. Padrão: false.
output	string	Não	Formato de saída. Apenas ‘json’ é suportado.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo se uma versão em cache existir. O cache expira após 1 hora.
patent_id	string	Sim	O ID da patente ou documento acadêmico. Use o formato ‘patent/<número_de_publicação>/<código_de_país>’ para patentes (ex.: ‘patent/US11734097B1/en’) ou ‘scholar/<scholar_id>’ para documentos acadêmicos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter arquivo de busca

SERPAPI_GET_SEARCH_ARCHIVE

Ferramenta para recuperar resultados de uma busca assíncrona anterior usando seu ID de busca. Use quando precisar buscar resultados de buscas submetidas com async=true. Buscas podem ser recuperadas até 31 dias após a conclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
search_id	string	Sim	O ID da busca a recuperar. Retornado de uma busca assíncrona anterior (quando o parâmetro async=true foi usado). O search_id pode ser encontrado no campo search_metadata.id da resposta da busca assíncrona.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Lista de domínios do Google

SERPAPI_GOOGLE_DOMAINS_LIST

Recupera a lista de domínios do Google suportados para consultas de busca.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca em fóruns do Google

SERPAPI_GOOGLE_FORUMS_SEARCH

Ferramenta para raspar resultados de fóruns da Plataforma de Fóruns do Google usando SerpApi. Use quando precisar buscar discussões em fóruns, obter títulos, datas, links, respostas com dados de votação e buscas relacionadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Define a consulta que você quer buscar nos Fóruns do Google.
gl	string	Não	Define o país para usar na busca. Código de país de duas letras.
hl	string	Não	Define o idioma para a interface de busca. Código de idioma de duas letras.
nfpr	integer	Não	Define se excluir resultados de uma consulta corrigida automaticamente.
uule	string	Não	Localização codificada pelo Google para usar na busca. Não pode ser usado com o parâmetro location.
start	integer	Não	Define o deslocamento de resultados para paginação.
device	string	Não	Define o tipo de dispositivo para a busca. Opções: desktop (padrão), tablet, mobile.
engine	string	Não	Definir como google_forums para usar o motor da API de Fóruns do Google.
filter	integer	Não	Define se habilitar ou desabilitar o filtro de resultados similares/omitidos.
output	string	Não	Define o formato de saída final: json (padrão) ou html.
location	string	Não	Define de onde você quer que a busca se origine. Não pode ser usado com o parâmetro uule.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
async_req	boolean	Não	Define o modo de submissão da busca ao SerpApi. Definir como true para submissão assíncrona.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
json_restrictor	string	Não	Permite restringir campos de saída específicos na resposta JSON.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de empregos no Google

SERPAPI_GOOGLE_JOBS_SEARCH

Recupera resultados de busca de empregos do Google via SerpApi. Retorna dados de SERP de empregos em JSON; atributos como work_from_home, posted_at, salary e schedule_type são aninhados em detected_extensions por objeto de vaga e frequentemente ausentes — trate como opcionais. Os resultados podem incluir vagas desatualizadas; verifique a recência via detected_extensions.posted_at. Suporta paginação, filtragem por localização e filtragem de vagas remotas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Define a consulta que você quer buscar.
gl	string	Não	Define o país para usar na busca. Código de país de duas letras.
hl	string	Não	Define o idioma para a busca. Código de idioma de duas letras.
uds	string	Não	Habilita filtro de busca. É uma string fornecida pelo Google como filtro.
lrad	integer	Não	Define o raio de busca em quilômetros. Não limita estritamente o raio.
uule	string	Não	Localização codificada pelo Google para usar na busca. Não pode ser usado com o parâmetro location.
chips	string	Não	Define condições de consulta adicionais.
ltype	integer	Não	Filtrará os resultados por trabalho em casa. Definir como 1 para vagas home office.
engine	string	Não	Definir como google_jobs para usar o motor da API de Empregos do Google.
output	string	Não	Define o formato de saída final: json (padrão) ou html.
location	string	Não	Define de onde você quer que a busca se origine. Recomenda-se especificar a localização em nível de cidade.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
async_req	boolean	Não	Define o modo de submissão da busca ao SerpApi.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
google_domain	string	Não	Define o domínio do Google a usar. Padrão: google.com.
next_page_token	string	Não	Define o token da próxima página para paginação. Retorna até 10 resultados por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca visual com Google Lens

SERPAPI_GOOGLE_LENS_SEARCH

Realiza busca reversa de imagem usando o Google Lens para encontrar imagens visualmente similares, produtos e conteúdo relacionado. Use quando precisar identificar objetos, encontrar produtos similares ou obter informações sobre imagens. Requer uma URL de imagem acessível publicamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Consulta de busca opcional para refinar resultados. Funciona com os tipos ‘all’, ‘visual_matches’ ou ‘products’.
hl	string	Não	Código de idioma de duas letras para resultados localizados (ex.: ‘en’, ‘es’, ‘pt’).
url	string	Sim	A URL de uma imagem para realizar a busca visual do Google Lens. Deve ser uma URL de imagem acessível publicamente.
type	string	Não	Tipo de busca para filtrar resultados. Opções: ‘all’ (padrão), ‘products’ (resultados de compras), ‘exact_matches’ (imagens idênticas), ‘visual_matches’ (imagens similares).
country	string	Não	Código de país de duas letras para resultados localizados (ex.: ‘us’, ‘uk’, ‘br’).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca leve no Google

SERPAPI_GOOGLE_LIGHT_SEARCH

Recupera resultados de busca leve do Google via SerpApi. Suporta q, localização, gl, hl e outros parâmetros SERP. Retorna dados JSON leves de SERP; resultados estão em organic_results (trate ausência/vazio graciosamente). Os snippets são superficiais — siga as URLs de citação para o conteúdo completo. Limite de taxa: HTTP 429 sob uso intenso; mantenha ~1–2 requisições/s com backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Define a consulta que você quer buscar. Pode usar qualquer coisa que usaria em uma busca normal no Google.
gl	string	Não	Define o país para usar na busca do Google. Código de país de duas letras. Exemplo: “us”.
hl	string	Não	Define o idioma para a busca. Código de idioma de duas letras. Exemplo: “en”.
lr	string	Não	Define um ou múltiplos idiomas para limitar a busca. Exemplo: “lang_fr|lang_de”.
num	integer	Não	Define o número máximo de resultados a retornar. (ex.: 10 (padrão), 40, 100). Valor máximo: 100.
nfpr	string	Não	Define a exclusão de resultados de uma consulta corrigida automaticamente.
safe	string	Não	Define o nível de filtragem de conteúdo adulto. Pode ser active ou off.
uule	string	Não	Localização codificada pelo Google para usar na busca.
start	integer	Não	Define o deslocamento de resultados para paginação.
device	string	Não	Define o dispositivo para obter os resultados: desktop, tablet ou mobile.
engine	string	Não	Definir como google_light para usar o motor da API Google Light.
filter	string	Não	Define se os filtros de ‘Resultados Similares’ e ‘Resultados Omitidos’ estão ligados.
output	string	Não	Define o formato de saída final: ‘json’ (padrão) ou ‘html’.
location	string	Não	Define de onde você quer que a busca se origine. Exemplo: “Austin, Texas, United States”.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
async_param	boolean	Não	Define o modo de submissão da busca ao SerpApi.
google_domain	string	Não	Define o domínio do Google a usar. Padrão: google.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Posts do Google Maps

SERPAPI_GOOGLE_MAPS_POSTS

Raspa posts do Google Maps para uma localização de negócio via SerpApi. Extrai posts locais publicados por proprietários de negócios incluindo títulos, descrições, links, imagens e datas de publicação. Retorna 10 posts por página com suporte a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data_id	string	Sim	O ID de dados do Google Maps para a localização do negócio. Formato: ‘0x89c258e28c304997:0xfcafe4e7ce35ee8c’
no_cache	boolean	Não	Forçar resultados atualizados ignorando dados em cache. Padrão: false.
next_page_token	string	Não	Token para paginação para recuperar páginas de resultados subsequentes. Cada página contém 10 posts.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Google Maps

SERPAPI_GOOGLE_MAPS_SEARCH

Realiza uma busca no Google Maps via SERP API. Recebe uma consulta, opcionalmente usando coordenadas GPS específicas e paginação, retornando dados estruturados de localização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para o Google Maps (ex.: ‘cafeterias’, ‘restaurantes perto do Parque Central’).
ll	string	Não	Coordenadas GPS para a busca, formatadas como ‘@latitude,longitude,nivel_de_zoom’. Necessário quando usar paginação (parâmetro start).
start	integer	Não	Índice de resultado inicial para paginação. Quando o start é fornecido, o parâmetro ll torna-se obrigatório.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Produto no Google Play

SERPAPI_GOOGLE_PLAY_PRODUCT

Ferramenta para recuperar informações detalhadas de produtos do Google Play usando SerpApi. Suporta apps, filmes, séries de TV, audiolivros e livros. Use quando precisar de detalhes de produto, avaliações, resenhas ou mídias de itens da Google Play Store.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
gl	string	Não	Código de país de duas letras para localização. Padrão: ‘us’.
hl	string	Não	Código de idioma de duas letras para localização. Padrão: ‘en’.
num	integer	Não	Número máximo de resenhas por busca. Máximo 199, padrão 40.
async	boolean	Não	Submeter busca de forma assíncrona. Padrão: false.
store	string	Sim	Tipo de loja: ‘apps’, ‘movies’, ‘tv’, ‘books’ ou ‘audiobooks’.
engine	string	Não	Definir como google_play_product para usar o motor da API de Produto do Google Play.
output	string	Não	Formato de resposta: ‘json’ (padrão) ou ‘html’.
rating	integer	Não	Filtrar resenhas por avaliação em estrelas (1-5).
sort_by	integer	Não	Ordenar resenhas: 1 (relevante), 2 (mais recentes), 3 (avaliação).
no_cache	boolean	Não	Ignorar cache e forçar resultados atualizados. Padrão: false.
platform	string	Não	Filtrar resenhas por tipo de dispositivo: ‘phone’, ‘tablet’, ‘watch’, ‘chromebook’ ou ‘tv’.
season_id	string	Não	ID de temporada quando a loja é ‘tv’. Aplicável apenas para a loja de TV.
product_id	string	Sim	ID do produto para consultar (ex.: ‘com.google.android.youtube’ para apps).
all_reviews	boolean	Não	Recuperar todas as resenhas. Definir como true para buscar todas as resenhas disponíveis.
next_page_token	string	Não	Token de paginação para recuperar resultados adicionais de resenhas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Perfil de autor no Google Scholar

SERPAPI_GOOGLE_SCHOLAR_AUTHOR

Raspa a página completa de autor do Google Scholar incluindo artigos, citações, métricas e coautores. Use quando precisar de informações detalhadas sobre as publicações e perfil acadêmico de um pesquisador específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
hl	string	Não	Código de idioma de duas letras para o idioma da interface.
num	integer	Não	Número de resultados por página. Máximo 100, padrão 20.
sort	string	Não	Ordenar artigos por ‘title’ ou ‘pubdate’. Padrão: por contagem de citações.
start	integer	Não	Deslocamento de resultados para paginação. Padrão: 0.
view_op	string	Não	Ver seções específicas. Use ‘view_citation’ para ver uma citação específica ou ‘list_colleagues’ para listar colegas.
no_cache	boolean	Não	Forçar resultados atualizados, ignorando dados em cache.
author_id	string	Sim	Identificador único do autor no Google Scholar. Necessário para buscar o perfil do autor.
citation_id	string	Não	Necessário quando view_op=‘view_citation’. Identificador único para a citação específica a visualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Citar no Google Scholar

SERPAPI_GOOGLE_SCHOLAR_CITE

Raspa citações completas do Google Scholar com múltiplos formatos. Recupera citações no estilo MLA, APA, Chicago, Harvard e Vancouver, junto com links de download para BibTeX, EndNote, RefMan e RefWorks. Use quando precisar de citações formatadas para um artigo de pesquisa específico identificado pelo ID do Google Scholar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	O ID de um resultado orgânico individual do Google Scholar. Necessário para buscar informações de citação de um artigo específico.
hl	string	Não	Código de idioma de duas letras para localização (ex.: ‘en’, ‘es’, ‘pt’).
no_cache	boolean	Não	Forçar resultados atualizados, ignorando dados em cache.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca leve de vídeos do Google

SERPAPI_GOOGLE_VIDEOS_LIGHT

Ferramenta para raspar resultados de vídeos do Google usando a API Google Videos Light do SerpApi. Use quando precisar de títulos, links, miniaturas, snippets, datas de upload e durações de vídeos da busca de vídeos do Google. Esta versão leve exclui resultados ricos para tempos de resposta mais rápidos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para vídeos do Google. Suporta operadores avançados como inurl:, site:, intitle:.
gl	string	Não	Código de país de duas letras para definir o país da busca.
hl	string	Não	Código de idioma de duas letras para definir o idioma da interface de busca.
lr	string	Não	Restrições de idioma usando o formato lang_{código}, delimitadas por pipe |.
tbs	string	Não	Parâmetros de busca avançada para filtrar por duração do vídeo, data de upload, qualidade ou fonte.
nfpr	integer	Não	Excluir resultados corrigidos automaticamente.
safe	string	Não	Filtro de conteúdo adulto.
uule	string	Não	Parâmetro de localização codificado pelo Google. Não pode ser usado com o parâmetro location.
start	integer	Não	Deslocamento de resultados para paginação.
device	string	Não	Tipo de dispositivo para a busca. Opções: desktop (padrão), tablet, mobile.
engine	string	Não	Definir como google_videos_light para usar o motor da API Google Videos Light.
filter	integer	Não	Controlar o filtro de resultados similares.
output	string	Não	Formato de saída: json (padrão) ou html.
location	string	Não	Localização geográfica para a origem da busca. Recomendado especificar em nível de cidade.
no_cache	boolean	Não	Forçar resultados atualizados mesmo se versão em cache existir.
async_req	boolean	Não	Habilitar modo de submissão assíncrona.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
google_domain	string	Não	Domínio do Google a usar para a busca. Padrão: google.com.
json_restrictor	string	Não	Restringir campos de saída específicos na resposta JSON.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de hotéis

SERPAPI_HOTEL_SEARCH

Recupera resultados de busca de hotéis do Google. Suporta parâmetros como q (consulta), localização, etc. Retorna dados de SERP de hotéis em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Define a consulta de busca. Pode usar qualquer coisa que usaria em uma busca normal no Google Hotels.
gl	string	Não	Define o país para usar na busca. Código de país de duas letras. (ex.: us, uk, fr)
hl	string	Não	Define o idioma para a busca. Código de idioma de duas letras. (ex.: en, es, fr)
async	boolean	Não	Define o modo de submissão da busca ao SerpApi.
adults	integer	Não	Define o número de adultos. Padrão: 2.
output	string	Não	Define o formato de saída: json (padrão) ou html.
rating	integer	Não	Usado para filtrar resultados por avaliação.
sort_by	string	Não	Usado para ordenar os resultados. Padrão: ordenar por relevância.
bedrooms	integer	Não	Define o número mínimo de quartos. Padrão: 0.
children	integer	Não	Define o número de crianças. Padrão: 0.
currency	string	Não	Define a moeda dos preços retornados. Padrão: USD.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
amenities	string	Não	Define para incluir apenas resultados que ofereçam as comodidades especificadas.
bathrooms	integer	Não	Define o número mínimo de banheiros. Padrão: 0.
max_price	integer	Não	Define o limite superior do intervalo de preço.
min_price	integer	Não	Define o limite inferior do intervalo de preço.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
check_in_date	string	Sim	Define a data de check-in. O formato é YYYY-MM-DD.
children_ages	string	Não	Define as idades das crianças. O intervalo de idade é de 1 a 17.
eco_certified	boolean	Não	Define para mostrar resultados com certificação ecológica.
check_out_date	string	Sim	Define a data de check-out. O formato é YYYY-MM-DD.
property_token	string	Não	Usado para obter detalhes de uma propriedade específica.
property_types	string	Não	Define para incluir apenas certos tipos de propriedade nos resultados.
special_offers	boolean	Não	Define para mostrar resultados com ofertas especiais.
next_page_token	string	Não	Define o token da próxima página para paginação.
vacation_rentals	boolean	Não	Define para buscar resultados de Aluguel para Temporada. Padrão: busca por Hotéis.
free_cancellation	boolean	Não	Define para mostrar resultados com cancelamento gratuito.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de imagens

SERPAPI_IMAGE_SEARCH

Busca imagens no Google via SERP API para uma consulta fornecida, retornando resultados de imagens estruturados. O número de resultados pode ser controlado usando o parâmetro ‘num’ (1-100). Se não especificado, retorna 20 resultados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Número de resultados de imagens a retornar. Padrão: 20. O Google normalmente retorna até 100 resultados.
query	string	Sim	Consulta para encontrar imagens; seja específico sobre o tópico ou assunto. Combine detalhes de sujeito, estilo, contexto e público para resultados precisos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Naver

SERPAPI_NAVER_SEARCH

Ferramenta para buscar no Naver (principal mecanismo de busca da Coreia do Sul) por resultados e conteúdos web em coreano. Use quando buscar conteúdo em idioma coreano, notícias, vídeos, imagens ou resultados de compras. Suporta várias categorias de busca e opções de filtragem incluindo períodos de tempo e ordenação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Resultados máximos por página (1-100, padrão 50). Disponível apenas para a API de Imagens.
page	integer	Não	Número de página (começa em 1).
async	boolean	Não	Submeter busca de forma assíncrona quando true.
query	string	Sim	String de consulta de busca suportando operadores como NOT, OR, site:, filetype:, near:, ip:, loc:, feed:.
start	integer	Não	Deslocamento de resultados para paginação. Padrão: 1.
where	string	Não	Categoria de busca. Opções: ‘nexearch’ (busca integrada, padrão), ‘web’, ‘video’, ‘news’, ‘image’.
device	string	Não	Tipo de dispositivo a simular. Opções: ‘desktop’ (padrão), ‘tablet’ ou ‘mobile’.
output	string	Não	Formato de saída. Opções: ‘json’ (padrão) ou ‘html’.
period	string	Não	Filtro de período. Opções: ‘all’ (padrão), ‘1h’, ‘1d’, ‘1w’, ‘1m’, ‘3m’, ‘6m’, ‘1y’, ou formato customizado ‘fromYYYYMMDDtoYYYYMMDD’.
sort_by	string	Não	Ordem de classificação. Opções: ‘r’ (relevância, padrão) ou ‘dd’ (mais recentes).
no_cache	boolean	Não	Forçar resultados atualizados quando true, ignorando cache de 1 hora.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de artigos de notícias

SERPAPI_NEWS_SEARCH

Busca notícias do Google (via SerpApi, tbm=nws) por artigos correspondentes a uma consulta; consultas de frases-chave precisas geram melhores resultados. Resultados retornados no campo news_results (~10 itens/página). Limitado por taxa: ~1 req/s; HTTP 429 em picos — aplique backoff exponencial (1s, 2s, 4s). Cobre apenas conteúdo de notícias; combine com SERPAPI_SEARCH para fontes web mais amplas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Número máximo de resultados a retornar por página. Padrão: 10, máximo: 100.
query	string	Sim	Consulta de busca para encontrar artigos de notícias relevantes. Consultas muito longas ou específicas podem retornar resultados vazios; simplifique para frases-chave e divida buscas de múltiplos conceitos em consultas separadas.
start	integer	Não	Deslocamento de resultados para paginação. Use 0 para a primeira página (padrão), 10 para a segunda, 20 para a terceira, etc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de resenhas no OpenTable

SERPAPI_OPEN_TABLE_REVIEWS

Ferramenta para raspar resenhas de restaurantes do OpenTable usando SerpApi. Recupera resenhas de usuários, avaliações, respostas do restaurante, imagens e resumos gerados por IA. Use quando precisar de dados detalhados de resenhas para restaurantes do OpenTable.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número de página para paginação (índice com base 1).
async	boolean	Não	Submeter busca de forma assíncrona. Padrão: false.
output	string	Não	Formato de resposta: ‘json’ (padrão) ou ‘html’.
no_cache	boolean	Não	Forçar resultados atualizados ignorando cache.
place_id	string	Sim	ID do restaurante no OpenTable (ex.: ‘central-park-boathouse-new-york-2’). Encontrado na URL do OpenTable após /r/.
zero_trace	boolean	Não	Recurso enterprise para não armazenar dados da busca.
json_restrictor	string	Não	Restringir campos de saída para respostas menores (ex.: ‘reviews’).
open_table_domain	string	Não	Domínio do OpenTable a usar. Padrão: ‘www.opentable.com’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Google Play

SERPAPI_PLAY_SEARCH

Recupera resultados de busca da Google Play Store. Suporta parâmetros como q (consulta), gl, hl, etc. Retorna dados de SERP de apps em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Define a consulta que você quer buscar na Google Play Apps Store.
hl	string	Não	Define o idioma para a busca. Código de idioma de duas letras. (ex.: en (padrão), es, fr).
age	string	Não	Define a subcategoria de faixa etária. Funciona apenas com apps_category=FAMILY (Apps Infantis).
chart	string	Não	Usado para mostrar os top charts. Pode retornar até 50 resultados.
store	string	Não	Define o país para usar na busca. Código de país de duas letras. (ex.: us (padrão), uk, fr).
engine	string	Não	Definir como google_play para usar o motor da API Google Play.
output	string	Não	Define o formato de saída: json (padrão) ou html.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
async_param	boolean	Não	Define o modo de submissão da busca ao SerpApi.
store_device	string	Não	Define o dispositivo para ordenar resultados. Não pode ser usado com apps_category ou q.
apps_category	string	Não	Define a categoria da loja de apps.
see_more_token	string	Não	Define o token “ver mais” para recuperar resultados de paginação de seções individuais.
next_page_token	string	Não	Define o token da próxima página para paginação.
section_page_token	string	Não	Define o token de página de seção para paginação de seções individuais.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Google Scholar

SERPAPI_SCHOLAR_SEARCH

Busca no Google Scholar via SerpApi por literatura acadêmica, artigos e citações com base em uma consulta. Os resultados podem incluir inline_links.cited_by e resources (links de PDF), mas esses campos não são garantidos; verifique sua existência e tipo antes de acessar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Número máximo de resultados a retornar por página. Padrão: 10, máximo: 20.
query	string	Sim	A consulta de busca para o Google Scholar. Pode ser um tópico acadêmico, título de artigo, nome de autor ou palavras-chave específicas.
start	integer	Não	Deslocamento de resultados para paginação. Use 0 para a primeira página (padrão), 10 para a segunda, 20 para a terceira, etc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no SerpApi (Google)

SERPAPI_SEARCH

Realiza uma busca em tempo real no Google via a conexão SerpAPI. Retorna ~10 resultados orgânicos por página aninhados em results.organic_results — não é uma lista plana; trate arrays ausentes/vazios graciosamente. Pagine via deslocamento start ou serpapi_pagination.next; máx. num=100; pare quando os domínios se repetirem para evitar esgotamento de cota. Limitado por taxa: ~1–2 req/s; HTTP 429 em picos — backoff exponencial (1s, 2s, 4s). Use ferramentas verticais (SERPAPI_IMAGE_SEARCH, SERPAPI_NEWS_SEARCH, SERPAPI_YOU_TUBE_SEARCH, SERPAPI_GOOGLE_JOBS_SEARCH) para tipos de consulta especializados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Consulta de busca do usuário; deve ser uma pergunta clara e concisa ou frase-chave.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca na Apple App Store

SERPAPI_SEARCH_APPLE_APP_STORE

Ferramenta para buscar apps iOS e Mac na Apple App Store. Retorna detalhes de apps incluindo avaliações, resenhas, descrições e informações do desenvolvedor. Use quando precisar encontrar apps na Apple App Store ou obter informações sobre apps específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Número máximo de resultados a retornar.
term	string	Sim	Termo de consulta de busca para apps da Apple App Store.
async	boolean	Não	Submeter busca de forma assíncrona.
device	string	Não	Tipo de dispositivo para filtrar resultados: ‘desktop’, ‘tablet’ ou ‘mobile’.
country	string	Não	Código de país para a busca (ex.: ‘us’, ‘uk’, ‘br’).
language	string	Não	Código de idioma para a busca (ex.: ‘en-us’, ‘pt-br’, ‘es-es’).
no_cache	boolean	Não	Forçar resultados atualizados, ignorando cache.
property	string	Não	Propriedade de busca. Definir como ‘developer’ para buscar por nome de desenvolvedor.
category_id	string	Não	Filtrar por ID de categoria (ex.: ‘6014’ para Games).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca leve de imagens do Google

SERPAPI_SEARCH_GOOGLE_IMAGES_LIGHT

Ferramenta para raspar resultados do Google Imagens usando a API Google Images Light do SerpApi. Use quando precisar de busca rápida de imagens com miniaturas, títulos, fontes e URLs de imagens originais. Esta versão leve oferece tempos de resposta mais rápidos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Consulta de busca para o Google Imagens. Suporta operadores de busca do Google como inurl:, site:, intitle:.
gl	string	Não	Código de país de duas letras para definir o país da busca.
hl	string	Não	Código de idioma de duas letras para definir o idioma da interface de busca.
imgar	string	Não	Filtro de proporção. Opções: s (quadrado), t (alto), w (largo), xw (extra largo).
imgsz	string	Não	Filtro de tamanho de imagem. Opções: l (grande), m (médio), i (ícone), etc.
start	integer	Não	Deslocamento de resultados para paginação. Deve ser entre 0 e 999.
device	string	Não	Tipo de dispositivo para a busca. Opções: desktop (padrão), tablet, mobile.
engine	string	Não	Definir como google_images_light para usar o motor da API Google Images Light.
end_date	string	Não	Data final para filtrar imagens por data de upload. Formato: YYYYMMDD.
location	string	Não	Localização geográfica para a origem da busca. Especifique em nível de cidade para melhores resultados.
start_date	string	Não	Data inicial para filtrar imagens por data de upload. Formato: YYYYMMDD.
image_color	string	Não	Filtro de cor para imagens. Opções: bw (preto e branco), red, blue, green, yellow, orange, pink, white, gray, black, teal, brown.
period_unit	string	Não	Unidade de período para filtrar por data de upload. Opções: s (segundo), n (minuto), h (hora), d (dia), w (semana), m (mês), y (ano).
period_value	integer	Não	Valor do período para usar com period_unit. Especifica quantas unidades atrás buscar.
google_domain	string	Não	Domínio do Google a usar para a busca. Padrão: google.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de serviços locais do Google

SERPAPI_SEARCH_GOOGLE_LOCAL_SERVICES

Busca serviços locais do Google por prestadores de serviços como eletricistas, encanadores, técnicos de HVAC e mais. Use quando precisar encontrar profissionais de serviço local com o selo garantido do Google e informações de negócio verificadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	Define o serviço que você quer buscar (ex.: ‘eletricista’, ‘encanador’, ‘reparo de ar condicionado’).
hl	string	Não	Define o idioma para a busca. Código de idioma de duas letras.
bid	string	Não	Identificador único de negócio. Usado com os parâmetros cid e pid para identificar um negócio específico.
cid	string	Não	ID de local único do negócio da resposta da API. Usado para obter detalhes de um negócio específico.
pid	string	Não	Identificador de local único. Usado com os parâmetros cid e bid.
async	boolean	Não	Define o modo de submissão da busca ao SerpApi.
output	string	Não	Define o formato de saída: ‘json’ (padrão) ou ‘html’.
data_cid	string	Sim	Identificador de cliente do Google para localização. Identificador único que especifica a área geográfica para a busca.
job_type	string	Não	Define a subcategoria de serviço ou tipo de trabalho específico dentro da categoria de serviço principal.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
json_restrictor	string	Não	Restringe os campos de saída para reduzir o tamanho da resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de negócios no Yelp

SERPAPI_SEARCH_YELP

Ferramenta para buscar negócios e locais no Yelp usando SerpApi. Retorna listagens de negócios com avaliações, resenhas, horários, informações de contato e detalhes de localização. Use quando precisar encontrar negócios locais, restaurantes, serviços ou ler avaliações de clientes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
attrs	string	Não	Filtros de atributos para refinar a busca (ex.: ‘HotAndNew’ para novos negócios, ‘Deals’ para negócios com ofertas). Pode ser separado por vírgulas para múltiplos filtros.
start	integer	Não	Deslocamento de resultados para paginação. Cada página normalmente contém 10 resultados.
sortby	string	Não	Ordem de classificação para resultados. ‘recommended’ mostra as recomendações do Yelp, ‘rating’ mostra os mais bem avaliados primeiro, ‘review_count’ mostra os mais avaliados primeiro.
find_loc	string	Sim	Localização para buscar (ex.: ‘São Paulo, SP’, ‘Rio de Janeiro, RJ’, ‘01310-100’). Pode ser uma cidade, estado, endereço ou CEP.
no_cache	boolean	Não	Definir como true para forçar resultados atualizados do Yelp, ignorando o cache do SerpApi.
find_desc	string	Sim	Consulta de busca descrevendo o que encontrar (ex.: ‘pizza’, ‘cafeteria’, ‘restaurante italiano’).
yelp_domain	string	Não	Domínio do Yelp para buscar (ex.: ‘yelp.com’ para EUA, ‘yelp.ca’ para Canadá, ‘yelp.co.uk’ para UK). Padrão: yelp.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de compras

SERPAPI_SHOPPING_SEARCH

Busca produtos no Google Shopping via SerpAPI, retornando listagens estruturadas em results.shopping_results. Campos de resposta como rating, review_count, extracted_price e extracted_old_price podem estar ausentes; verifique nulo antes de comparar ou calcular descontos. Porcentagens de desconto em listagens podem refletir alegações promocionais agregadas, não preços por item.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
num	integer	Não	Número máximo de resultados a retornar por página. Padrão: 10, máximo: 100.
query	string	Sim	Produto ou item para buscar no Google Shopping.
start	integer	Não	Deslocamento de resultados para paginação. Use 0 para a primeira página (padrão), 10 para a segunda, etc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de tendências do Google

SERPAPI_TRENDS_SEARCH

Busca dados do Google Trends; retorna índices de interesse relativos de 0 a 100 (não volumes absolutos) significativos apenas ao comparar consultas dentro da mesma requisição. O formato de query (termos únicos/múltiplos) deve estar em conformidade com o data_type selecionado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Consulta(s) de busca para o Google Trends (use vírgula para múltiplas). O formato (termo único vs. múltiplos) é determinado pelo data_type.
data_type	string	Não	Especifica o tipo de busca do Google Trends. Opções: TIMESERIES (interesse ao longo do tempo), GEO_MAP (comparação regional; múltiplas consultas), GEO_MAP_0 (interesse regional; consulta única), RELATED_TOPICS (tópicos relacionados; consulta única), RELATED_QUERIES (consultas relacionadas; consulta única).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Resenhas de produtos no Walmart

SERPAPI_WALMART_PRODUCT_REVIEWS

Ferramenta para raspar resenhas completas de produtos do Walmart usando a API Walmart Product Reviews do SerpApi. Recupera avaliações, texto de resenhas, informações de usuários e votos úteis para um produto específico. Use quando precisar de feedback detalhado de clientes e análise de sentimento para produtos do Walmart.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número de página para paginação. Começa em 1.
sort	string	Não	Ordem de classificação para resenhas. Opções: ‘relevancy’ (padrão), ‘helpful’ (mais úteis primeiro), ‘submission-desc’ (mais recentes primeiro), ‘submission-asc’ (mais antigas primeiro), ‘rating-desc’ (maior avaliação primeiro), ‘rating-asc’ (menor avaliação primeiro).
async	boolean	Não	Definir como true para submissão assíncrona de busca.
output	string	Não	Formato de resposta: ‘json’ (padrão) ou ‘html’.
rating	integer	Não	Filtrar resenhas por avaliação em estrelas. Deve ser um inteiro entre 1 e 5.
no_cache	boolean	Não	Definir como true para ignorar resultados em cache e forçar dados atualizados.
product_id	string	Sim	Identificador único do produto Walmart (us_item_id) para recuperar resenhas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Walmart

SERPAPI_WALMART_SEARCH

Recupera resultados de busca do Walmart. Suporta parâmetros como query, localização, ID de loja, etc. Retorna dados de SERP de produtos em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Sim	O termo ou frase de consulta de busca.
page	integer	Não	Número de página para paginação. Começa em 1.
sort	string	Não	Opção de ordenação para resultados. Opções disponíveis: best_match, best_seller, price_low, price_high, rating_high, new.
type	string	Não	Define o tipo de busca. Pode ser ‘search’, ‘deals’, ‘store’, ‘question’. Padrão: ‘search’.
location	string	Não	Define a localização para usar na busca.
store_id	string	Não	ID da loja para filtrar resultados.
max_price	number	Não	Filtro de preço máximo.
min_price	number	Não	Filtro de preço mínimo.
min_rating	number	Não	Filtro de avaliação mínima (1-5).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Yahoo

SERPAPI_YAHOO_SEARCH

Recupera resultados do mecanismo de busca Yahoo!. Suporta parâmetros de consulta, localização, idioma e dispositivo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
b	integer	Não	Define o deslocamento de resultados para paginação.
d	string	Não	Especifica o destino para tópicos relacionados.
p	string	Sim	Define a consulta de busca. Pode usar qualquer coisa que usaria em uma busca normal no Yahoo!.
vc	string	Não	Define o país para usar na busca. Código de país de duas letras. (ex.: us, uk, fr)
vf	string	Não	all formats ou formato de arquivo específico como pdf ou txt.
vl	string	Não	Define o idioma para limitar a busca. Usa lang_{código-de-idioma-de-duas-letras} para especificar idiomas.
vm	string	Não	Define o nível de filtragem de conteúdo adulto. Strict: r, Moderate: i, Off: p
vs	string	Não	Filtra resultados por domínios de nível superior separados por ’,’. (ex.: .com,.org)
fr2	string	Não	Responsável por renderizar posições e expansões para alguns elementos.
device	string	Não	Define o dispositivo para obter os resultados: desktop (padrão), tablet ou mobile.
output	string	Não	Define o formato de saída: json (padrão) ou html.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados do Yahoo! mesmo que uma versão em cache esteja disponível.
yahoo_domain	string	Não	Define o domínio do Yahoo! a usar. Padrão: search.yahoo.com.
async_request	boolean	Não	Define o modo de submissão da busca ao SerpApi.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de vídeos no Yahoo

SERPAPI_YAHOO_VIDEOS

Raspa resultados de vídeos do Yahoo! com posição, título, miniatura, link, prévia, fonte, duração, data e mais. Use quando precisar buscar conteúdo de vídeo no Yahoo! Vídeos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
b	integer	Não	Define o deslocamento de resultados para paginação.
p	string	Sim	Define a consulta de busca. Pode usar qualquer coisa que usaria em uma busca normal no Yahoo! Vídeos.
durs	string	Não	Filtra resultados pela duração do vídeo. Opções: ‘short’ (menos de 5 minutos), ‘medium’ (5-20 minutos), ‘long’ (mais de 20 minutos).
vage	string	Não	Filtra resultados pela data de upload. Opções: ‘day’ (últimas 24 horas), ‘week’ (última semana), ‘month’ (último mês), ‘year’ (último ano).
vres	string	Não	Filtra resultados pela resolução do vídeo. Opções: ‘360p’, ‘480p’, ‘720p’, ‘1080p’.
async	boolean	Não	Define o modo de submissão da busca ao SerpApi.
vsite	string	Não	Filtra resultados pela plataforma de origem do vídeo. Opções: ‘youtube’, ‘dailymotion’, ‘vimeo’, ‘mtv’, ‘cbsnews’, ‘foxnews’, ‘cnn’, ‘msn’.
device	string	Não	Define o dispositivo para obter os resultados: desktop (padrão), tablet ou mobile.
output	string	Não	Define o formato de saída: json (padrão) ou html.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados mesmo que uma versão em cache esteja disponível.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
yahoo_domain	string	Não	Define o domínio do Yahoo! a usar. Padrão: search.yahoo.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca de imagens no Yandex

SERPAPI_YANDEX_IMAGES_SEARCH

Ferramenta para buscar imagens no Yandex com filtros avançados. Use quando buscar imagens no Yandex com filtros de tamanho, cor, tipo ou realizando busca reversa de imagem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
p	integer	Não	Número de página (começa em 0, retorna até 30 resultados por página).
tab	string	Não	Aba para usar em busca reversa de imagem - about ou similar.
url	string	Não	URL de imagem para busca reversa.
crop	string	Não	Coordenadas de corte para busca reversa (formato: esquerda;topo;direita;baixo, valores 0-1).
site	string	Não	Filtrar por domínio de origem (ex.: www.shutterstock.com).
text	string	Sim	Consulta de busca - qualquer coisa que usaria em uma busca normal do Yandex Imagens.
async	boolean	Não	Definir como true para submissão assíncrona.
color	string	Não	Filtro de cor - color, gray, red, orange, yellow, cyan, green, blue, violet, white ou black.
width	integer	Não	Largura da imagem em pixels; deve ser usado com o parâmetro height.
height	integer	Não	Altura da imagem em pixels; deve ser usado com o parâmetro width.
output	string	Não	Formato de resposta - json (padrão) ou html.
recent	boolean	Não	Mostra imagens dos últimos 7 dias quando definido como true.
crop_id	string	Não	Filtrar por seção específica da imagem (apenas imagens hospedadas no Yandex).
no_cache	boolean	Não	Definir como true para ignorar resultados em cache.
file_type	string	Não	Formato de imagem - jpg, png ou gifan.
image_type	string	Não	Tipo de imagem - photo, clipart, lineart, demotivator ou face.
zero_trace	boolean	Não	Recurso enterprise para modo de privacidade.
orientation	string	Não	Orientação da imagem - horizontal, vertical ou square.
yandex_domain	string	Não	Domínio do Yandex Imagens para usar na busca (padrão: yandex.com).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no Yandex

SERPAPI_YANDEX_SEARCH

Recupera resultados de busca do Yandex. Suporta parâmetros como text (consulta), localização, etc. Retorna dados de SERP em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
p	integer	Não	Define o número de página para paginação. Começa em 0.
num	integer	Não	Define o número de resultados a retornar por página. Corresponde a ‘groups_on_page’ na API do Yandex. Padrão: 20.
lang	string	Não	Define o idioma para a busca. (ex.: ‘ru’ para russo, ‘en’ para inglês).
text	string	Sim	A string de consulta de busca.
location	string	Não	Define a localização para usar na busca. Pode ser um nome de cidade, região ou país.
yandex_domain	string	Não	Define o domínio do Yandex a usar. Padrão: yandex.com.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Busca no YouTube

SERPAPI_YOU_TUBE_SEARCH

Recupera resultados de busca do YouTube. Suporta parâmetros como search_query, localização, etc. Retorna dados de SERP de vídeos em formato JSON.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
gl	string	Não	Define o país para usar na busca. Código de país de duas letras. (ex.: us, uk, br).
hl	string	Não	Define o idioma para a busca no YouTube. Código de idioma de duas letras. (ex.: en, es, pt).
sp	string	Não	Pode ser usado para paginação. O YouTube usa paginação contínua e o token de próxima página pode ser encontrado nos campos serpapi_pagination -> next_page_token e pagination -> next_page_token na resposta JSON do SerpApi. Tokens de paginação podem expirar; limite a profundidade de paginação a 3–5 páginas.
async	boolean	Não	Define o modo de submissão da busca ao SerpApi.
output	string	Não	Define o formato de saída: json (padrão) ou html.
no_cache	boolean	Não	Forçar o SerpApi a buscar resultados do YouTube mesmo que uma versão em cache esteja disponível. O cache expira após 1h.
zero_trace	boolean	Não	Apenas enterprise. Habilita o modo ZeroTrace.
search_query	string	Sim	Define a consulta de busca. Pode usar qualquer coisa que usaria em uma busca normal no YouTube.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.