v0.2.0-beta

OpenAPI 3.1.0

Google Organic SERP Regular em tempo real

Felo API Support

MIT

Servidor

https://openapi.felo.ai

Bibliotecas Cliente

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operações

post/v1/beta/dataforseo/serp/google/organic/live/regular

Google Organic SERP Regular em tempo real

Retorna os resultados classificados de uma palavra-chave no Google, de forma síncrona. Retorna keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count e items. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.008.
Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo

application/json

Tipo: array (object | null)[]
- depth
  Tipo: integer | null
  
  profundidade de análise
  
  campo opcional
  
  número de resultados na SERP
  
  valor padrão: 10
  
  valor máximo: 200
  
  Sua conta será cobrada por cada SERP contendo até 10 resultados;
  Definir uma profundidade acima de 10 pode gerar cobranças adicionais se o mecanismo de busca retornar mais de 10 resultados;
  
  O custo pode ser calculado na página Preços.
- device
  Tipo: string | null
  
  tipo de dispositivo
  
  campo opcional
  
  retornar resultados para um tipo de dispositivo específico
  
  pode assumir os valores:desktop, mobile
  
  valor padrão: desktop
- find_targets_in
  Tipo: array string[] | null
  
  tipos de elemento do SERP a verificar para destinos
  
  campo opcional
  
  para ativar este parâmetro, stop_crawl_on_match também precisa estar ativado
  
  especifica quais tipos de elemento do SERP devem ser verificados para correspondências de destino
  
  se não for especificado, todos os elementos de primeiro nível com os campos url e domain são verificados para destinos
  
  valores possíveis: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter
  
  Observação: não pode conter os mesmos tipos de elemento que ignore_targets_in
  
  exemplo:
  
  "find_targets_in": ["organic", "featured_snippet"]
  
  saiba mais sobre este parâmetro na nossa Central de Ajuda
- group_organic_results
  Tipo: boolean | null
  
  exibir resultados relacionados
  
  campo opcional
  
  se definido como true, o elemento related_result na resposta será fornecido como um snippet do seu resultado orgânico pai;
  
  se definido como false, o elemento related_result será fornecido como um resultado orgânico separado;
  
  valor padrão: true
- ignore_targets_in
  Tipo: array string[] | null
  
  tipos de elemento do SERP a excluir da busca de destinos
  
  campo opcional
  
  para ativar este parâmetro, stop_crawl_on_match também precisa estar ativado
  
  especifica quais tipos de elemento do SERP devem ser excluídos ao buscar correspondências de destino
  
  valores possíveis: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter
  
  Observação: não pode conter os mesmos tipos de elemento que find_targets_in
  
  exemplo:
  
  "ignore_targets_in": ["paid", "images"]
  
  saiba mais sobre este parâmetro na nossa Central de Ajuda
- keyword
  Tipo: string
  
  palavra-chave
  
  campo obrigatório
  
  você pode especificar até 700 caracteres no campo keyword
  
  todos os %## serão decodificados (o caractere '+' também será decodificado como espaço)
  
  se precisar usar o caractere "%" no seu keyword, especifique-o como "%25";
  
  se precisar usar o caractere “+” no seu keyword, especifique-o como “%2B”;
  
  se este campo contiver parâmetros como 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', a cobrança por tarefa será multiplicada por 5
- language_code
  Tipo: string
  
  código do idioma do mecanismo de busca
  
  campo obrigatório se você não especificar language_name
  
  se você usar este campo, não precisa especificar language_name
  
  você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_code fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/languages
  
  exemplo:
  
  en
- language_name
  Tipo: string
  
  nome completo do idioma do mecanismo de busca
  
  campo obrigatório se você não especificar language_code
  
  se você usar este campo, não precisa especificar language_code
  
  você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_name fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/languages
  
  exemplo:
  
  English
- location_code
  Tipo: integer
  
  código do local do mecanismo de busca
  
  campo obrigatório se você não especificar location_name ou location_coordinate
  
  se você usar este campo, não precisa especificar location_name ou location_coordinate
  
  você pode obter a lista de locais disponíveis dos mecanismos de busca e seus location_code fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/locations
  
  exemplo:
  
  2840
- location_coordinate
  Tipo: string
  
  coordenadas GPS de um local
  
  campo obrigatório se você não especificar location_name ou location_code
  
  se você usar este campo, não precisa especificar location_name ou location_code
  
  o parâmetro location_coordinate deve ser especificado no formato "latitude,longitude,radius"
  
  o número máximo de casas decimais para "latitude" e "longitude": 7
  
  o valor mínimo para "radius": 199 (mm)
  
  o valor máximo para "radius": 199999 (mm)
  
  exemplo:
  
  53.476225,-2.243572,200
- location_name
  Tipo: string
  
  nome completo do local do mecanismo de busca
  
  campo obrigatório se você não especificar location_code ou location_coordinate
  
  se você usar este campo, não precisa especificar location_code ou location_coordinate
  
  você pode obter a lista de locais disponíveis do mecanismo de busca e seus location_name fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/locations
  
  exemplo:
  
  London,England,United Kingdom
- match_type
  Tipo: string
  
  tipo de correspondência de destino
  
  campo obrigatório se stop_crawl_on_match for especificado
  
  tipo de correspondência para o match_value
  
  valores possíveis:
  
  domain – domínio ou subdomínio específico
  
  with_subdomains – domínio principal e subdomínios
  
  wildcard – padrão curinga
- match_value
  Tipo: string
  
  domínio, subdomínio ou valor curinga de destino
  
  campo obrigatório se stop_crawl_on_match for especificado
  
  especifique um domínio, subdomínio ou valor curinga de destino;
  
  Observação: o domínio ou subdomínio deve ser especificado sem protocolo de requisição;
  
  exemplo: "match_value": "dataforseo.com",
  
  "match_value": "/blog/post-*"
- max_crawl_pages
  Tipo: integer | null
  
  limite de páginas rastreadas
  
  campo opcional
  
  número de páginas de resultados de pesquisa a rastrear
  
  valor máximo: 100
  
  Observação: você será cobrado por cada página rastreada (10 resultados orgânicos por página);
  
  saiba mais sobre preços na nossa página Preços;
  
  Observação nº 2: os parâmetros max_crawl_pages e depth se complementam;
  
  saiba mais na nossa Central de Ajuda
- os
  Tipo: string | null
  
  sistema operacional do dispositivo
  
  campo opcional
  
  se você especificar desktop no campo device, escolha entre os seguintes valores: windows, macos
  
  valor padrão: windows
  
  se você especificar mobile no campo device, escolha entre os seguintes valores: android, ios
  
  valor padrão: android
- se_domain
  Tipo: string | null
  
  domínio do mecanismo de busca
  
  campo opcional
  
  escolhemos o domínio do mecanismo de busca relevante automaticamente de acordo com o local e o idioma especificados
  
  no entanto, você pode definir um domínio de mecanismo de busca personalizado neste campo
  
  exemplo:
  
  google.co.uk, google.com.au, google.de, etc.
- search_param
  Tipo: string | null
  
  parâmetros adicionais da consulta de pesquisa
  
  campo opcional
  
  obtenha a lista de parâmetros disponíveis e mais detalhes aqui
  
  Observação: os seguintes parâmetros do mecanismo de busca não são suportados e serão removidos automaticamente se forem especificados: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- stop_crawl_on_match
  Tipo: array (object | null)[] | null
  
  array de destinos para interromper o rastreamento campo opcional se especificado, a resposta conterá resultados de SERP até o match_value especificado, inclusive; você pode especificar até 10 valores de destino neste array exemplo: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] saiba mais sobre este parâmetro na nossa Central de Ajuda - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Sua conta será cobrada por cada SERP rastreada pelos destinos especificados
  
  match_type
  Tipo: string | null
  
  tipo de correspondência de destino campo obrigatório se stop_crawl_on_match for especificado; tipo de correspondência para match_value valores possíveis: domain, with_subdomains, wildcard
  
  match_value
  Tipo: string | null
  
  domínio ou valor curinga de destino campo obrigatório se stop_crawl_on_match for especificado; especifique um domínio ou valor curinga de destino; Observação: o nome de domínio deve ser especificado sem protocolo de requisição; exemplo: dataforseo.com
- tag
  Tipo: string | null
  
  identificador de tarefa definido pelo usuário
  
  campo opcional
  
  o limite é de 255 caracteres
  
  você pode usar este parâmetro para identificar a tarefa e associá-la ao resultado
  
  você encontrará o valor tag especificado no objeto data da resposta
- target
  Tipo: string | null
  
  domínio, subdomínio ou página web de destino para obter resultados
  
  campo opcional
  
  um domínio ou subdomínio deve ser especificado sem https:// e www.
  
  observe que os resultados de tarefas específicas de target incluirão apenas elementos do SERP que contenham uma string url;
  
  você também pode usar o caractere curinga (‘*’) para especificar o padrão de pesquisa na SERP e restringir os resultados;
  
  exemplos:
  
  example.com - retorna resultados para a página inicial do site com URLs, como https://example.com, ou https://www.example.com/, ou https://example.com/;
  
  example.com* - retorna resultados para o domínio, incluindo todas as suas páginas;
  
  *example.com* - retorna resultados para o domínio inteiro, incluindo todas as suas páginas e subdomínios;
  
  *example.com - retorna resultados para a página inicial independentemente do subdomínio, como https://en.example.com;
  
  example.com/example-page - retorna resultados para a URL exata;
  
  example.com/example-page* - retorna resultados para todas as URLs do domínio que começam com a string especificada
- target_search_mode
  Tipo: string | null
  
  modo de correspondência de destino
  
  campo opcional
  
  para habilitar este parâmetro, stop_crawl_on_match também deve estar habilitado
  
  define como o rastreamento deve parar quando vários destinos são especificados em stop_crawl_on_match
  
  valores possíveis: all, any
  
  all – o rastreamento para somente quando todos os destinos especificados são encontrados
  
  any – o rastreamento para quando qualquer destino é encontrado
  
  valor padrão: any
  
  saiba mais sobre este parâmetro na nossa Central de Ajuda
- url
  Tipo: string | null
  
  URL direta da consulta de pesquisa
  
  campo opcional
  
  você pode especificar uma URL direta e nós a converteremos nos campos necessários. Observe que este método é o mais difícil para nossa API processar e também exige que você especifique o idioma e o local exatos na URL. Na maioria dos casos, não recomendamos usar este método.
  
  exemplo:
  
  https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
  
  Observação: os seguintes parâmetros do mecanismo de busca não são suportados e serão removidos automaticamente se especificados na URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.

Respostas

200
Tipo: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveRegularResponseInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

status_code
Tipo: integer | null

código de status geral você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa geral você pode encontrar a lista completa das mensagens informativas gerais aqui

tasks
Tipo: array (object | null)[] | null

array de tarefas

Tipo: object | null · Response36Afe1097B20_SerpGoogleOrganicLiveRegularTaskInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

data
Tipo: object | null

contém os mesmos parâmetros que você especificou na requisição POST

propertyName
Tipo: object | null
id
Tipo: string | null

identificador da tarefa identificador exclusivo da tarefa em nosso sistema no formato UUID

path
Tipo: array (string | null)[] | null

caminho da URL

result
Tipo: array (object | null)[] | null

array de resultados

check_url
Tipo: string | null

URL direta para os resultados do mecanismo de busca
você pode usá-la para garantir que fornecemos resultados exatos

datetime
Tipo: string | null

data e hora em que o resultado foi recebido
no formato UTC: “yyyy-mm-dd hh-mm-ss +00:00”
exemplo:
2019-11-15 12:57:46 +00:00

item_types
Tipo: array (string | null)[] | null

tipos de resultados de pesquisa encontrados na SERP
contém os tipos de todos os resultados de pesquisa (items) encontrados na SERP retornada
tipos de itens possíveis:
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview

observação: este array contém todos os tipos de resultados de pesquisa encontrados na SERP retornada;
no entanto, este endpoint fornece dados apenas para os tipos featured_snippet, organic e paid
para obter todos os itens (incluindo recursos de SERP e rich snippets) encontrados na SERP retornada, consulte o endpoint Google Organiс Advanced SERP

items
Tipo: array (object | null)[] | null

itens do elemento

page
Tipo: integer | null

número da página de resultados de pesquisa
indica o número da página da SERP em que o elemento está localizado

position
Tipo: string | null

o alinhamento do elemento na SERP
pode assumir os seguintes valores:
left, right

rectangle
Tipo: object | null · Response36Afe1097B20_AiModeRectangleInfo

parâmetros do retângulo
contém coordenadas cartesianas e dimensões em pixels do snippet do resultado na SERP
equivale a null se calculate_rectangles na requisição POST não estiver definido como true

height
Tipo: number | null Formato: double

altura do elemento em pixels

width
Tipo: number | null Formato: double

largura do elemento em pixels

x
Tipo: number | null Formato: double

coordenada do eixo x coordenada do eixo x do canto superior esquerdo do snippet do resultado, em que o canto superior esquerdo da tela é a origem

y
Tipo: number | null Formato: double

coordenada do eixo y coordenada do eixo y do canto superior esquerdo do snippet do resultado, em que o canto superior esquerdo da tela é a origem

type
Tipo: string | null

tipo de elemento

xpath
Tipo: string | null

o XPath do elemento

items_count
Tipo: integer | null Formato: int64

o número de resultados retornados no array items

keyword
Tipo: string | null

palavra-chave recebida em um array POST
a palavra-chave é retornada com %## decodificado (o caractere '+' será decodificado como um espaço)

language_code
Tipo: string | null

código de idioma em um array POST

location_code
Tipo: integer | null

código de localização em um array POST

pages_count
Tipo: integer | null Formato: int64

total de páginas de resultados de pesquisa recuperadas
número total de SERPs recuperadas no resultado

refinement_chips
Tipo: object | null · Response36Afe1097B20_RefinementChipsInfo

chips de refinamento de pesquisa

items
Tipo: array (object | null)[] | null

itens do elemento

domain
Tipo: string | null

domínio na SERP

options
Tipo: array (object | null)[] | null

mais opções de refinamento da pesquisa

domain
Tipo: string | null

domínio na SERP

title
Tipo: string | null

título do elemento

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

URL de pesquisa com parâmetros de refinamento

title
Tipo: string | null

título do elemento

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

URL de pesquisa com parâmetros de refinamento

type
Tipo: string | null

tipo de elemento

xpath
Tipo: string | null

o XPath do elemento

se_domain
Tipo: string | null

domínio do mecanismo de busca em um array POST

se_results_count
Tipo: integer | null Formato: int64

número total de resultados na SERP

spell
Tipo: object | null · Response36Afe1097B20_SpellInfo

autocorreção do mecanismo de busca
se o mecanismo de busca forneceu resultados para uma palavra-chave corrigida, indicaremos a palavra-chave corrigida pelo mecanismo de busca e o tipo de autocorreção

keyword
Tipo: string | null

palavra-chave obtida como resultado da autocorreção do mecanismo de pesquisa os resultados serão fornecidos para a palavra-chave corrigida

type
Tipo: string | null

tipo de autocorreção valores possíveis: did_you_mean, showing_results_for, no_results_found_for, including_results_for observação: Yahoo e Yandex suportam apenas o seguinte tipo de autocorreção: including_results_for

type
Tipo: string | null

tipo de elemento

result_count
Tipo: integer | null Formato: int64

número de elementos no array de resultados

status_code
Tipo: integer | null

código de status da tarefa gerado pelo DataForSEO; pode estar no seguinte intervalo: 10000-60000 você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa da tarefa você pode encontrar a lista completa das mensagens informativas gerais aqui

time
Tipo: string | null

tempo de execução, segundos

tasks_count
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas

tasks_error
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas retornadas com erro

time
Tipo: string | null

tempo total de execução, em segundos

version
Tipo: string | null

a versão atual da API
application/json
400

Não foi possível processar a requisição. Verifique os parâmetros da requisição.
401

É necessária uma chave de API da Felo válida.
402

A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.
403

A conta não tem permissão para realizar esta operação.
429

Um limite de requisições ou de gastos foi atingido.
502

O serviço não pôde concluir a requisição.
503

A API ou o serviço de cobrança está temporariamente indisponível.
504

O serviço atingiu o tempo limite ao processar a requisição.
default

Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

application/json

post/v1/beta/dataforseo/serp/google/organic/live/regular

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/live/regular \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  }
]'

Mostrar Schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "keyword": null,
          "type": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "check_url": null,
          "datetime": null,
          "spell": {
            "keyword": null,
            "type": null
          },
          "refinement_chips": {
            "type": null,
            "xpath": null,
            "items": [
              "[Max Depth Exceeded]"
            ]
          },
          "item_types": [
            null
          ],
          "se_results_count": null,
          "pages_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "page": null,
              "position": null,
              "xpath": null,
              "rectangle": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

Operação bem-sucedida

Google Organic SERP Regular em tempo real

AutenticaçãoRequired

DataForSEO

Google Organic SERP Regular em tempo real

Referência de preços