Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"title": "vpn",
"description": "vpn",
"categories": [
"Utilities"
],
"order_by": [
"item.rating.value,desc"
],
"filters": [
[
"item.rating.value",
">",
4.5
]
],
"limit": 10
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"categories": [
"Utilities"
],
"description": "vpn",
"filters": [
[
"item.rating.value",
">",
4.5
]
],
"limit": 10,
"order_by": [
"item.rating.value,desc"
],
"title": "vpn"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live"
payload = [
{
"categories": ["Utilities"],
"description": "vpn",
"filters": [["item.rating.value", ">", 4.5]],
"limit": 10,
"order_by": ["item.rating.value,desc"],
"title": "vpn"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
categories: ['Utilities'],
description: 'vpn',
filters: [['item.rating.value', '>', 4.5]],
limit: 10,
order_by: ['item.rating.value,desc'],
title: 'vpn'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'categories' => [
'Utilities'
],
'description' => 'vpn',
'filters' => [
[
'item.rating.value',
'>',
4.5
]
],
'limit' => 10,
'order_by' => [
'item.rating.value,desc'
],
'title' => 'vpn'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live"
payload := strings.NewReader("[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"count": 123,
"items": [
{
"app_id": "<string>",
"check_url": "<string>",
"item": {
"advisories": [
"<string>"
],
"app_id": "<string>",
"categories": [
"<string>"
],
"description": "<string>",
"developer": "<string>",
"developer_id": "<string>",
"developer_url": "<string>",
"icon": "<string>",
"images": [
"<string>"
],
"is_free": true,
"languages": [
"<string>"
],
"last_update_date": "<string>",
"main_category": "<string>",
"minimum_os_version": "<string>",
"more_apps_by_developer": [
{
"app_id": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"position": "<string>",
"price": {
"currency": "<string>",
"current": 123,
"displayed_price": "<string>",
"is_price_range": true,
"max_value": 123,
"regular": 123
},
"rank_absolute": 123,
"rank_group": 123,
"rating": {
"rating_max": 123,
"rating_type": "<string>",
"value": 123,
"votes_count": 123
},
"released_date": "<string>",
"reviews_count": 123,
"similar_apps": [
{
"app_id": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"size": "<string>",
"subtitle": "<string>",
"title": "<string>",
"type": "<string>",
"update_notes": "<string>",
"url": "<string>",
"version": "<string>"
},
"language_code": "<string>",
"location_code": 123,
"se_domain": "<string>",
"time_update": "<string>"
}
],
"offset": 123,
"offset_token": "<string>",
"total_count": 123
}
]
}
]
}Apple
Live Apple App Listings Search Results
Live Apple App Listings Search Results
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
app_data
/
apple
/
app_listings
/
search
/
live
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"title": "vpn",
"description": "vpn",
"categories": [
"Utilities"
],
"order_by": [
"item.rating.value,desc"
],
"filters": [
[
"item.rating.value",
">",
4.5
]
],
"limit": 10
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"categories": [
"Utilities"
],
"description": "vpn",
"filters": [
[
"item.rating.value",
">",
4.5
]
],
"limit": 10,
"order_by": [
"item.rating.value,desc"
],
"title": "vpn"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live"
payload = [
{
"categories": ["Utilities"],
"description": "vpn",
"filters": [["item.rating.value", ">", 4.5]],
"limit": 10,
"order_by": ["item.rating.value,desc"],
"title": "vpn"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
categories: ['Utilities'],
description: 'vpn',
filters: [['item.rating.value', '>', 4.5]],
limit: 10,
order_by: ['item.rating.value,desc'],
title: 'vpn'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'categories' => [
'Utilities'
],
'description' => 'vpn',
'filters' => [
[
'item.rating.value',
'>',
4.5
]
],
'limit' => 10,
'order_by' => [
'item.rating.value,desc'
],
'title' => 'vpn'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live"
payload := strings.NewReader("[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"categories\": [\n \"Utilities\"\n ],\n \"description\": \"vpn\",\n \"filters\": [\n [\n \"item.rating.value\",\n \">\",\n 4.5\n ]\n ],\n \"limit\": 10,\n \"order_by\": [\n \"item.rating.value,desc\"\n ],\n \"title\": \"vpn\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"count": 123,
"items": [
{
"app_id": "<string>",
"check_url": "<string>",
"item": {
"advisories": [
"<string>"
],
"app_id": "<string>",
"categories": [
"<string>"
],
"description": "<string>",
"developer": "<string>",
"developer_id": "<string>",
"developer_url": "<string>",
"icon": "<string>",
"images": [
"<string>"
],
"is_free": true,
"languages": [
"<string>"
],
"last_update_date": "<string>",
"main_category": "<string>",
"minimum_os_version": "<string>",
"more_apps_by_developer": [
{
"app_id": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"position": "<string>",
"price": {
"currency": "<string>",
"current": 123,
"displayed_price": "<string>",
"is_price_range": true,
"max_value": 123,
"regular": 123
},
"rank_absolute": 123,
"rank_group": 123,
"rating": {
"rating_max": 123,
"rating_type": "<string>",
"value": 123,
"votes_count": 123
},
"released_date": "<string>",
"reviews_count": 123,
"similar_apps": [
{
"app_id": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"size": "<string>",
"subtitle": "<string>",
"title": "<string>",
"type": "<string>",
"update_notes": "<string>",
"url": "<string>",
"version": "<string>"
},
"language_code": "<string>",
"location_code": 123,
"se_domain": "<string>",
"time_update": "<string>"
}
],
"offset": 123,
"offset_token": "<string>",
"total_count": 123
}
]
}
]
}Searches DataForSEO’s own index of App Store listings, synchronously - the Apple twin of
Set this endpoint up in your agent →
post_dataforseo_app_google_app_listings_search_live, same arguments and same shape. Measured at 8.1 KB for one result. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The price does not fall with limit - ask for many results in one call rather than few in several. Category names come from get_dataforseo_app_apple_app_listings_categories.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"categories": "...", "description": "...", "title": "..."}]'
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "post_dataforseo_app_apple_app_listings_search_live",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-apple-app-listings-search-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: POST /apis/v1/dataforseo/app_data/apple/app_listings/search/live
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_app_apple_app_listings_search_live",
"method": "POST",
"path": "/apis/v1/dataforseo/app_data/apple/app_listings/search/live",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"categories": [
"Utilities"
],
"description": "vpn",
"filters": [
[
"item.rating.value",
">",
4.5
]
],
"limit": 10,
"order_by": [
"item.rating.value,desc"
],
"title": "vpn"
}
],
"items": {
"oneOf": [
{
"properties": {
"categories": {
"description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><p><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"schemas": {
"ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.012
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters
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
JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator.
the maximum number of returned apps
optional field
default value: 100
maximum value: 1000
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.
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
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 orderdesc - 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"]
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
keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters
Example:
[
{
"categories": ["Utilities"],
"description": "vpn",
"filters": [["item.rating.value", ">", 4.5]],
"limit": 10,
"order_by": ["item.rating.value,desc"],
"title": "vpn"
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes