v0.1.0-beta

OpenAPI 3.1.0

Live Business Listings Search Tasks

Felo API Support

MIT

サーバー

https://openapi.felo.ai

クライアントライブラリ

Shell Curl

DataForSEO

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

DataForSEO 操作

post/v1/beta/dataforseo/business_data/business_listings/search/live

Live Business Listings Search Tasks

Searches DataForSEO's own index of local business listings by categories, description, title and location_coordinate - a latitude, longitude and radius triple. Returns total_count, count, offset, offset_token and items, paged with the token. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This reads an index and answers immediately; everything else here queues a live scrape of the source. Start with this and drill in only where it matters.

リクエストボディ

application/json

型: array object[]
- categories
  型: array string[]
  
  business categories optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify up to 10 categories
- description
  型: string
  
  description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters
- filters
  型: array
  
  array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , `>=`, `=`, , in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters
- is_claimed
  型: boolean
  
  indicates whether the business is verified by its owner on Google Maps optional field
- limit
  型: integer
  
  the maximum number of returned businesses optional field default value: 100 maximum value: 1000
- location_coordinate
  型: string
  
  GPS coordinates of a location optional field location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the value of “radius” is specified in kilometres (km) the minimum value for “radius”: 1 the maximum value for “radius”: 100000 example: 53.476225,-2.243572,200
- offset
  型: integer
  
  offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
- offset_token
  型: string
  
  token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
- order_by
  型: array string[]
  
  results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: ["rating.value,desc"]note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["rating.value,desc","rating.votes_count,desc"]
- tag
  型: string
  
  user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
- title
  型: string
  
  title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters

レスポンス

200
型: object

Successful response
contact_info
型: array string[]

available contacts of the business list of contacts to interact with the business

contact_info.check_url
型: string

direct URL to search engine results you can use it to make sure that we provided accurate results

contact_info.first_seen
型: string

date and time when our crawler found the business listing element for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-03-11 10:04:11 +00:00

contact_info.last_updated_time
型: string

date and time when the data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-26 09:03:15 +00:00

contact_info.source
型: string

data source

contact_info.type
型: string

type of contact element

contact_info.value
型: string

contact displayed in SERP example: "+119797979736"

items
型: array string[]

encountered item types types of search engine results encountered in the items array; possible item types: business_listing

items.1
型: integer

the number of 1-star ratings

items.2
型: integer

the number of 2-star ratings

items.3
型: integer

the number of 3-star ratings

items.4
型: integer

the number of 4-star ratings

items.5
型: integer

the number of 5-star ratings

items.additional_categories
型: array string[]

additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail

items.address
型: string

street address of the business entity

items.address_info
型: object

object containing address components of the business entity

items.attributes
型: object

service details in a form of user-reviewed checks; service details of a business entity displayed in a form of checks and based on user feedback and business category

items.available_attributes
型: object

available attributes indicates attributes a business entity can offer

items.borough
型: string

administrative unit or district the business entity location belongs to

items.category
型: string

business category Google My Business general category that best describes the services provided by the business entity

items.category_ids
型: array string[]

global category IDs universal category IDs that do not change based on the selected country

items.cid
型: string

google-defined client id unique id of a local establishment learn more about the identifier in this help center article

items.city
型: string

name of the city where the business entity is located

items.close
型: object

closing time

items.country_code
型: string

ISO country code of the business entity location

items.current_status
型: string

current status of the establishment possible values: open, close, temporarily_closed, closed_forever

items.description
型: string

description of the element in SERP the description of the business entity for which the results are collected

items.domain
型: string

domain of the business entity

items.feature_id
型: string

the unique identifier of the element in SERP learn more about the identifier in this help center article

items.hotel_rating
型: integer

hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null

items.hour
型: integer

hours in the 24-hour format

items.is_claimed
型: boolean

shows whether the entity is verified by its owner on Google Maps

items.latitude
型: number

latitude coordinate of the local establishments in google maps example: "latitude": 51.584091

items.logo
型: string

URL of the logo featured in Google My Business profile

items.longitude
型: number

longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997

items.main_image
型: string

URL of the main image featured in Google My Business profile

items.minute
型: integer

minutes

items.open
型: object

opening time

items.original_title
型: string

original title of the element original title not translated by Google

items.people_also_search
型: array string[]

related business entities

items.phone
型: string

phone number of the business entity

items.place_id
型: string

unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article

items.place_topics
型: object

keywords mentioned in customer reviews contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword example: "place_topics": {"egg roll": 48,"birthday": 33}

items.price_level
型: string

property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null

items.rating
型: object

the element’s rating the popularity rate based on reviews and displayed in SERP

items.rating_distribution
型: object

the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users

items.rating_max
型: integer

the maximum value for a rating_type

items.rating_type
型: string

the type of rating here you can find the following elements: Max5, Percents, CustomMax

items.region
型: string

DMA region of the business entity location

items.snippet
型: string

additional information on the business entity

items.sunday
型: array string[]

work hours on Sunday can take values of the corresponding days of the week

items.timetable
型: object

work hours timetable

items.title
型: string

title of the element in SERP the name of the business entity for which the results are collected

items.total_photos
型: integer

total count of images featured in Google My Business profile

items.type
型: string

type of element = ‘business_listing’

items.unavailable_attributes
型: object

unavailable attributes indicates attributes a business entity cannot offer

items.url
型: string

absolute url of the business entity

items.value
型: integer

the value of the rating

items.votes_count
型: integer

the amount of feedback

items.work_hours
型: object

open hours information about work hours of the local establishment

items.work_time
型: object

work time details information related to operational hours of the business entity

items.zip
型: string

ZIP code of the business entity

local_business_links
型: array string[]

available interactions with the business list of options to interact with the business directly from search results

local_business_links.title
型: string

title of the element domain of the reservation software

local_business_links.type
型: string

type of element possible values: "reservation""order""delivery_services_element""menu"

local_business_links.url
型: string

URL to the services

popular_times
型: object

popular times information related to busy hours of the business entity

popular_times.hour
型: integer

hours in a 24-hour format

popular_times.minute
型: integer

minutes

popular_times.popular_index
型: integer

popularity index relative time-bound popularity index measured from 0 to 100; higher value corresponds to a busier time of a day

popular_times.popular_times_by_days
型: object

popular hours information about busy hours of the local establishment on each day of the week

popular_times.sunday
型: array string[]

busy hours on Sunday can take values of the corresponding days of the week

popular_times.time
型: object

busy hours

result
型: array string[]

array of results

result.count
型: integer

item types the number of items in the items array

result.offset
型: integer

offset in the results array of returned businesses

result.offset_token
型: string

token for subsequent requests by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task

result.total_count
型: integer

total number of results in our database relevant to your request

tasks
型: array string[]

array of tasks

tasks.cost
型: number

cost of the task, USD

tasks.data
型: object

contains the same parameters that you specified in the POST request

tasks.id
型: string

unique task identifier in our system in the Universally unique identifier (UUID) format

tasks.path
型: array string[]

URL path

tasks.result_count
型: integer

number of elements in the result array

tasks.status_code
型: integer

status code of the task generated by DataForSEO; can be within the following range: 10000-60000

tasks.status_message
型: string

informational message of the task

tasks.time
型: string

execution time, seconds

version
型: string

the current version of the API

version.cost
型: number

total tasks cost, USD

version.status_code
型: integer

general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

version.status_message
型: string

general informational message you can find the full list of general informational messages here

version.tasks_count
型: integer

*the number of tasks in the **tasks*array

version.tasks_error
型: integer

the number of tasks in the tasks array returned with an error

version.time
型: string

execution time, seconds
application/json
400

Bad request
401

Unauthorized
402

The request cannot proceed because a billing requirement is not met.
403

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
502

The service could not complete the request.
503

The API or billing service is temporarily unavailable.
504

The service timed out while processing the request.
default

The operation failed. Keep the response request ID when contacting Felo support.

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 '[
  {
    "title": "Starbucks",
    "location_coordinate": "35.6595,139.7005,5",
    "limit": 1
  }
]'

スキーマを表示

{
  "version": "string",
  "version.status_code": 1,
  "version.status_message": "string",
  "version.time": "string",
  "version.cost": 1,
  "version.tasks_count": 1,
  "version.tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "result": [
    "string"
  ],
  "result.total_count": 1,
  "result.count": 1,
  "result.offset": 1,
  "result.offset_token": "string",
  "items": [
    "string"
  ],
  "items.type": "string",
  "items.title": "string",
  "items.original_title": "string",
  "items.description": "string",
  "items.category": "string",
  "items.category_ids": [
    "string"
  ],
  "items.additional_categories": [
    "string"
  ],
  "items.cid": "string",
  "items.feature_id": "string",
  "items.address": "string",
  "items.address_info": {},
  "items.borough": "string",
  "items.city": "string",
  "items.zip": "string",
  "items.region": "string",
  "items.country_code": "string",
  "items.place_id": "string",
  "items.phone": "string",
  "items.url": "string",
  "items.domain": "string",
  "items.logo": "string",
  "items.main_image": "string",
  "items.total_photos": 1,
  "items.snippet": "string",
  "items.latitude": 1,
  "items.longitude": 1,
  "items.is_claimed": true,
  "items.attributes": {},
  "items.available_attributes": {},
  "items.unavailable_attributes": {},
  "items.place_topics": {},
  "items.rating": {},
  "items.rating_type": "string",
  "items.value": 1,
  "items.votes_count": 1,
  "items.rating_max": 1,
  "items.hotel_rating": 1,
  "items.price_level": "string",
  "items.rating_distribution": {},
  "items.1": 1,
  "items.2": 1,
  "items.3": 1,
  "items.4": 1,
  "items.5": 1,
  "items.people_also_search": [
    "string"
  ],
  "items.work_time": {},
  "items.work_hours": {},
  "items.timetable": {},
  "items.sunday": [
    "string"
  ],
  "items.open": {},
  "items.hour": 1,
  "items.minute": 1,
  "items.close": {},
  "items.current_status": "string",
  "popular_times": {},
  "popular_times.popular_times_by_days": {},
  "popular_times.sunday": [
    "string"
  ],
  "popular_times.time": {},
  "popular_times.hour": 1,
  "popular_times.minute": 1,
  "popular_times.popular_index": 1,
  "local_business_links": [
    "string"
  ],
  "local_business_links.type": "string",
  "local_business_links.title": "string",
  "local_business_links.url": "string",
  "contact_info": [
    "string"
  ],
  "contact_info.type": "string",
  "contact_info.value": "string",
  "contact_info.source": "string",
  "contact_info.check_url": "string",
  "contact_info.last_updated_time": "string",
  "contact_info.first_seen": "string"
}

Successful response

Live Business Listings Search Tasks

認証Required

DataForSEO

Live Business Listings Search Tasks