Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Live Business Listings Search Tasks

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

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

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.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.2428.
  • Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

Body
application/json
  • Type: array (object | null)[]
    • categories
      Type: array string[] | null

      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
      Type: string | null

      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
      Type: array (object | null)[] | null

      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
      The full list of possible filters is available here.n

      Empty object
    • is_claimed
      Type: boolean | null

      indicates whether the business is verified by its owner on Google Maps
      optional field

    • limit
      Type: integer | null

      the maximum number of returned businesses
      optional field
      default value: 100
      maximum value: 1000

    • location_coordinate
      Type: string | null

      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
      learn more about how to set location parameters in this API on our Help Center

    • offset
      Type: integer | null

      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
      Note: we recommend using this parameter only when retrieving up to 10,000 results
      for retrieving over 10,000 results, use the offset_token instead

    • offset_token
      Type: string | null

      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
      learn more about this parameter on our Help Center

    • order_by
      Type: array string[] | null

      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
      Type: string | null

      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
      Type: string | null

      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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_BusinessDataBusinessListingsSearchLiveResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_BusinessDataBusinessListingsSearchLiveTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

          task identifier unique task identifier in our system in the UUID format

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: array (object | null)[] | null

          array of results

          • count
            Type: integer | null Format: int64

            item types
            the number of items in the items array

          • items
            Type: array (object | null)[] | null

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

            • additional_categories
              Type: array (string | null)[] | null

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

            • address
              Type: string | null

              address of the business entity

            • address_info
              Type: object | null · Response36Afe1097B20_AddressInfo

              object containing address components of the business entity

              • address
                Type: string | null

                street address of the local establishment

              • borough
                Type: string | null

                administrative unit or district the local establishment belongs to

              • city
                Type: string | null

                name of the city where the local establishment is located

              • country_code
                Type: string | null

                ISO country code of the local establishment

              • region
                Type: string | null

                DMA region the local establishment belongs to

              • zip
                Type: string | null

                ZIP code of the local establishment

            • attributes
              Type: object | null · Response36Afe1097B20_BusinessDataAttributesInfo

              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

              • available_attributes
                Type: object | null

                available attributes
                indicates attributes a business entity can offer

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

                unavailable attributes
                indicates attributes a business entity cannot offer

                • propertyName
                  Type: array (string | null)[] | null
            • category
              Type: string | null

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

            • category_ids
              Type: array (string | null)[] | null

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

            • check_url
              Type: string | null

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

            • cid
              Type: string | null

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

            • contact_info
              Type: array (object | null)[] | null

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

              • source
                Type: string | null

                data source

              • type
                Type: string | null

                type of element

              • value
                Type: string | null

                the value of the rating

            • description
              Type: string | null

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

            • domain
              Type: string | null

              domain of the business entity

            • feature_id
              Type: string | null

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

            • first_seen
              Type: string | null

              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

            • hotel_rating
              Type: integer | null

              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

            • is_claimed
              Type: boolean | null

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

            • last_updated_time
              Type: string | null

              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

            • latitude
              Type: number | null

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

            • local_business_links
              Type: array (object | null)[] | null

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

              • type
                Type: string | null

                type of element

            • logo
              Type: string | null

              URL of the logo featured in Google My Business profile

            • longitude
              Type: number | null

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

            • main_image
              Type: string | null

              URL of the main image featured in Google My Business profile

            • original_title
              Type: string | null

              original title of the element
              original title not translated by Google

            • people_also_search
              Type: array (object | null)[] | null

              related business entities

              • cid
                Type: string | null

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

              • feature_id
                Type: string | null

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

              • rating
                Type: object | null · Response36Afe1097B20_RatingInfo

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

                • rating_max
                  Type: integer | null

                  the maximum value for a rating_type

                • rating_type
                  Type: string | null

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

                • value
                  Type: number | null Format: double

                  the value of the rating

                • votes_count
                  Type: integer | null Format: int64

                  the amount of feedback

              • title
                Type: string | null

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

            • phone
              Type: string | null

              phone number of the business entity

            • place_id
              Type: string | null

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

            • place_topics
              Type: object | null

              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
              }

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • popular_times
              Type: object | null · Response36Afe1097B20_PopularTimes

              popular times
              information related to busy hours of the business entity

              • popular_times_by_days
                Type: object | null

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

                • propertyName
                  Type: array (object | null)[] | null

                  work hours on Sundays

                  • popular_index
                    Type: integer | null

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

                  • time
                    Type: object | null · Response36Afe1097B20_TimeInfo

                    hours in the 24-hour format

                    • hour
                      Type: integer | null

                      hours in the 24-hour format

                    • minute
                      Type: integer | null

                      minutes

            • price_level
              Type: string | null

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

            • rating
              Type: object | null · Response36Afe1097B20_RatingInfo

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

              • rating_max
                Type: number | null Format: double

                the maximum value for a rating_type

              • rating_type
                Type: string | null

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

              • value
                Type: number | null Format: double

                the value of the rating

              • votes_count
                Type: integer | null Format: int64

                the amount of feedback

            • rating_distribution
              Type: object | null

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

              • propertyName
                Type: integer | null Format: Int64
            • services
              Type: array (object | null)[] | null
              • category
                Type: string | null

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

              • price
                Type: object | null · Response36Afe1097B20_PriceInfo
                • currency
                  Type: string | null

                  currency of the listed price ISO code of the currency applied to the price

                • current
                  Type: number | null Format: double

                  current price indicates the current price of the product or service featured in the result

                • displayed_price
                  Type: string | null

                  price string in the result raw price string as provided in the result

                • is_price_range
                  Type: boolean | null

                  price is provided as a range indicates whether a price is provided in a range

                • max_value
                  Type: number | null Format: double

                  the maximum price the maximum price of the product or service as indicated in the result

                • regular
                  Type: number | null Format: double

                  regular price indicates the regular price of the product or service with no discounts applied

              • snippet
                Type: string | null

                additional information on the business entity

              • title
                Type: string | null

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

            • snippet
              Type: string | null

              additional information on the business entity

            • title
              Type: string | null

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

            • total_photos
              Type: integer | null Format: int64

              total count of images featured in Google My Business profile

            • type
              Type: string | null

              type of element

            • url
              Type: string | null

              absolute url of the business entity

            • work_time
              Type: object | null · Response36Afe1097B20_BusinessWorkHoursInfo

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

              • work_hours
                Type: object | null · Response36Afe1097B20_WorkHours

                open hours
                information about work hours of the local establishment

                • current_status
                  Type: string | null

                  current status of the establishment
                  indicates whether the establishment is opened or closed

                • timetable
                  Type: object | null

                  work hours timetable

                  • propertyName
                    Type: array (object | null)[] | null

                    work hours on Sundays

                    • close
                      Type: object | null · Response36Afe1097B20_TimeInfo

                      closing time

                      • hour
                        Type: integer | null

                        hours in the 24-hour format

                      • minute
                        Type: integer | null

                        minutes

                    • open
                      Type: object | null · Response36Afe1097B20_TimeInfo

                      opening time

                      • hour
                        Type: integer | null

                        hours in the 24-hour format

                      • minute
                        Type: integer | null

                        minutes

          • offset
            Type: integer | null Format: int64

            Signed 64-bit integers (long type).

          • offset_token
            Type: string | null
          • total_count
            Type: integer | null Format: int64

            total number of results in our database relevant to your request

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here

        • status_message
          Type: string | null

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

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

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 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

    Error response; upstream passthrough responses may use provider formats

    application/json
Request Example for 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
  }
]'
{
  "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]"
              ]
            }
          ]
        }
      ]
    }
  ]
}
Live Business Listings Search Tasks

Need help?