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

# API

> API reference for DataForSeo: every `dataforseo.api.*` operation with input and output types.

Every `dataforseo.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).

## Account

### userData

`account.userData`

Get the account login, balance, and subscription expiry dates (free)

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.account.userData({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     login: string,
>     timezone?: string | null,
>     money?: {
>       total?: number | null,
>       balance?: number | null
>     } | null,
>     backlinks_subscription_expiry_date?: string | null,
>     llm_mentions_subscription_expiry_date?: string | null
>   }[] | null
> }[]
> ```

***

## Ai

### chatgptResponse

`ai.chatgptResponse`

Get a ChatGPT model response to a prompt, with web sources when web search is on

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.ai.chatgptResponse({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_prompt` | `string` | Yes | — |
| `model_name` | `string` | Yes | Model name, e.g. gpt-4.1; see the provider models endpoint |
| `max_output_tokens` | `number` | No | — |
| `top_p` | `number` | No | — |
| `system_message` | `string` | No | — |
| `message_chain` | `object[]` | No | — |
| `tag` | `string` | No | — |
| `temperature` | `number` | No | — |
| `web_search` | `boolean` | No | — |
| `force_web_search` | `boolean` | No | — |
| `web_search_country_iso_code` | `string` | No | — |
| `web_search_city` | `string` | No | — |

> **message\_chain full type**
>
> ```ts theme={null}
> {
>   role: user | ai,
>   message: string
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     model_name?: string | null,
>     input_tokens?: number | null,
>     output_tokens?: number | null,
>     reasoning_tokens?: number | null,
>     web_search?: boolean | null,
>     money_spent?: number | null,
>     datetime?: string | null,
>     items?: {
>       type: message | reasoning,
>       sections?: {
>         type?: string | null,
>         text?: string | null,
>         annotations?: {
>           title?: string | null,
>           url?: string | null,
>           direct_url?: string | null,
>           start_index?: number | null,
>           end_index?: number | null,
>           text?: string | null
>         }[] | null
>       }[] | null
>     }[] | null,
>     fan_out_queries?: string[] | {
>     } | null
>   }[] | null
> }[]
> ```

***

### geminiResponse

`ai.geminiResponse`

Get a Gemini model response to a prompt

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.ai.geminiResponse({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_prompt` | `string` | Yes | — |
| `model_name` | `string` | Yes | Model name, e.g. gpt-4.1; see the provider models endpoint |
| `max_output_tokens` | `number` | No | — |
| `top_p` | `number` | No | — |
| `system_message` | `string` | No | — |
| `message_chain` | `object[]` | No | — |
| `tag` | `string` | No | — |
| `temperature` | `number` | No | — |
| `web_search` | `boolean` | No | — |
| `use_reasoning` | `boolean` | No | — |

> **message\_chain full type**
>
> ```ts theme={null}
> {
>   role: user | ai,
>   message: string
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     model_name?: string | null,
>     input_tokens?: number | null,
>     output_tokens?: number | null,
>     reasoning_tokens?: number | null,
>     web_search?: boolean | null,
>     money_spent?: number | null,
>     datetime?: string | null,
>     items?: {
>       type: message | reasoning,
>       sections?: {
>         type?: string | null,
>         text?: string | null,
>         annotations?: {
>           title?: string | null,
>           url?: string | null,
>           direct_url?: string | null,
>           start_index?: number | null,
>           end_index?: number | null,
>           text?: string | null
>         }[] | null
>       }[] | null
>     }[] | null,
>     fan_out_queries?: string[] | {
>     } | null
>   }[] | null
> }[]
> ```

***

### mentionsSearch

`ai.mentionsSearch`

Search AI answers (ChatGPT, Google AI) that mention a domain or keyword

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.ai.mentionsSearch({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `object[]` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `platform` | `chat_gpt \| google` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `limit` | `number` | No | — |
| `tag` | `string` | No | — |
| `offset` | `number` | No | — |
| `search_after_token` | `string` | No | — |

> **target full type**
>
> ```ts theme={null}
> (
>   {
>     domain: string,
>     include_subdomains?: boolean
>   } | {
>     keyword: string,
>     match_type?: word_match | partial_match
>   }
> )[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     total_count?: number | null,
>     offset?: number | null,
>     search_after_token?: string | null,
>     items_count?: number | null,
>     items?: {
>       platform?: string | null,
>       model_name?: string | null,
>       location_code?: number | null,
>       language_code?: string | null,
>       question?: string | null,
>       answer?: string | null,
>       sources?: {
>         rank?: number | null,
>         title?: string | null,
>         domain?: string | null,
>         url?: string | null,
>         publication_date?: string | null,
>         snippet?: string | null,
>         source_name?: string | null,
>         thumbnail?: string | null,
>         markdown?: string | null
>       }[] | null,
>       search_results?: {
>         rank?: number | null,
>         title?: string | null,
>         domain?: string | null,
>         url?: string | null,
>         publication_date?: string | null,
>         description?: string | null,
>         breadcrumb?: string | null
>       }[] | null,
>       ai_search_volume?: number | null,
>       monthly_searches?: {
>         year: number,
>         month: number,
>         search_volume?: number | null
>       }[] | null,
>       first_response_at?: string | null,
>       last_response_at?: string | null,
>       brand_entities?: {
>         rank?: number | null,
>         title?: string | null,
>         category?: string | null
>       }[] | null,
>       fan_out_queries?: string[] | null,
>       is_web_search_based?: boolean | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### mentionsTopDomains

`ai.mentionsTopDomains`

Rank the domains cited most in AI answers about a domain or keyword

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.ai.mentionsTopDomains({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `object[]` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `platform` | `chat_gpt \| google` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `limit` | `number` | No | — |
| `tag` | `string` | No | — |
| `offset` | `number` | No | — |
| `links_scope` | `sources \| search_results` | No | — |
| `initial_dataset_filters` | `lazy` | No | — |
| `internal_list_limit` | `number` | No | — |
| `include_domains` | `string[]` | No | — |
| `exclude_domains` | `string[]` | No | — |

> **target full type**
>
> ```ts theme={null}
> (
>   {
>     domain: string,
>     include_subdomains?: boolean
>   } | {
>     keyword: string,
>     match_type?: word_match | partial_match
>   }
> )[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     total_count?: number | null,
>     offset?: number | null,
>     items_count?: number | null,
>     aggregated_metrics?: {
>       location?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       language?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       platform?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       sources_domain?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       search_results_domain?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       brand_entities_title?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       brand_entities_category?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       total?: {
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       } | null
>     } | null,
>     items?: {
>       domain?: string | null,
>       location?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       language?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       platform?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       sources_domain?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       search_results_domain?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       brand_entities_title?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       brand_entities_category?: {
>         key?: string | null,
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       }[] | null,
>       total?: {
>         mentions?: number | null,
>         ai_search_volume?: number | null
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### perplexityResponse

`ai.perplexityResponse`

Get a Perplexity model response to a prompt, with cited sources

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.ai.perplexityResponse({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_prompt` | `string` | Yes | — |
| `model_name` | `string` | Yes | Model name, e.g. gpt-4.1; see the provider models endpoint |
| `max_output_tokens` | `number` | No | — |
| `top_p` | `number` | No | — |
| `system_message` | `string` | No | — |
| `message_chain` | `object[]` | No | — |
| `tag` | `string` | No | — |
| `temperature` | `number` | No | — |
| `web_search_country_iso_code` | `string` | No | — |

> **message\_chain full type**
>
> ```ts theme={null}
> {
>   role: user | ai,
>   message: string
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     model_name?: string | null,
>     input_tokens?: number | null,
>     output_tokens?: number | null,
>     reasoning_tokens?: number | null,
>     web_search?: boolean | null,
>     money_spent?: number | null,
>     datetime?: string | null,
>     items?: {
>       type: message | reasoning,
>       sections?: {
>         type?: string | null,
>         text?: string | null,
>         annotations?: {
>           title?: string | null,
>           url?: string | null,
>           direct_url?: string | null,
>           start_index?: number | null,
>           end_index?: number | null,
>           text?: string | null
>         }[] | null
>       }[] | null
>     }[] | null,
>     fan_out_queries?: string[] | {
>     } | null
>   }[] | null
> }[]
> ```

***

## Amazon

### asin

`amazon.asin`

Get an Amazon product page by ASIN: price, rating, details, and top reviews

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.amazon.asin({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `asin` | `string` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `location_coordinate` | `string` | No | — |
| `se_domain` | `string` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     asin?: string | null,
>     type?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     item_types?: string[] | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       rank_group?: number | null,
>       rank_absolute?: number | null,
>       position?: string | null,
>       xpath?: string | null,
>       title?: string | null,
>       details?: string | null,
>       image_url?: string | null,
>       author?: string | null,
>       data_asin?: string | null,
>       parent_asin?: string | null,
>       product_asins?: string[] | null,
>       price_from?: number | null,
>       price_to?: number | null,
>       percentage_discount?: string | null,
>       currency?: string | null,
>       is_amazon_choice?: boolean | null,
>       rating?: {
>         type?: string | null,
>         position?: string | null,
>         rating_type?: string | null,
>         value?: number | null,
>         votes_count?: number | null,
>         rating_max?: number | null
>       } | null,
>       is_newer_model_available?: boolean | null,
>       is_prime_video?: boolean | null,
>       newer_model?: {
>         title?: string | null,
>         newer_model_asin?: string | null
>       } | null,
>       categories?: {
>         category?: string | null,
>         url?: string | null
>       }[] | null,
>       product_information?: (
>         {
>           type: product_information_details_item,
>           section_name?: string | null,
>           body?: {
>           } | null
>         } | {
>           type: product_information_text_item,
>           section_name?: string | null,
>           text?: string | null
>         } | {
>           type: product_information_extended_item,
>           section_name?: string | null,
>           contents?: {
>             type?: string | null,
>             title?: string | null,
>             rows?: {
>               type?: string | null,
>               text?: string | null,
>               alt?: string | null,
>               url?: string | null
>             }[] | null
>           }[] | null
>         }
>       )[] | null,
>       product_images_list?: string[] | null,
>       product_videos_list?: string[] | null,
>       description?: string | null,
>       is_available?: boolean | null,
>       top_local_reviews?: {
>         type?: string | null,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         verified?: boolean | null,
>         subtitle?: string | null,
>         helpful_votes?: string | null,
>         images?: {
>           type?: string | null,
>           alt?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null,
>         videos?: {
>           type?: string | null,
>           source?: string | null,
>           preview?: string | null,
>           title?: string | null,
>           timestamp?: string | null,
>           url?: string | null
>         }[] | null,
>         user_profile?: {
>           name?: string | null,
>           avatar?: string | null,
>           url?: string | null,
>           reviews_count?: number | null,
>           locations?: string | null
>         } | null,
>         title?: string | null,
>         url?: string | null,
>         review_text?: string | null,
>         publication_date?: string | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null
>       }[] | null,
>       top_global_reviews?: {
>         type?: string | null,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         verified?: boolean | null,
>         subtitle?: string | null,
>         helpful_votes?: string | null,
>         images?: {
>           type?: string | null,
>           alt?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null,
>         videos?: {
>           type?: string | null,
>           source?: string | null,
>           preview?: string | null,
>           title?: string | null,
>           timestamp?: string | null,
>           url?: string | null
>         }[] | null,
>         user_profile?: {
>           name?: string | null,
>           avatar?: string | null,
>           url?: string | null,
>           reviews_count?: number | null,
>           locations?: string | null
>         } | null,
>         title?: string | null,
>         url?: string | null,
>         review_text?: string | null,
>         publication_date?: string | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null
>       }[] | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### products

`amazon.products`

Get live Amazon search results for a keyword

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.amazon.products({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keyword` | `string` | Yes | — |
| `url` | `string` | No | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `location_coordinate` | `string` | No | — |
| `se_domain` | `string` | No | — |
| `tag` | `string` | No | — |
| `depth` | `number` | No | — |
| `max_crawl_pages` | `number` | No | — |
| `department` | `string` | No | — |
| `search_param` | `string` | No | — |
| `price_min` | `number` | No | — |
| `price_max` | `number` | No | — |
| `sort_by` | `relevance \| price_low_to_high \| price_high_to_low \| featured \| avg_customer_review \| newest_arrival` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     keyword?: string | null,
>     type?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     spell?: {
>       keyword?: string | null,
>       type?: string | null
>     } | null,
>     item_types?: string[] | null,
>     se_results_count?: number | null,
>     categories?: {
>     } | null,
>     items_count?: number | null,
>     items?: (
>       {
>         type: amazon_serp,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         url?: string | null,
>         image_url?: string | null,
>         bought_past_month?: number | null,
>         price_from?: number | null,
>         price_to?: number | null,
>         currency?: string | null,
>         special_offers?: string[] | null,
>         data_asin?: string | null,
>         rating?: {
>           type?: string | null,
>           position?: string | null,
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         is_amazon_choice?: boolean | null,
>         is_best_seller?: boolean | null,
>         delivery_info?: {
>           delivery_message?: string | null,
>           delivery_date_from?: string | null,
>           delivery_date_to?: string | null,
>           fastest_delivery_date_from?: string | null,
>           fastest_delivery_date_to?: string | null,
>           delivery_price?: {
>             current?: number | null,
>             regular?: number | null,
>             max_value?: number | null,
>             currency?: string | null,
>             is_price_range?: boolean | null,
>             displayed_price?: string | null
>           } | null
>         } | null,
>         labels?: {
>           type?: string | null,
>           title?: string | null,
>           url?: string | null,
>           domain?: string | null
>         }[] | null
>       } | {
>         type: amazon_paid,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         url?: string | null,
>         image_url?: string | null,
>         bought_past_month?: number | null,
>         price_from?: number | null,
>         price_to?: number | null,
>         currency?: string | null,
>         special_offers?: string[] | null,
>         data_asin?: string | null,
>         rating?: {
>           type?: string | null,
>           position?: string | null,
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         is_amazon_choice?: boolean | null,
>         is_best_seller?: boolean | null,
>         delivery_info?: {
>           delivery_message?: string | null,
>           delivery_date_from?: string | null,
>           delivery_date_to?: string | null,
>           fastest_delivery_date_from?: string | null,
>           fastest_delivery_date_to?: string | null,
>           delivery_price?: {
>             current?: number | null,
>             regular?: number | null,
>             max_value?: number | null,
>             currency?: string | null,
>             is_price_range?: boolean | null,
>             displayed_price?: string | null
>           } | null
>         } | null,
>         labels?: {
>           type?: string | null,
>           title?: string | null,
>           url?: string | null,
>           domain?: string | null
>         }[] | null
>       } | {
>         type: editorial_recommendations,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           xpath?: string | null,
>           domain?: string | null,
>           title?: string | null,
>           url?: string | null,
>           image_url?: string | null,
>           bought_past_month?: number | null,
>           price_from?: number | null,
>           price_to?: number | null,
>           currency?: string | null,
>           special_offers?: string[] | null,
>           data_asin?: string | null,
>           rating?: {
>             type?: string | null,
>             position?: string | null,
>             rating_type?: string | null,
>             value?: number | null,
>             votes_count?: number | null,
>             rating_max?: number | null
>           } | null,
>           is_amazon_choice?: boolean | null,
>           is_best_seller?: boolean | null,
>           delivery_info?: {
>             delivery_message?: string | null,
>             delivery_date_from?: string | null,
>             delivery_date_to?: string | null,
>             fastest_delivery_date_from?: string | null,
>             fastest_delivery_date_to?: string | null,
>             delivery_price?: {
>               current?: number | null,
>               regular?: number | null,
>               max_value?: number | null,
>               currency?: string | null,
>               is_price_range?: boolean | null,
>               displayed_price?: string | null
>             } | null
>           } | null,
>           labels?: {
>             type?: string | null,
>             title?: string | null,
>             url?: string | null,
>             domain?: string | null
>           }[] | null
>         }[] | null
>       } | {
>         type: top_rated_from_our_brands,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           xpath?: string | null,
>           domain?: string | null,
>           title?: string | null,
>           url?: string | null,
>           image_url?: string | null,
>           bought_past_month?: number | null,
>           price_from?: number | null,
>           price_to?: number | null,
>           currency?: string | null,
>           special_offers?: string[] | null,
>           data_asin?: string | null,
>           rating?: {
>             type?: string | null,
>             position?: string | null,
>             rating_type?: string | null,
>             value?: number | null,
>             votes_count?: number | null,
>             rating_max?: number | null
>           } | null,
>           is_amazon_choice?: boolean | null,
>           is_best_seller?: boolean | null,
>           delivery_info?: {
>             delivery_message?: string | null,
>             delivery_date_from?: string | null,
>             delivery_date_to?: string | null,
>             fastest_delivery_date_from?: string | null,
>             fastest_delivery_date_to?: string | null,
>             delivery_price?: {
>               current?: number | null,
>               regular?: number | null,
>               max_value?: number | null,
>               currency?: string | null,
>               is_price_range?: boolean | null,
>               displayed_price?: string | null
>             } | null
>           } | null,
>           labels?: {
>             type?: string | null,
>             title?: string | null,
>             url?: string | null,
>             domain?: string | null
>           }[] | null
>         }[] | null
>       } | {
>         type: related_searches,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           title?: string | null,
>           url?: string | null,
>           image_alt?: string | null,
>           image_url?: string | null
>         }[] | null
>       }
>     )[] | null
>   }[] | null
> }[]
> ```

***

## App Store

### infoResult

`appStore.infoResult`

Get the results of an App Store app info task by task id

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.appStore.infoResult({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     app_id?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     se_results_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       rank_group?: number | null,
>       rank_absolute?: number | null,
>       position?: string | null,
>       app_id?: string | null,
>       title?: string | null,
>       url?: string | null,
>       icon?: string | null,
>       reviews_count?: number | null,
>       rating?: {
>         rating_type?: string | null,
>         value?: number | null,
>         votes_count?: number | null,
>         rating_max?: number | null
>       } | null,
>       price?: {
>         current?: number | null,
>         regular?: number | null,
>         max_value?: number | null,
>         currency?: string | null,
>         is_price_range?: boolean | null,
>         displayed_price?: string | null
>       } | null,
>       is_free?: boolean | null,
>       subtitle?: string | null,
>       description?: string | null,
>       main_category?: string | null,
>       categories?: string[] | null,
>       languages?: string[] | null,
>       advisories?: string[] | null,
>       developer?: string | null,
>       developer_id?: string | null,
>       developer_url?: string | null,
>       version?: string | null,
>       minimum_os_version?: string | null,
>       size?: string | null,
>       released_date?: string | null,
>       last_update_date?: string | null,
>       update_notes?: string | null,
>       images?: string[] | null,
>       similar_apps?: {
>         app_id?: string | null,
>         title?: string | null,
>         url?: string | null
>       }[] | null,
>       more_apps_by_developer?: {
>         app_id?: string | null,
>         title?: string | null,
>         url?: string | null
>       }[] | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### infoTask

`appStore.infoTask`

Post an App Store app info task; fetch it with appStore.infoResult

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.appStore.infoTask({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `app_id` | `string` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `priority` | `1 \| 2` | No | — |
| `postback_url` | `string` | No | — |
| `postback_data` | `advanced` | No | — |
| `pingback_url` | `string` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>   }[] | null
> }[]
> ```

***

### reviewsResult

`appStore.reviewsResult`

Get the results of an App Store reviews task by task id

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.appStore.reviewsResult({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     app_id?: string | null,
>     type?: string | null,
>     title?: string | null,
>     rating?: {
>       rating_type?: string | null,
>       value?: number | null,
>       votes_count?: number | null,
>       rating_max?: number | null
>     } | null,
>     reviews_count?: number | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     se_results_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       rank_group?: number | null,
>       rank_absolute?: number | null,
>       position?: string | null,
>       id?: string | null,
>       version?: string | null,
>       rating?: {
>         rating_type?: string | null,
>         value?: number | null,
>         votes_count?: number | null,
>         rating_max?: number | null
>       } | null,
>       timestamp?: string | null,
>       title?: string | null,
>       review_text?: string | null,
>       user_profile?: {
>         profile_name?: string | null,
>         profile_image_url?: string | null
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### reviewsTask

`appStore.reviewsTask`

Post an App Store reviews task; fetch it with appStore.reviewsResult

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.appStore.reviewsTask({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `app_id` | `string` | Yes | — |
| `depth` | `number` | No | — |
| `sort_by` | `most_recent \| most_helpful` | No | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `priority` | `1 \| 2` | No | — |
| `postback_url` | `string` | No | — |
| `postback_data` | `advanced` | No | — |
| `pingback_url` | `string` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>   }[] | null
> }[]
> ```

***

### searchResult

`appStore.searchResult`

Get the results of an App Store search task by task id

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.appStore.searchResult({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     keyword?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     se_results_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       rank_group?: number | null,
>       rank_absolute?: number | null,
>       position?: string | null,
>       app_id?: string | null,
>       title?: string | null,
>       url?: string | null,
>       icon?: string | null,
>       reviews_count?: number | null,
>       rating?: {
>         rating_type?: string | null,
>         value?: number | null,
>         votes_count?: number | null,
>         rating_max?: number | null
>       } | null,
>       price?: {
>         current?: number | null,
>         regular?: number | null,
>         max_value?: number | null,
>         currency?: string | null,
>         is_price_range?: boolean | null,
>         displayed_price?: string | null
>       } | null,
>       is_free?: boolean | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### searchTask

`appStore.searchTask`

Post an App Store search task; fetch it with appStore.searchResult

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.appStore.searchTask({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keyword` | `string` | Yes | — |
| `depth` | `number` | No | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `priority` | `1 \| 2` | No | — |
| `postback_url` | `string` | No | — |
| `postback_data` | `advanced` | No | — |
| `pingback_url` | `string` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>   }[] | null
> }[]
> ```

***

## Backlinks

### anchors

`backlinks.anchors`

List anchor texts used in links to a target

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.anchors({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `string` | Yes | Domain or subdomain without https\:// and [www](http://www)., or an absolute page URL |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |
| `include_subdomains` | `boolean` | No | — |
| `exclude_internal_backlinks` | `boolean` | No | — |
| `backlinks_status_type` | `all \| live \| lost` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `include_indirect_links` | `boolean` | No | — |
| `internal_list_limit` | `number` | No | — |
| `backlinks_filters` | `lazy` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     target?: string | null,
>     total_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       anchor?: string | null,
>       rank?: number | null,
>       backlinks?: number | null,
>       first_seen?: string | null,
>       lost_date?: string | null,
>       backlinks_spam_score?: number | null,
>       broken_backlinks?: number | null,
>       broken_pages?: number | null,
>       referring_domains?: number | null,
>       referring_domains_nofollow?: number | null,
>       referring_main_domains?: number | null,
>       referring_main_domains_nofollow?: number | null,
>       referring_ips?: number | null,
>       referring_subnets?: number | null,
>       referring_pages?: number | null,
>       referring_pages_nofollow?: number | null,
>       referring_links_tld?: {
>       } | null,
>       referring_links_types?: {
>       } | null,
>       referring_links_attributes?: {
>       } | null,
>       referring_links_platform_types?: {
>       } | null,
>       referring_links_semantic_locations?: {
>       } | null,
>       referring_links_countries?: {
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### bulkRanks

`backlinks.bulkRanks`

Get the rank of up to 1000 domains, subdomains, or pages

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.bulkRanks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `targets` | `string[]` | Yes | — |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     items_count?: number | null,
>     items?: {
>       target?: string | null,
>       rank?: number | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### competitors

`backlinks.competitors`

Find domains that share backlinks with a target

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.competitors({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `string` | Yes | Domain or subdomain without https\:// and [www](http://www)., or an absolute page URL |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `main_domain` | `boolean` | No | — |
| `exclude_large_domains` | `boolean` | No | — |
| `exclude_internal_backlinks` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     total_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       target?: string | null,
>       rank?: number | null,
>       intersections?: number | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### list

`backlinks.list`

List backlinks pointing to a target

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `string` | Yes | Domain or subdomain without https\:// and [www](http://www)., or an absolute page URL |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |
| `include_subdomains` | `boolean` | No | — |
| `exclude_internal_backlinks` | `boolean` | No | — |
| `backlinks_status_type` | `all \| live \| lost` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `search_after_token` | `string` | No | — |
| `mode` | `as_is \| one_per_domain \| one_per_anchor` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     target?: string | null,
>     mode?: string | null,
>     search_after_token?: string | null,
>     total_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       domain_from?: string | null,
>       url_from?: string | null,
>       url_from_https?: boolean | null,
>       domain_to?: string | null,
>       url_to?: string | null,
>       url_to_https?: boolean | null,
>       tld_from?: string | null,
>       is_new?: boolean | null,
>       is_lost?: boolean | null,
>       backlink_spam_score?: number | null,
>       rank?: number | null,
>       page_from_rank?: number | null,
>       domain_from_rank?: number | null,
>       domain_from_platform_type?: string[] | null,
>       domain_from_is_ip?: boolean | null,
>       domain_from_ip?: string | null,
>       domain_from_country?: string | null,
>       page_from_external_links?: number | null,
>       page_from_internal_links?: number | null,
>       page_from_size?: number | null,
>       page_from_encoding?: string | null,
>       page_from_language?: string | null,
>       page_from_title?: string | null,
>       page_from_status_code?: number | null,
>       first_seen?: string | null,
>       prev_seen?: string | null,
>       last_seen?: string | null,
>       item_type?: string | null,
>       attributes?: string[] | null,
>       dofollow?: boolean | null,
>       original?: boolean | null,
>       alt?: string | null,
>       image_url?: string | null,
>       anchor?: string | null,
>       text_pre?: string | null,
>       text_post?: string | null,
>       semantic_location?: string | null,
>       links_count?: number | null,
>       group_count?: number | null,
>       is_broken?: boolean | null,
>       url_to_status_code?: number | null,
>       url_to_spam_score?: number | null,
>       url_to_redirect_target?: string | null,
>       is_indirect_link?: boolean | null,
>       indirect_link_path?: {
>         type?: string | null,
>         status_code?: number | null,
>         url?: string | null
>       }[] | null,
>       ranked_keywords_info?: {
>         page_from_keywords_count_top_3?: number | null,
>         page_from_keywords_count_top_10?: number | null,
>         page_from_keywords_count_top_100?: number | null
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### referringDomains

`backlinks.referringDomains`

List domains linking to a target with per-domain link metrics

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.referringDomains({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `string` | Yes | Domain or subdomain without https\:// and [www](http://www)., or an absolute page URL |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |
| `include_subdomains` | `boolean` | No | — |
| `exclude_internal_backlinks` | `boolean` | No | — |
| `backlinks_status_type` | `all \| live \| lost` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `include_indirect_links` | `boolean` | No | — |
| `internal_list_limit` | `number` | No | — |
| `backlinks_filters` | `lazy` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     target?: string | null,
>     total_count?: number | null,
>     items_count?: number | null,
>     items?: {
>       type?: string | null,
>       domain?: string | null,
>       rank?: number | null,
>       backlinks?: number | null,
>       first_seen?: string | null,
>       lost_date?: string | null,
>       backlinks_spam_score?: number | null,
>       broken_backlinks?: number | null,
>       broken_pages?: number | null,
>       referring_domains?: number | null,
>       referring_domains_nofollow?: number | null,
>       referring_main_domains?: number | null,
>       referring_main_domains_nofollow?: number | null,
>       referring_ips?: number | null,
>       referring_subnets?: number | null,
>       referring_pages?: number | null,
>       referring_pages_nofollow?: number | null,
>       referring_links_tld?: {
>       } | null,
>       referring_links_types?: {
>       } | null,
>       referring_links_attributes?: {
>       } | null,
>       referring_links_platform_types?: {
>       } | null,
>       referring_links_semantic_locations?: {
>       } | null,
>       referring_links_countries?: {
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### summary

`backlinks.summary`

Get a backlink profile summary for a domain, subdomain, or page

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.backlinks.summary({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `target` | `string` | Yes | Domain or subdomain without https\:// and [www](http://www)., or an absolute page URL |
| `rank_scale` | `one_hundred \| one_thousand` | No | — |
| `tag` | `string` | No | — |
| `include_subdomains` | `boolean` | No | — |
| `exclude_internal_backlinks` | `boolean` | No | — |
| `backlinks_status_type` | `all \| live \| lost` | No | — |
| `include_indirect_links` | `boolean` | No | — |
| `internal_list_limit` | `number` | No | — |
| `backlinks_filters` | `lazy` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     target?: string | null,
>     crawled_pages?: number | null,
>     internal_links_count?: number | null,
>     external_links_count?: number | null,
>     info?: {
>       server?: string | null,
>       cms?: string | null,
>       platform_type?: string[] | null,
>       ip_address?: string | null,
>       country?: string | null,
>       is_ip?: boolean | null,
>       target_spam_score?: number | null
>     } | null,
>     rank?: number | null,
>     backlinks?: number | null,
>     first_seen?: string | null,
>     lost_date?: string | null,
>     backlinks_spam_score?: number | null,
>     broken_backlinks?: number | null,
>     broken_pages?: number | null,
>     referring_domains?: number | null,
>     referring_domains_nofollow?: number | null,
>     referring_main_domains?: number | null,
>     referring_main_domains_nofollow?: number | null,
>     referring_ips?: number | null,
>     referring_subnets?: number | null,
>     referring_pages?: number | null,
>     referring_pages_nofollow?: number | null,
>     referring_links_tld?: {
>     } | null,
>     referring_links_types?: {
>     } | null,
>     referring_links_attributes?: {
>     } | null,
>     referring_links_platform_types?: {
>     } | null,
>     referring_links_semantic_locations?: {
>     } | null,
>     referring_links_countries?: {
>     } | null
>   }[] | null
> }[]
> ```

***

## Keywords

### ideas

`keywords.ideas`

Get keyword ideas related to up to 200 seed keywords

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.keywords.ideas({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keywords` | `string[]` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `closely_variants` | `boolean` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `offset_token` | `string` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `include_serp_info` | `boolean` | No | — |
| `include_clickstream_data` | `boolean` | No | — |
| `ignore_synonyms` | `boolean` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     seed_keywords?: string[] | null,
>     se_type?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     total_count?: number | null,
>     items_count?: number | null,
>     offset?: number | null,
>     offset_token?: string | null,
>     items?: {
>       se_type?: string | null,
>       keyword: string,
>       location_code?: number | null,
>       language_code?: string | null,
>       keyword_info?: {
>         se_type?: string | null,
>         last_updated_time?: string | null,
>         competition?: number | null,
>         competition_level?: string | null,
>         cpc?: number | null,
>         search_volume?: number | null,
>         low_top_of_page_bid?: number | null,
>         high_top_of_page_bid?: number | null,
>         categories?: number[] | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null,
>         search_volume_trend?: {
>           monthly?: number | null,
>           quarterly?: number | null,
>           yearly?: number | null
>         } | null
>       } | null,
>       keyword_info_normalized_with_bing?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_info_normalized_with_clickstream?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       clickstream_keyword_info?: {
>         search_volume?: number | null,
>         last_updated_time?: string | null,
>         gender_distribution?: {
>         } | null,
>         age_distribution?: {
>         } | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_properties?: {
>         se_type?: string | null,
>         core_keyword?: string | null,
>         synonym_clustering_algorithm?: string | null,
>         keyword_difficulty?: number | null,
>         detected_language?: string | null,
>         is_another_language?: boolean | null,
>         words_count?: number | null
>       } | null,
>       serp_info?: {
>         se_type?: string | null,
>         check_url?: string | null,
>         serp_item_types?: string[] | null,
>         se_results_count?: number | null,
>         last_updated_time?: string | null,
>         previous_updated_time?: string | null
>       } | null,
>       avg_backlinks_info?: {
>         se_type?: string | null,
>         backlinks?: number | null,
>         dofollow?: number | null,
>         referring_pages?: number | null,
>         referring_domains?: number | null,
>         referring_main_domains?: number | null,
>         rank?: number | null,
>         main_domain_rank?: number | null,
>         last_updated_time?: string | null
>       } | null,
>       search_intent_info?: {
>         se_type?: string | null,
>         main_intent?: string | null,
>         foreign_intent?: string[] | null,
>         last_updated_time?: string | null
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### locations

`keywords.locations`

List DataForSEO Labs locations and languages (free)

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.keywords.locations({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     location_code: number,
>     location_name: string,
>     location_code_parent?: number | null,
>     country_iso_code?: string | null,
>     location_type?: string | null,
>     available_languages?: {
>       available_sources?: string[] | null,
>       language_name?: string | null,
>       language_code?: string | null,
>       keywords?: number | null,
>       serps?: number | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### searchVolume

`keywords.searchVolume`

Get Google Ads search volume, CPC, and competition for up to 1000 keywords

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.keywords.searchVolume({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keywords` | `string[]` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `location_coordinate` | `string` | No | — |
| `search_partners` | `boolean` | No | — |
| `date_from` | `string` | No | — |
| `date_to` | `string` | No | — |
| `include_adult_keywords` | `boolean` | No | — |
| `sort_by` | `relevance \| search_volume \| competition_index \| low_top_of_page_bid \| high_top_of_page_bid` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     keyword: string,
>     spell?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     search_partners?: boolean | null,
>     competition?: string | null,
>     competition_index?: number | null,
>     search_volume?: number | null,
>     low_top_of_page_bid?: number | null,
>     high_top_of_page_bid?: number | null,
>     cpc?: number | null,
>     monthly_searches?: {
>       year: number,
>       month: number,
>       search_volume?: number | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

### suggestions

`keywords.suggestions`

Get keyword suggestions that contain a seed keyword, with search volume and difficulty

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.keywords.suggestions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keyword` | `string` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `include_seed_keyword` | `boolean` | No | — |
| `exact_match` | `boolean` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `offset_token` | `string` | No | — |
| `filters` | `lazy` | No | — |
| `order_by` | `string[]` | No | — |
| `include_serp_info` | `boolean` | No | — |
| `include_clickstream_data` | `boolean` | No | — |
| `ignore_synonyms` | `boolean` | No | — |
| `tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     seed_keyword?: string | null,
>     seed_keyword_data?: {
>       se_type?: string | null,
>       keyword: string,
>       location_code?: number | null,
>       language_code?: string | null,
>       keyword_info?: {
>         se_type?: string | null,
>         last_updated_time?: string | null,
>         competition?: number | null,
>         competition_level?: string | null,
>         cpc?: number | null,
>         search_volume?: number | null,
>         low_top_of_page_bid?: number | null,
>         high_top_of_page_bid?: number | null,
>         categories?: number[] | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null,
>         search_volume_trend?: {
>           monthly?: number | null,
>           quarterly?: number | null,
>           yearly?: number | null
>         } | null
>       } | null,
>       keyword_info_normalized_with_bing?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_info_normalized_with_clickstream?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       clickstream_keyword_info?: {
>         search_volume?: number | null,
>         last_updated_time?: string | null,
>         gender_distribution?: {
>         } | null,
>         age_distribution?: {
>         } | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_properties?: {
>         se_type?: string | null,
>         core_keyword?: string | null,
>         synonym_clustering_algorithm?: string | null,
>         keyword_difficulty?: number | null,
>         detected_language?: string | null,
>         is_another_language?: boolean | null,
>         words_count?: number | null
>       } | null,
>       serp_info?: {
>         se_type?: string | null,
>         check_url?: string | null,
>         serp_item_types?: string[] | null,
>         se_results_count?: number | null,
>         last_updated_time?: string | null,
>         previous_updated_time?: string | null
>       } | null,
>       avg_backlinks_info?: {
>         se_type?: string | null,
>         backlinks?: number | null,
>         dofollow?: number | null,
>         referring_pages?: number | null,
>         referring_domains?: number | null,
>         referring_main_domains?: number | null,
>         rank?: number | null,
>         main_domain_rank?: number | null,
>         last_updated_time?: string | null
>       } | null,
>       search_intent_info?: {
>         se_type?: string | null,
>         main_intent?: string | null,
>         foreign_intent?: string[] | null,
>         last_updated_time?: string | null
>       } | null
>     } | null,
>     se_type?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     total_count?: number | null,
>     items_count?: number | null,
>     offset?: number | null,
>     offset_token?: string | null,
>     items?: {
>       se_type?: string | null,
>       keyword: string,
>       location_code?: number | null,
>       language_code?: string | null,
>       keyword_info?: {
>         se_type?: string | null,
>         last_updated_time?: string | null,
>         competition?: number | null,
>         competition_level?: string | null,
>         cpc?: number | null,
>         search_volume?: number | null,
>         low_top_of_page_bid?: number | null,
>         high_top_of_page_bid?: number | null,
>         categories?: number[] | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null,
>         search_volume_trend?: {
>           monthly?: number | null,
>           quarterly?: number | null,
>           yearly?: number | null
>         } | null
>       } | null,
>       keyword_info_normalized_with_bing?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_info_normalized_with_clickstream?: {
>         last_updated_time?: string | null,
>         search_volume?: number | null,
>         is_normalized?: boolean | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       clickstream_keyword_info?: {
>         search_volume?: number | null,
>         last_updated_time?: string | null,
>         gender_distribution?: {
>         } | null,
>         age_distribution?: {
>         } | null,
>         monthly_searches?: {
>           year: number,
>           month: number,
>           search_volume?: number | null
>         }[] | null
>       } | null,
>       keyword_properties?: {
>         se_type?: string | null,
>         core_keyword?: string | null,
>         synonym_clustering_algorithm?: string | null,
>         keyword_difficulty?: number | null,
>         detected_language?: string | null,
>         is_another_language?: boolean | null,
>         words_count?: number | null
>       } | null,
>       serp_info?: {
>         se_type?: string | null,
>         check_url?: string | null,
>         serp_item_types?: string[] | null,
>         se_results_count?: number | null,
>         last_updated_time?: string | null,
>         previous_updated_time?: string | null
>       } | null,
>       avg_backlinks_info?: {
>         se_type?: string | null,
>         backlinks?: number | null,
>         dofollow?: number | null,
>         referring_pages?: number | null,
>         referring_domains?: number | null,
>         referring_main_domains?: number | null,
>         rank?: number | null,
>         main_domain_rank?: number | null,
>         last_updated_time?: string | null
>       } | null,
>       search_intent_info?: {
>         se_type?: string | null,
>         main_intent?: string | null,
>         foreign_intent?: string[] | null,
>         last_updated_time?: string | null
>       } | null
>     }[] | null
>   }[] | null
> }[]
> ```

***

## Serp

### googleNews

`serp.googleNews`

Get live Google News results for a keyword

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.serp.googleNews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keyword` | `string` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `location_coordinate` | `string` | No | — |
| `depth` | `number` | No | — |
| `max_crawl_pages` | `number` | No | — |
| `search_param` | `string` | No | — |
| `se_domain` | `string` | No | — |
| `url` | `string` | No | — |
| `tag` | `string` | No | — |
| `os` | `windows \| macos` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     keyword?: string | null,
>     type?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     spell?: {
>       keyword?: string | null,
>       type?: string | null
>     } | null,
>     item_types?: string[] | null,
>     se_results_count?: number | null,
>     items_count?: number | null,
>     includes_non_news_search_results?: boolean | null,
>     items?: (
>       {
>         type: news_search,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         url?: string | null,
>         image_url?: string | null,
>         snippet?: string | null,
>         time_published?: string | null,
>         timestamp?: string | null
>       } | {
>         type: top_stories,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           source?: string | null,
>           domain?: string | null,
>           title?: string | null,
>           date?: string | null,
>           timestamp?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null
>       }
>     )[] | null
>   }[] | null
> }[]
> ```

***

### googleOrganic

`serp.googleOrganic`

Get the live Google organic SERP for a keyword: organic, paid, AI Overview, People Also Ask, and other result types

**Risk:** `write`

```ts theme={null}
await corsair.dataforseo.api.serp.googleOrganic({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `keyword` | `string` | Yes | — |
| `location_name` | `string` | No | — |
| `location_code` | `number` | No | — |
| `language_name` | `string` | No | — |
| `language_code` | `string` | No | — |
| `location_coordinate` | `string` | No | — |
| `depth` | `number` | No | — |
| `max_crawl_pages` | `number` | No | — |
| `search_param` | `string` | No | — |
| `se_domain` | `string` | No | — |
| `url` | `string` | No | — |
| `tag` | `string` | No | — |
| `device` | `desktop \| mobile` | No | — |
| `os` | `windows \| macos \| android \| ios` | No | — |
| `load_async_ai_overview` | `boolean` | No | — |
| `people_also_ask_click_depth` | `number` | No | — |
| `group_organic_results` | `boolean` | No | — |
| `remove_from_url` | `string[]` | No | — |
| `target` | `string` | No | — |
| `target_search_mode` | `all \| any` | No | — |
| `find_targets_in` | `organic \| paid \| local_pack \| featured_snippet \| events \| google_flights \| images \| jobs \| knowledge_graph \| local_service \| map \| scholarly_articles \| third_party_reviews \| twitter[]` | No | — |
| `ignore_targets_in` | `organic \| paid \| local_pack \| featured_snippet \| events \| google_flights \| images \| jobs \| knowledge_graph \| local_service \| map \| scholarly_articles \| third_party_reviews \| twitter[]` | No | — |
| `stop_crawl_on_match` | `object[]` | No | — |

> **stop\_crawl\_on\_match full type**
>
> ```ts theme={null}
> {
>   match_value: string,
>   match_type: domain | with_subdomains | wildcard
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     keyword?: string | null,
>     type?: string | null,
>     se_domain?: string | null,
>     location_code?: number | null,
>     language_code?: string | null,
>     check_url?: string | null,
>     datetime?: string | null,
>     spell?: {
>       keyword?: string | null,
>       type?: string | null
>     } | null,
>     item_types?: string[] | null,
>     se_results_count?: number | null,
>     items_count?: number | null,
>     pages_count?: number | null,
>     refinement_chips?: {
>       type?: string | null,
>       xpath?: string | null,
>       items?: {
>         type?: string | null,
>         title?: string | null,
>         url?: string | null,
>         domain?: string | null
>       }[] | null
>     } | null,
>     items?: (
>       {
>         type: organic,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         description?: string | null,
>         url?: string | null,
>         breadcrumb?: string | null,
>         website_name?: string | null,
>         is_image?: boolean | null,
>         is_video?: boolean | null,
>         images?: {
>           type?: string | null,
>           alt?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null,
>         highlighted?: string[] | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         price?: {
>           current?: number | null,
>           regular?: number | null,
>           max_value?: number | null,
>           currency?: string | null,
>           is_price_range?: boolean | null,
>           displayed_price?: string | null
>         } | null,
>         timestamp?: string | null,
>         cache_url?: string | null,
>         related_search_url?: string | null,
>         is_featured_snippet?: boolean | null,
>         is_malicious?: boolean | null,
>         is_web_story?: boolean | null,
>         pre_snippet?: string | null,
>         extended_snippet?: string | null,
>         amp_version?: boolean | null,
>         links?: {
>           type?: string | null,
>           title?: string | null,
>           snippet?: string | null,
>           description?: string | null,
>           url?: string | null,
>           domain?: string | null
>         }[] | null,
>         faq?: {
>           type?: string | null,
>           items?: {
>             type?: string | null,
>             title?: string | null,
>             description?: string | null,
>             links?: {
>               type?: string | null,
>               title?: string | null,
>               snippet?: string | null,
>               description?: string | null,
>               url?: string | null,
>               domain?: string | null
>             }[] | null
>           }[] | null
>         } | null
>       } | {
>         type: paid,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         description?: string | null,
>         url?: string | null,
>         breadcrumb?: string | null,
>         website_name?: string | null,
>         is_image?: boolean | null,
>         is_video?: boolean | null,
>         images?: {
>           type?: string | null,
>           alt?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null,
>         highlighted?: string[] | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         price?: {
>           current?: number | null,
>           regular?: number | null,
>           max_value?: number | null,
>           currency?: string | null,
>           is_price_range?: boolean | null,
>           displayed_price?: string | null
>         } | null,
>         timestamp?: string | null,
>         description_rows?: string[] | null,
>         links?: {
>           type?: string | null,
>           title?: string | null,
>           description?: string | null,
>           url?: string | null,
>           domain?: string | null
>         }[] | null
>       } | {
>         type: featured_snippet,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         domain?: string | null,
>         title?: string | null,
>         description?: string | null,
>         url?: string | null,
>         breadcrumb?: string | null,
>         website_name?: string | null,
>         is_image?: boolean | null,
>         is_video?: boolean | null,
>         images?: {
>           type?: string | null,
>           alt?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null,
>         highlighted?: string[] | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         price?: {
>           current?: number | null,
>           regular?: number | null,
>           max_value?: number | null,
>           currency?: string | null,
>           is_price_range?: boolean | null,
>           displayed_price?: string | null
>         } | null,
>         timestamp?: string | null,
>         featured_title?: string | null,
>         table?: {
>           table_element?: string | null,
>           table_header?: string[] | null,
>           table_content?: string[][] | null
>         } | null
>       } | {
>         type: people_also_ask,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           title?: string | null,
>           seed_question?: string | null,
>           xpath?: string | null,
>           expanded_element?: {
>             type?: string | null,
>             featured_title?: string | null,
>             url?: string | null,
>             domain?: string | null,
>             title?: string | null,
>             description?: string | null,
>             images?: {
>               type?: string | null,
>               alt?: string | null,
>               url?: string | null,
>               image_url?: string | null
>             }[] | null,
>             timestamp?: string | null,
>             asynchronous_ai_overview?: boolean | null,
>             references?: {
>               type?: string | null,
>               source?: string | null,
>               domain?: string | null,
>               url?: string | null,
>               title?: string | null,
>               text?: string | null
>             }[] | null
>           }[] | null
>         }[] | null
>       } | {
>         type: related_searches,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: string[] | null
>       } | {
>         type: top_stories,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         title?: string | null,
>         items?: {
>           type?: string | null,
>           source?: string | null,
>           domain?: string | null,
>           title?: string | null,
>           date?: string | null,
>           timestamp?: string | null,
>           url?: string | null,
>           image_url?: string | null
>         }[] | null
>       } | {
>         type: local_pack,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         title?: string | null,
>         description?: string | null,
>         domain?: string | null,
>         phone?: string | null,
>         booking_url?: string | null,
>         url?: string | null,
>         is_paid?: boolean | null,
>         rating?: {
>           rating_type?: string | null,
>           value?: number | null,
>           votes_count?: number | null,
>           rating_max?: number | null
>         } | null,
>         cid?: string | null
>       } | {
>         type: ai_overview,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         asynchronous_ai_overview?: boolean | null,
>         markdown?: string | null,
>         references?: {
>           type?: string | null,
>           source?: string | null,
>           domain?: string | null,
>           url?: string | null,
>           title?: string | null,
>           text?: string | null
>         }[] | null
>       } | {
>         type: video,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null,
>         items?: {
>           type?: string | null,
>           source?: string | null,
>           preview?: string | null,
>           title?: string | null,
>           timestamp?: string | null,
>           url?: string | null
>         }[] | null
>       } | {
>         type: string,
>         rank_group?: number | null,
>         rank_absolute?: number | null,
>         page?: number | null,
>         position?: string | null,
>         xpath?: string | null
>       }
>     )[] | null
>   }[] | null
> }[]
> ```

***

### languages

`serp.languages`

List Google SERP language codes (free)

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.serp.languages({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     language_name: string,
>     language_code: string
>   }[] | null
> }[]
> ```

***

### locations

`serp.locations`

List Google SERP location codes, optionally for one country (free)

**Risk:** `read`

```ts theme={null}
await corsair.dataforseo.api.serp.locations({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `country` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `version` | `string` | No | — |
| `status_code` | `number` | Yes | — |
| `status_message` | `string` | No | — |
| `time` | `string` | No | — |
| `cost` | `number` | No | — |
| `tasks_count` | `number` | No | — |
| `tasks_error` | `number` | No | — |
| `tasks` | `object[]` | No | — |

> **tasks full type**
>
> ```ts theme={null}
> {
>   id: string,
>   status_code: number,
>   status_message?: string | null,
>   time?: string | null,
>   cost?: number | null,
>   result_count?: number | null,
>   path?: string[] | null,
>   data?: {
>   } | null,
>   result?: {
>     location_code: number,
>     location_name: string,
>     location_code_parent?: number | null,
>     country_iso_code?: string | null,
>     location_type?: string | null
>   }[] | null
> }[]
> ```

***


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