v0.2.0-beta

OpenAPI 3.1.0

Tarefas de pesquisa de listagens de empresas 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/business_data/business_listings/search/live

Tarefas de pesquisa de listagens de empresas em tempo real

Pesquisa o próprio índice do DataForSEO de listagens de empresas locais por categories, description, title e location_coordinate — uma tripla de latitude, longitude e raio. Retorna total_count, count, offset, offset_token e items, paginados com o token. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. Isto lê um índice e responde na hora; todo o resto aqui enfileira uma raspagem ao vivo da fonte. Comece por aqui e aprofunde só onde importar.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.2428.
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)[]
- categories
  Tipo: array string[] | null
  
  categorias de empresas
  campo opcional
  as categorias que você especificar são usadas para pesquisar listagens de empresas;
  se você não usar este campo, retornaremos as listagens de empresas encontradas na localização especificada;
  você pode especificar até 10 categorias
- description
  Tipo: string | null
  
  descrição do elemento no SERP
  campo opcional
  a descrição da entidade comercial para a qual os resultados são coletados;
  pode conter até 200 caracteres
- filters
  Tipo: array (object | null)[] | null
  
  array de parâmetros de filtragem de resultados
  campo opcional
  você pode adicionar vários filtros de uma vez (máximo de 8 filtros)
  defina um operador lógico and ou or entre as condições
  os seguintes operadores são suportados:
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
  você pode usar o operador % com like e not_like para corresponder a qualquer string de zero ou mais caracteres
  exemplo:
  ["rating.value",">",3]
  você pode receber a lista de filtros disponíveis fazendo uma requisição separada para https://api.dataforseo.com/v3/business_data/business_listings/available_filters
  A lista completa de filtros possíveis está disponível aqui.
  
  Objeto vazio
- is_claimed
  Tipo: boolean | null
  
  indica se a empresa foi verificada pelo proprietário no Google Maps
  campo opcional
- limit
  Tipo: integer | null
  
  o número máximo de empresas retornadas
  campo opcional
  valor padrão: 100
  valor máximo: 1000
- location_coordinate
  Tipo: string | null
  
  coordenadas GPS de uma localização
  campo opcional
  o parâmetro location_coordinate deve ser especificado no formato "latitude,longitude,radius"
  o número máximo de dígitos decimais para "latitude" e "longitude": 7
  o valor de "radius" é especificado em quilômetros (km)
  o valor mínimo para "radius": 1
  o valor máximo para "radius": 100000
  exemplo:
  53.476225,-2.243572,200
  saiba mais sobre como definir parâmetros de localização nesta API em nossa Central de Ajuda
- offset
  Tipo: integer | null
  
  deslocamento no array de resultados de empresas retornadas
  campo opcional
  valor padrão: 0
  se você especificar o valor 10, as dez primeiras entidades do array de resultados serão omitidas e os dados serão fornecidos para as entidades seguintes
  Observação: recomendamos usar este parâmetro apenas ao recuperar até 10.000 resultados
  para recuperar mais de 10.000 resultados, use o offset_token
- offset_token
  Tipo: string | null
  
  token para requisições subsequentes
  campo opcional
  fornecido no campo identical da resposta a cada requisição;
  use este parâmetro para evitar timeouts ao tentar obter mais de 100.000 resultados em uma única requisição;
  ao especificar o valor exclusivo de offset_token do array de resposta, você obterá os resultados subsequentes da tarefa inicial;
  os valores de offset_token são exclusivos para cada tarefa subsequente
  Observação: se o offset_token for especificado na requisição, todos os outros parâmetros devem ser idênticos aos da requisição anterior
  saiba mais sobre este parâmetro na nossa Central de Ajuda
- order_by
  Tipo: array string[] | null
  
  regras de ordenação dos resultados
  campo opcional
  você pode usar os mesmos valores do array filters para ordenar os resultados
  tipos de ordenação possíveis:
  asc - os resultados serão ordenados em ordem crescente
  desc - os resultados serão ordenados em ordem decrescente
  use uma vírgula para definir um parâmetro de ordenação
  exemplo:
  ["rating.value,desc"]observe que você pode definir no máximo três regras de ordenação em uma única requisição
  use uma vírgula para separar várias regras de ordenação
  exemplo:
  ["rating.value,desc","rating.votes_count,desc"]
- tag
  Tipo: string | null
  
  identificador de tarefa definido pelo usuário
  campo opcional
  o limite de caracteres é 255
  você pode usar este parâmetro para identificar a tarefa e associá-la ao resultado
  você encontrará o valor de tag especificado no objeto data da resposta
- title
  Tipo: string | null
  
  título do elemento no SERP
  campo opcional
  o nome da entidade comercial para a qual os resultados são coletados;
  pode conter até 200 caracteres

Respostas

200
Tipo: object | null · Response36Afe1097B20_BusinessDataBusinessListingsSearchLiveResponseInfo
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_BusinessDataBusinessListingsSearchLiveTaskInfo
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

count
Tipo: integer | null Formato: int64

tipos de itens
o número de itens no array items

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

tipos de itens encontrados
tipos de resultados de pesquisa encontrados no array items;
tipos de itens possíveis: business_listing

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

categorias de negócio adicionais
categorias adicionais do Google My Business que descrevem com mais detalhes os serviços prestados pela entidade empresarial

address
Tipo: string | null

endereço da entidade comercial

address_info
Tipo: object | null · Response36Afe1097B20_AddressInfo

objeto que contém os componentes de endereço da entidade comercial

address
Tipo: string | null

endereço do estabelecimento local

borough
Tipo: string | null

unidade administrativa ou distrito ao qual o estabelecimento local pertence

city
Tipo: string | null

nome da cidade onde o estabelecimento local está localizado

country_code
Tipo: string | null

código ISO do país do estabelecimento local

region
Tipo: string | null

região DMA à qual o estabelecimento local pertence

zip
Tipo: string | null

código postal do estabelecimento local

attributes
Tipo: object | null · Response36Afe1097B20_BusinessDataAttributesInfo

detalhes do serviço em forma de verificações avaliadas por usuários;
detalhes do serviço de uma entidade comercial exibidos em forma de verificações e baseados no feedback dos usuários e na category do negócio

available_attributes
Tipo: object | null

atributos disponíveis
indica os atributos que uma entidade comercial pode oferecer

propertyName
Tipo: array (string | null)[] | null
unavailable_attributes
Tipo: object | null

atributos indisponíveis
indica os atributos que uma entidade comercial não pode oferecer

propertyName
Tipo: array (string | null)[] | null
category
Tipo: string | null

categoria de negócio
categoria geral do Google My Business que melhor descreve os serviços prestados pela entidade empresarial

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

IDs globais de categoria
IDs universais de categoria que não mudam com base no país selecionado

check_url
Tipo: string | null

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

cid
Tipo: string | null

ID de cliente definido pelo Google
ID exclusivo de um estabelecimento local
saiba mais sobre o identificador neste artigo da central de ajuda

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

contatos disponíveis da empresa
lista de contatos para interagir com a empresa

source
Tipo: string | null

fonte de dados

type
Tipo: string | null

tipo de elemento

value
Tipo: string | null

o valor da avaliação

description
Tipo: string | null

descrição do elemento na SERP
a descrição da entidade comercial para a qual os resultados são coletados

domain
Tipo: string | null

domínio da entidade comercial

feature_id
Tipo: string | null

o identificador exclusivo do elemento na SERP
saiba mais sobre o identificador neste artigo da central de ajuda

first_seen
Tipo: string | null

data e hora em que nosso rastreador encontrou o elemento de ficha comercial pela primeira vez
no formato UTC: “yyyy-mm-dd hh-mm-ss +00:00”
exemplo:
2023-03-11 10:04:11 +00:00

hotel_rating
Tipo: integer | null

classificação por estrelas do hotel
as classificações variam entre 1 e 5 estrelas, saiba mais
se não houver informações de classificação do hotel, o valor será null

is_claimed
Tipo: boolean | null

mostra se a entidade foi verificada pelo proprietário no Google Maps

last_updated_time
Tipo: string | null

data e hora da última atualização dos dados
no formato UTC: “yyyy-mm-dd hh-mm-ss +00:00”
exemplo:
2023-01-26 09:03:15 +00:00

latitude
Tipo: number | null

coordenada de latitude dos estabelecimentos locais no google maps
exemplo:
"latitude": 51.584091

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

interações disponíveis com a empresa
lista de opções para interagir com a empresa diretamente nos resultados de pesquisa

type
Tipo: string | null

tipo de elemento

logo
Tipo: string | null

URL do logotipo exibido no perfil do Google My Business

longitude
Tipo: number | null

coordenada de longitude do estabelecimento local no google maps
exemplo:
"longitude": -0.31365919999999997

main_image
Tipo: string | null

URL da imagem principal apresentada no perfil do Google My Business

original_title
Tipo: string | null

título original do elemento
título original não traduzido pelo Google

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

entidades comerciais relacionadas

cid
Tipo: string | null

ID de cliente definido pelo Google
ID exclusivo de um estabelecimento local
saiba mais sobre o identificador neste artigo da central de ajuda

feature_id
Tipo: string | null

o identificador exclusivo do elemento na SERP
saiba mais sobre o identificador neste artigo da central de ajuda

rating
Tipo: object | null · Response36Afe1097B20_RatingInfo

a avaliação do elemento
a taxa de popularidade com base nas avaliações e exibida na SERP

rating_max
Tipo: integer | null

o valor máximo para um rating_type

rating_type
Tipo: string | null

o tipo de avaliação aqui você pode encontrar os seguintes elementos: Max5, Percents, CustomMax

value
Tipo: number | null Formato: double

o valor da avaliação

votes_count
Tipo: integer | null Formato: int64

a quantidade de feedback

title
Tipo: string | null

título do elemento na SERP
o nome da entidade comercial para a qual os resultados são coletados

phone
Tipo: string | null

telefone da entidade comercial

place_id
Tipo: string | null

identificador exclusivo do local
place id do estabelecimento local apresentado no elemento
saiba mais sobre o identificador neste artigo da central de ajuda

place_topics
Tipo: object | null

palavras-chave mencionadas nas avaliações de clientes
contém as palavras-chave mais populares relacionadas a produtos/serviços mencionados nas avaliações de clientes de uma entidade comercial e o número de avaliações que mencionam cada palavra-chave
exemplo:"place_topics": { "egg roll": 48, "birthday": 33 }

propertyName
Tipo: integer | null Formato: int64

Signed 64-bit integers (long type).

popular_times
Tipo: object | null · Response36Afe1097B20_PopularTimes

horários de maior movimento
informações relacionadas aos horários de pico da entidade comercial

popular_times_by_days
Tipo: object | null

horários de pico
informações sobre os horários de maior movimento do estabelecimento local em cada dia da semana

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

horário de funcionamento aos domingos

popular_index
Tipo: integer | null

índice de popularidade índice de popularidade relativo e limitado no tempo, medido de 0 a 100; um valor mais alto corresponde a um horário do dia com mais movimento

time
Tipo: object | null · Response36Afe1097B20_TimeInfo

horas no formato de 24 horas

hour
Tipo: integer | null

horas no formato de 24 horas

minute
Tipo: integer | null

minutos

price_level
Tipo: string | null

nível de preço do estabelecimento
pode assumir os valores: inexpensive, moderate, expensive, very_expensive
se não houver informações de nível de preço, o valor será null

rating
Tipo: object | null · Response36Afe1097B20_RatingInfo

a avaliação do elemento
a taxa de popularidade com base nas avaliações e exibida na SERP

rating_max
Tipo: number | null Formato: double

o valor máximo para um rating_type

rating_type
Tipo: string | null

o tipo de avaliação aqui você pode encontrar os seguintes elementos: Max5, Percents, CustomMax

value
Tipo: number | null Formato: double

o valor da avaliação

votes_count
Tipo: integer | null Formato: int64

a quantidade de feedback

rating_distribution
Tipo: object | null

a distribuição de avaliações da entidade comercial
o objeto exibe o número de avaliações de 1 a 5 estrelas, conforme avaliado pelos usuários

propertyName
Tipo: integer | null Formato: Int64
services
Tipo: array (object | null)[] | null
category
Tipo: string | null

categoria de negócio
categoria geral do Google My Business que melhor descreve os serviços prestados pela entidade empresarial

price
Tipo: object | null · Response36Afe1097B20_PriceInfo
currency
Tipo: string | null

moeda do preço listado código ISO da moeda aplicada ao preço

current
Tipo: number | null Formato: double

preço atual indica o preço atual do produto ou serviço em destaque no resultado

displayed_price
Tipo: string | null

string de preço no resultado string de preço bruta conforme fornecida no resultado

is_price_range
Tipo: boolean | null

o preço é fornecido como um intervalo indica se um preço é fornecido como um intervalo

max_value
Tipo: number | null Formato: double

o preço máximo o preço máximo do produto ou serviço conforme indicado no resultado

regular
Tipo: number | null Formato: double

preço normal indica o preço normal do produto ou serviço sem descontos aplicados

snippet
Tipo: string | null

informações adicionais sobre a entidade comercial

title
Tipo: string | null

título do elemento na SERP
o nome da entidade comercial para a qual os resultados são coletados

snippet
Tipo: string | null

informações adicionais sobre a entidade comercial

title
Tipo: string | null

título do elemento na SERP
o nome da entidade comercial para a qual os resultados são coletados

total_photos
Tipo: integer | null Formato: int64

número total de imagens apresentadas no perfil do Google My Business

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

url absoluta da entidade comercial

work_time
Tipo: object | null · Response36Afe1097B20_BusinessWorkHoursInfo

detalhes do horário de funcionamento
informações relacionadas ao horário de funcionamento da entidade comercial

work_hours
Tipo: object | null · Response36Afe1097B20_WorkHours

horário de funcionamento
informações sobre o horário de trabalho do estabelecimento local

current_status
Tipo: string | null

status atual do estabelecimento
indica se o estabelecimento está aberto ou fechado

timetable
Tipo: object | null

tabela de horários de funcionamento

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

horário de funcionamento aos domingos

close
Tipo: object | null · Response36Afe1097B20_TimeInfo

horário de fechamento

hour
Tipo: integer | null

horas no formato de 24 horas

minute
Tipo: integer | null

minutos

open
Tipo: object | null · Response36Afe1097B20_TimeInfo

horário de abertura

hour
Tipo: integer | null

horas no formato de 24 horas

minute
Tipo: integer | null

minutos

offset
Tipo: integer | null Formato: int64

Signed 64-bit integers (long type).

offset_token
Tipo: string | null
total_count
Tipo: integer | null Formato: int64

número total de resultados em nosso banco de dados relevantes para a sua solicitação

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/business_data/business_listings/search/live

curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/business_listings/search/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "categories": [
      "pizza_restaurant"
    ],
    "description": "pizza",
    "title": "pizza",
    "is_claimed": true,
    "location_coordinate": "53.476225,-2.243572,10",
    "order_by": [
      "rating.value,desc"
    ],
    "filters": [
      [
        "rating.value",
        ">",
        3
      ]
    ],
    "limit": 3
  }
]'

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": [
        {
          "total_count": null,
          "count": null,
          "offset": null,
          "offset_token": null,
          "items": [
            {
              "type": null,
              "title": null,
              "original_title": null,
              "description": null,
              "category": null,
              "category_ids": [
                "[Max Depth Exceeded]"
              ],
              "additional_categories": [
                "[Max Depth Exceeded]"
              ],
              "cid": null,
              "feature_id": null,
              "address": null,
              "address_info": "[Max Depth Exceeded]",
              "place_id": null,
              "phone": null,
              "url": null,
              "domain": null,
              "logo": null,
              "main_image": null,
              "total_photos": null,
              "snippet": null,
              "latitude": null,
              "longitude": null,
              "is_claimed": null,
              "attributes": "[Max Depth Exceeded]",
              "place_topics": null,
              "rating": {
                "0": "[",
                "1": "M",
                "2": "a",
                "3": "x",
                "4": " ",
                "5": "D",
                "6": "e",
                "7": "p",
                "8": "t",
                "9": "h",
                "10": " ",
                "11": "E",
                "12": "x",
                "13": "c",
                "14": "e",
                "15": "e",
                "16": "d",
                "17": "e",
                "18": "d",
                "19": "]",
                "rating_type": "[Max Depth Exceeded]",
                "value": "[Max Depth Exceeded]",
                "votes_count": "[Max Depth Exceeded]",
                "rating_max": "[Max Depth Exceeded]"
              },
              "hotel_rating": null,
              "price_level": null,
              "rating_distribution": null,
              "people_also_search": [
                "[Max Depth Exceeded]"
              ],
              "work_time": "[Max Depth Exceeded]",
              "popular_times": "[Max Depth Exceeded]",
              "local_business_links": [
                "[Max Depth Exceeded]"
              ],
              "contact_info": [
                "[Max Depth Exceeded]"
              ],
              "check_url": null,
              "last_updated_time": null,
              "first_seen": null,
              "services": [
                "[Max Depth Exceeded]"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Operação bem-sucedida

Tarefas de pesquisa de listagens de empresas em tempo real

AutenticaçãoRequired

DataForSEO

Tarefas de pesquisa de listagens de empresas em tempo real

Referência de preços