> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DataForSEO: Dataforseo Labs Apple App Competitors Live

> Find App Store apps that compete with a target app on its ranking keywords, with search volume and ranking data. Includes SDK V2 examples, schemas, and cost.

Find App Store apps that compete with a target app on its ranking keywords, with search volume and ranking data.

> [!NOTE]
>
> Tool ID: `dataforseo_dataforseo_labs_apple_app_competitors_live`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_dataforseo_labs_apple_app_competitors_live',
  {
    "app_id": "app_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dataforseo_dataforseo_labs_apple_app_competitors_live --input '{
  "app_id": "app_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}
```

Use `deepline describe dataforseo_dataforseo_labs_apple_app_competitors_live --json` for the latest machine-readable contract.

## Input reference

This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.app_id` | `string` | Yes | — | id of the app required field ID of the mobile application on App Store. You can find the ID in the URL of every app listed on App Store. example: in the URL [https://apps.apple.com/us/app/id835599320](https://apps.apple.com/us/app/id835599320) the id is 835599320 |
| `payload.location_name` | `string` | No | — | full name of the location required field if you don't specify location\_code Note: it is required to specify either location\_name or location\_code you can receive the list of available locations with their location\_name by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the US location only. example: United States |
| `payload.location_code` | `integer` | No | — | location code required field if you don't specify location\_name Note: it is required to specify either location\_name or location\_code you can receive the list of available locations with their location\_code by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the US location only. example: 2840 |
| `payload.language_name` | `string` | No | — | full name of the language required field if you don't specify language\_code Note: it is required to specify either language\_name or language\_code you can receive the list of available languages with their language\_name by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the English language only. example: English |
| `payload.language_code` | `string` | No | — | language code required field if you don't specify language\_name Note: it is required to specify either language\_name or language\_code you can receive the list of available languages with their language\_code by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the English language only example: en |
| `payload.filters` | `array` | No | — | 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: \< , \<= , > , >= , = , \<> , in , not\_in example: \["intersections",">",500] \[\["competitor\_metrics.app\_store\_search\_organic.pos\_1","\<>",10],"and",\["avg\_position",">=","10"]] \[\[\["intersections",">=",50],"and",\["competitor\_metrics.app\_store\_search\_organic.pos\_1","in",\[1,5]]], "or", See the live schema for the complete constraint. |
| `payload.order_by` | `array` | No | — | 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 specify a sorting type. example: \["intersections,asc"] Note: you can set no more than three sorting rules in a single request. You should use a comma to separate several sorting rules. example: See the live schema for the complete constraint. |
| `payload.limit` | `integer` | No | — | the maximum number of returned apps optional field default value: 100 maximum value: 1000 |
| `payload.offset` | `integer` | No | — | offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords |
| `payload.tag` | `string` | No | — | 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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.",
    "properties": {
      "app_id": {
        "type": "string",
        "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320"
      },
      "location_name": {
        "type": "string",
        "description": "full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US location only; example: United States"
      },
      "location_code": {
        "type": "integer",
        "description": "location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US location only; example: 2840"
      },
      "language_name": {
        "type": "string",
        "description": "full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the English language only; example: English"
      },
      "language_code": {
        "type": "string",
        "description": "language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the English language only example: en"
      },
      "filters": {
        "type": "array",
        "description": "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: < , <= , > , >= , = , <> , in , not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
        "items": {}
      },
      "order_by": {
        "type": "array",
        "description": "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic , the results will be ordered by the first item type in the array",
        "items": {}
      },
      "limit": {
        "type": "integer",
        "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000"
      },
      "offset": {
        "type": "integer",
        "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords"
      },
      "tag": {
        "type": "string",
        "description": "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"
      }
    },
    "required": [
      "app_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Top-level response envelope for dataforseo\_dataforseo\_labs\_apple\_app\_competitors\_live.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.version` | `string` | Yes | — | the current version of the API |
| `result.status_code` | `integer` | Yes | — | 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 |
| `result.status_message` | `string` | Yes | — | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | — | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | — | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | — | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | — | array of tasks |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Top-level response envelope for dataforseo_dataforseo_labs_apple_app_competitors_live.",
    "properties": {
      "version": {
        "type": "string",
        "description": "the current version of the API"
      },
      "status_code": {
        "type": "integer",
        "description": "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"
      },
      "status_message": {
        "type": "string",
        "description": "general informational message you can find the full list of general informational messages here"
      },
      "time": {
        "type": "string",
        "description": "execution time, seconds"
      },
      "tasks_count": {
        "type": "integer",
        "description": "the number of tasks in the tasks array"
      },
      "tasks_error": {
        "type": "integer",
        "description": "the number of tasks in the tasks array returned with an error"
      },
      "tasks": {
        "type": "array",
        "description": "array of tasks",
        "items": {}
      }
    },
    "required": [
      "version",
      "status_code",
      "status_message",
      "time",
      "tasks_count",
      "tasks_error",
      "tasks"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.01` per pricing unit.

## Related documentation

* [DataForSEO provider guide](https://deepline.com/docs/providers/dataforseo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.