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

Live Apple App Listings Search Results

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

DataForSEO

​

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

Live Apple App Listings Search Results

​

Searches DataForSEO's own index of App Store listings, synchronously - the Apple twin of post_dataforseo_app_google_app_listings_search_live, same arguments and same shape. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Category names come from get_dataforseo_app_apple_app_listings_categories.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.012.
  • 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

      app categories
      optional field
      the categories you specify are used to search for app listings;
      you can get the full list of available app listing categories by this link
      you can specify up to 10 categories

    • description
      Type: string | null

      keyword in the app's description
      optional field
      keywords that occur in the description of the app;
      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
      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/app_data/apple/app_listings/available_filtersn

      Empty object
    • limit
      Type: integer | null

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

    • offset
      Type: integer | null

      offset in the results array of returned apps
      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:
      ["item.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:
      ["item.rating.value,desc","item.rating.value,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

      keyword in the app's title
      optional field
      keywords that occur in the title of the app;
      can contain up to 200 characters

Responses
  • 200
    Type: object | null · Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResponseInfo
    • 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_AppDataAppleAppListingsSearchLiveTaskInfo
        • 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

            the number of items in the results array

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

            array of apps and related data

            • app_id
              Type: string | null

              ID of the returned app

            • check_url
              Type: string | null

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

            • item
              Type: object | null · Response36Afe1097B20_AppStoreInfoOrganic

              detailed information about the app

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

                age rating and age-based content advisories

              • app_id
                Type: string | null

                ID of the app

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

                all relevant categories/genres of the app
                Note: this field returns only one relevant category in the array

              • description
                Type: string | null

                description of the app

              • developer
                Type: string | null

                name of the app developer

              • developer_id
                Type: string | null

                ID of the app developer

              • developer_url
                Type: string | null

                URL to the developer page on App Store

              • icon
                Type: string | null

                URL to the app icon

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

                app images
                contains URLs to the images used on the app page on App Store

              • is_free
                Type: boolean | null

                indicates whether the app is free

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

                languages supported in the app
                Note: this field returns only one supported language in the array

              • last_update_date
                Type: string | null

                date and time when the app was last updated
                in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
                example:
                2019-11-15 12:57:46 +00:00

              • main_category
                Type: string | null

                main category/genre of the app

              • minimum_os_version
                Type: string | null

                minimum OS version required to install the app

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

                similar apps
                information about apps built by the same developer

                • app_id
                  Type: string | null

                  ID of the app

                • title
                  Type: string | null

                  title of the app

                • url
                  Type: string | null

                  URL to the app page on Google Play

              • position
                Type: string | null

                the alignment of the element in SERP
                can take the following values: left

              • price
                Type: object | null · Response36Afe1097B20_PriceInfo

                price of the app

                • 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

              • rank_absolute
                Type: integer | null

                absolute rank among all the listed apps
                absolute position among all apps on the list

              • rank_group
                Type: integer | null

                position within a group of elements with identical type values
                positions of elements with different type values are omitted from rank_group

              • rating
                Type: object | null · Response36Afe1097B20_RatingInfo

                average rating of the app

                • 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

              • released_date
                Type: string | null

                date and time when the app was released
                in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
                example:
                2019-11-15 12:57:46 +00:00
                Note: this field is deprecated and always returns null

              • reviews_count
                Type: integer | null Format: int64

                the total number of reviews of the app

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

                similar apps
                displays apps similar to the app in a POST request

                • app_id
                  Type: string | null

                  ID of the app

                • title
                  Type: string | null

                  title of the app

                • url
                  Type: string | null

                  URL to the app page on Google Play

              • size
                Type: string | null

                size of the app

              • subtitle
                Type: string | null

                subtitle of the app

              • title
                Type: string | null

                title of the app

              • type
                Type: string | null

                type of element

              • update_notes
                Type: string | null

                update notes
                contains the latest update notes from the developer

              • url
                Type: string | null

                URL to the app page on App Store

              • version
                Type: string | null

                current version of the app

            • language_code
              Type: string | null

              language code in a POST array

            • location_code
              Type: integer | null

              location code in a POST array

            • se_domain
              Type: string | null

              search engine domain in a POST array

            • time_update
              Type: string | null

              date and time when SERP data was last updated
              in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
              example:
              2023-05-23 10:16:19 +00:00

          • offset
            Type: integer | null

            offset in the results array of returned apps

          • offset_token
            Type: string | null

            token for subsequent requests
            you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request

          • total_count
            Type: integer | null Format: int64

            the total number of relevant results in the database

        • 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/app_data/apple/app_listings/search/live
curl https://openapi.felo.ai/v1/beta/dataforseo/app_data/apple/app_listings/search/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "title": "vpn",
    "description": "vpn",
    "categories": [
      "Utilities"
    ],
    "order_by": [
      "item.rating.value,desc"
    ],
    "filters": [
      [
        "item.rating.value",
        ">",
        4.5
      ]
    ],
    "limit": 10
  }
]'
{
  "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": [
            {
              "app_id": null,
              "se_domain": null,
              "location_code": null,
              "language_code": null,
              "check_url": null,
              "time_update": null,
              "item": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}
Live Apple App Listings Search Results

Need help?