> ## 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 LiteScrape: every `litescrape.api.*` operation with input and output types.

Every `litescrape.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).

## Apple App Store

### product

`appleAppStore.product`

Get an Apple App Store product page with version history and privacy labels (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.appleAppStore.product({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `product_id` | `string` | Yes | — |
| `type` | `app` | No | — |
| `country` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `version_history` | `object[]` | No | — |
| `ratings_and_reviews` | `object` | No | — |
| `privacy` | `object` | No | — |
| `information` | `object` | No | — |
| `iphone_screenshots` | `object[]` | No | — |
| `ipad_screenshots` | `object[]` | No | — |
| `featured_in` | `object[]` | No | — |
| `more_by_this_developer` | `object[]` | No | — |
| `you_may_also_like` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **version\_history full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **ratings\_and\_reviews full type**
>
> ```ts theme={null}
> {
> }
> ```

> **privacy full type**
>
> ```ts theme={null}
> {
> }
> ```

> **information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **iphone\_screenshots full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **ipad\_screenshots full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **featured\_in full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **more\_by\_this\_developer full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **you\_may\_also\_like full type**
>
> ```ts theme={null}
> {
> }[]
> ```

***

### reviews

`appleAppStore.reviews`

Get Apple App Store reviews, newest or most helpful first (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.appleAppStore.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `product_id` | `string` | Yes | — |
| `sort` | `mostrecent \| mosthelpful` | No | — |
| `country` | `string` | No | — |
| `page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### search

`appleAppStore.search`

Search the Apple App Store for apps with developer, price and rating (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.appleAppStore.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `term` | `string` | Yes | — |
| `num` | `number` | No | — |
| `disallow_explicit` | `boolean` | No | — |
| `property` | `developer` | No | — |
| `category_id` | `string` | No | — |
| `device` | `mobile \| tablet \| desktop` | No | — |
| `country` | `string` | No | — |
| `lang` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `organic_results` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
> }[]
> ```

***

## Apple Maps

### places

`appleMaps.places`

Get Apple Maps places by MUID with address, hours and ratings

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.appleMaps.places({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `muid` | `string` | Yes | — |
| `locale` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `place_results` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **place\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

***

### reviews

`appleMaps.reviews`

Get Apple Maps rating summary and written reviews by MUID

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.appleMaps.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `muid` | `string` | Yes | — |
| `locale` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `place_info` | `object` | No | — |
| `rating_summary` | `object` | No | — |
| `ratings` | `object[]` | No | — |
| `reviews` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **place\_info full type**
>
> ```ts theme={null}
> {
> }
> ```

> **rating\_summary full type**
>
> ```ts theme={null}
> {
> }
> ```

> **ratings full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

***

## Bing

### maps

`bing.maps`

Get Bing Maps listings by query or one place by ID

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.bing.maps({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `place_id` | `string` | No | — |
| `cp` | `string` | No | — |
| `setlang` | `string` | No | — |
| `first` | `number` | No | — |
| `count` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `local_results` | `object[]` | No | — |
| `place_results` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **local\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **place\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }
> ```

***

### search

`bing.search`

Search Bing for organic results, knowledge cards and rich modules

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.bing.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `filters` | `string` | No | — |
| `location` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `mkt` | `string` | No | — |
| `cc` | `string` | No | — |
| `first` | `number` | No | — |
| `safeSearch` | `off \| moderate \| strict` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `knowledge_graph` | `object` | No | — |
| `knowledge_graph_list` | `object[]` | No | — |
| `pagination` | `object` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   snippet?: string,
>   displayed_link?: string,
>   source?: string,
>   date?: string
> }[]
> ```

> **knowledge\_graph full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   type?: string,
>   kgmid?: string,
>   description?: string
> }
> ```

> **knowledge\_graph\_list full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

## Duckduckgo

### maps

`duckduckgo.maps`

Get DuckDuckGo Maps places within a bounding box

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.duckduckgo.maps({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `bbox` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `strict_bbox` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `local_results` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **local\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

***

### search

`duckduckgo.search`

Search DuckDuckGo for organic results with region and safe-search controls

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.duckduckgo.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `kl` | `string` | No | — |
| `safe` | `1 \| -1 \| -2` | No | — |
| `df` | `string` | No | — |
| `start` | `number` | No | — |
| `m` | `number` | No | — |
| `search_assist` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `pagination` | `object` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   snippet?: string,
>   displayed_link?: string,
>   source?: string,
>   date?: string
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

## Google

### ads

`google.ads`

Get Google text, local and shopping ads plus the rest of the results page (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.ads({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `location` | `string` | Yes | — |
| `hl` | `string` | No | — |
| `safe` | `active \| off` | No | — |
| `nfpr` | `0 \| 1` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `ads` | `object[]` | No | — |
| `local_ads` | `object[]` | No | — |
| `shopping_results` | `object[]` | No | — |
| `organic_results` | `object[]` | No | — |
| `related_questions` | `object[]` | No | — |
| `related_searches` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **ads full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   description?: string
> }[]
> ```

> **local\_ads full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   description?: string
> }[]
> ```

> **shopping\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   snippet?: string,
>   displayed_link?: string,
>   source?: string,
>   date?: string
> }[]
> ```

> **related\_questions full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **related\_searches full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   value?: string
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### aiMode

`google.aiMode`

Ask Google AI Mode a question and get text blocks with cited references

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.aiMode({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |
| `continuable` | `boolean` | No | — |
| `subsequent_request_token` | `string` | No | — |
| `image_url` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `text_blocks` | `object[]` | No | — |
| `references` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **text\_blocks full type**
>
> ```ts theme={null}
> {
>   type?: string,
>   text?: string
> }[]
> ```

> **references full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   link?: string,
>   snippet?: string
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### aiOverview

`google.aiOverview`

Get Google's AI Overview for a query as text blocks and cited references

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.aiOverview({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `ludocid` | `string` | No | — |
| `kgmid` | `string` | No | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `radius` | `number` | No | — |
| `lsig` | `string` | No | — |
| `si` | `string` | No | — |
| `ibp` | `string` | No | — |
| `uds` | `string` | No | — |
| `color_scheme` | `light \| dark` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `cr` | `string` | No | — |
| `lr` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |
| `tbs` | `string` | No | — |
| `safe` | `active \| off` | No | — |
| `nfpr` | `0 \| 1` | No | — |
| `filter` | `0 \| 1` | No | — |
| `pws` | `0 \| 1` | No | — |
| `peek_pws` | `0 \| 1` | No | — |
| `tbm` | `string` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |
| `as_dt` | `i \| e` | No | — |
| `as_epq` | `string` | No | — |
| `as_eq` | `string` | No | — |
| `as_lq` | `string` | No | — |
| `as_nlo` | `number` | No | — |
| `as_nhi` | `number` | No | — |
| `as_oq` | `string` | No | — |
| `as_q` | `string` | No | — |
| `as_qdr` | `string` | No | — |
| `as_rq` | `string` | No | — |
| `as_sitesearch` | `string` | No | — |
| `oq` | `string` | No | — |
| `gs_lp` | `string` | No | — |
| `sclient` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `ai_overview` | `object` | No | — |
| `pagination` | `object` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **ai\_overview full type**
>
> ```ts theme={null}
> {
>   text_blocks?: {
>   }[],
>   references?: {
>   }[]
> }
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### local

`google.local`

Get Google local results with rating, reviews, category, address and place IDs

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.local({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `ludocid` | `string` | No | — |
| `tbs` | `string` | No | — |
| `start` | `number` | No | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `local_results` | `object[]` | No | — |
| `local_map` | `object` | No | — |
| `discover_more_places` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **local\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **local\_map full type**
>
> ```ts theme={null}
> {
> }
> ```

> **discover\_more\_places full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### search

`google.search`

Search Google for organic results, Knowledge Graph, related searches and the AI Overview

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `fast_mode` | `boolean` | No | — |
| `q` | `string` | No | — |
| `ludocid` | `string` | No | — |
| `kgmid` | `string` | No | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `radius` | `number` | No | — |
| `lsig` | `string` | No | — |
| `si` | `string` | No | — |
| `ibp` | `string` | No | — |
| `uds` | `string` | No | — |
| `color_scheme` | `light \| dark` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `cr` | `string` | No | — |
| `lr` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |
| `tbs` | `string` | No | — |
| `safe` | `active \| off` | No | — |
| `nfpr` | `0 \| 1` | No | — |
| `filter` | `0 \| 1` | No | — |
| `pws` | `0 \| 1` | No | — |
| `peek_pws` | `0 \| 1` | No | — |
| `tbm` | `string` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |
| `as_dt` | `i \| e` | No | — |
| `as_epq` | `string` | No | — |
| `as_eq` | `string` | No | — |
| `as_lq` | `string` | No | — |
| `as_nlo` | `number` | No | — |
| `as_nhi` | `number` | No | — |
| `as_oq` | `string` | No | — |
| `as_q` | `string` | No | — |
| `as_qdr` | `string` | No | — |
| `as_rq` | `string` | No | — |
| `as_sitesearch` | `string` | No | — |
| `oq` | `string` | No | — |
| `gs_lp` | `string` | No | — |
| `sclient` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `knowledge_graph` | `object` | No | — |
| `ai_overview` | `object` | No | — |
| `related_questions` | `object[]` | No | — |
| `related_searches` | `object[]` | No | — |
| `shopping_results` | `object[]` | No | — |
| `immersive_products` | `object[]` | No | — |
| `perspectives` | `object[]` | No | — |
| `pagination` | `object` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   snippet?: string,
>   displayed_link?: string,
>   source?: string,
>   date?: string
> }[]
> ```

> **knowledge\_graph full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   type?: string,
>   kgmid?: string,
>   description?: string
> }
> ```

> **ai\_overview full type**
>
> ```ts theme={null}
> {
>   text_blocks?: {
>   }[],
>   references?: {
>   }[]
> }
> ```

> **related\_questions full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **related\_searches full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   value?: string
> }[]
> ```

> **shopping\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **immersive\_products full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **perspectives full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### shopping

`google.shopping`

Get Google Shopping products with price, merchant, rating and delivery

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.shopping({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `shoprs` | `string` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |
| `min_price` | `number` | No | — |
| `max_price` | `number` | No | — |
| `sort_by` | `1 \| 2 \| 3` | No | — |
| `on_sale` | `boolean` | No | — |
| `free_shipping` | `boolean` | No | — |
| `small_business` | `boolean` | No | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `shopping_results` | `object[]` | No | — |
| `categorized_shopping_results` | `object[]` | No | — |
| `filters` | `object[]` | No | — |
| `carousel_filters` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **shopping\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **categorized\_shopping\_results full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **filters full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   value?: string
> }[]
> ```

> **carousel\_filters full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### shoppingProduct

`google.shoppingProduct`

Get one Google Shopping product page with every merchant offer and specification

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.google.shoppingProduct({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `gpcid` | `string` | No | — |
| `headline_offer_docid` | `string` | No | — |
| `image_docid` | `string` | No | — |
| `prds` | `string` | No | — |
| `q` | `string` | Yes | — |
| `location` | `string` | No | — |
| `uule` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `device` | `desktop \| tablet \| mobile` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `product_result` | `object` | No | — |
| `offers` | `object[]` | No | — |
| `related_products` | `object[]` | No | — |
| `product_reviews` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **product\_result full type**
>
> ```ts theme={null}
> {
> }
> ```

> **offers full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **related\_products full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **product\_reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

***

## Google Maps

### contributorReviews

`googleMaps.contributorReviews`

Get the public review history for one Google Maps contributor

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.contributorReviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `contributor_id` | `string` | Yes | — |
| `limit` | `number` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `contributor` | `object` | No | — |
| `reviews` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **contributor full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

***

### photoMeta

`googleMaps.photoMeta`

Get the place, contributor and date of a Google Maps photo

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.photoMeta({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `data_id` | `string` | Yes | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `place_info` | `object` | No | — |
| `contributor` | `object` | No | — |
| `photo` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **place\_info full type**
>
> ```ts theme={null}
> {
> }
> ```

> **contributor full type**
>
> ```ts theme={null}
> {
> }
> ```

> **photo full type**
>
> ```ts theme={null}
> {
> }
> ```

***

### popularTimes

`googleMaps.popularTimes`

See how busy a Google Maps place is right now

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.popularTimes({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `place_id` | `string` | Yes | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `popular_times` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **popular\_times full type**
>
> ```ts theme={null}
> {
> }
> ```

***

### posts

`googleMaps.posts`

Read the posts published by a Google Maps business

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.posts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `data_id` | `string` | Yes | — |
| `next_page_token` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `posts` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **posts full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### reviews

`googleMaps.reviews`

Get Google Maps reviews with rating, text, author, date and likes

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `place_id` | `string` | No | — |
| `data_id` | `string` | No | — |
| `sort_by` | `qualityScore \| newestFirst \| ratingHigh \| ratingLow` | No | — |
| `topic_id` | `string` | No | — |
| `query` | `string` | No | — |
| `num` | `number` | No | — |
| `next_page_token` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `source_metadata` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `place_info` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `topics` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **place\_info full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **topics full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### search

`googleMaps.search`

Get Google Maps places by query or one place by ID

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googleMaps.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `type` | `search \| place` | No | — |
| `place_id` | `string` | No | — |
| `data_cid` | `string` | No | — |
| `data` | `string` | No | — |
| `ll` | `string` | No | — |
| `location` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `z` | `number` | No | — |
| `m` | `number` | No | — |
| `nearby` | `boolean` | No | — |
| `min_price` | `number` | No | — |
| `max_price` | `number` | No | — |
| `min_rating` | `2.0 \| 2.5 \| 3.0 \| 3.5 \| 4.0 \| 4.5` | No | — |
| `open_state` | `now \| 24h` | No | — |
| `open_on_day` | `mon \| tue \| wed \| thu \| fri \| sat \| sun` | No | — |
| `open_at_hour` | `number` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `google_domain` | `string` | No | — |
| `start` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `local_results` | `object[]` | No | — |
| `place_results` | `object` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **local\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **place\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

## Google Play

### apps

`googlePlay.apps`

Search and browse Google Play apps with charts, categories and storefronts (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.apps({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `apps_category` | `string` | No | — |
| `store_device` | `phone \| tablet \| tv \| chromebook \| watch \| car` | No | — |
| `age` | `AGE_RANGE1 \| AGE_RANGE2 \| AGE_RANGE3` | No | — |
| `chart` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `next_page_token` | `string` | No | — |
| `section_page_token` | `string` | No | — |
| `see_more_token` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `app_highlight` | `object` | No | — |
| `items_highlight` | `object` | No | — |
| `charts` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **app\_highlight full type**
>
> ```ts theme={null}
> {
> }
> ```

> **items\_highlight full type**
>
> ```ts theme={null}
> {
> }
> ```

> **charts full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### books

`googlePlay.books`

Browse Google Play ebooks and audiobooks with categories and charts (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.books({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `books_category` | `string` | No | — |
| `age` | `AGE_RANGE1 \| AGE_RANGE2 \| AGE_RANGE3` | No | — |
| `price` | `1 \| 2` | No | — |
| `chart` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `next_page_token` | `string` | No | — |
| `section_page_token` | `string` | No | — |
| `see_more_token` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `charts` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **charts full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### games

`googlePlay.games`

Browse Google Play games by category, chart and device (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.games({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `games_category` | `string` | No | — |
| `store_device` | `phone \| tablet \| tv \| chromebook \| watch \| windows` | No | — |
| `chart` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `next_page_token` | `string` | No | — |
| `section_page_token` | `string` | No | — |
| `see_more_token` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `items_highlight` | `object` | No | — |
| `charts` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **items\_highlight full type**
>
> ```ts theme={null}
> {
> }
> ```

> **charts full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### movies

`googlePlay.movies`

Browse Google Play movies, shows and episodes with categories and charts (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.movies({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `movies_category` | `string` | No | — |
| `age` | `AGE_RANGE1 \| AGE_RANGE2 \| AGE_RANGE3` | No | — |
| `chart` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `next_page_token` | `string` | No | — |
| `section_page_token` | `string` | No | — |
| `see_more_token` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `charts` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   link?: string,
>   price?: string,
>   merchant?: string,
>   rating?: number,
>   reviews?: number,
>   thumbnail?: string
> }[]
> ```

> **charts full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

### product

`googlePlay.product`

Get a Google Play product page with ratings, permissions, media and reviews (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.product({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `product_id` | `string` | Yes | — |
| `store` | `apps \| books \| audiobooks \| movies \| tv` | No | — |
| `season_id` | `string` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `product_info` | `object` | No | — |
| `about_this_app` | `object` | No | — |
| `ratings` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `media` | `object` | No | — |
| `permissions` | `object[]` | No | — |
| `data_safety` | `object` | No | — |
| `developer_contact` | `object` | No | — |
| `similar_results` | `object[]` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **product\_info full type**
>
> ```ts theme={null}
> {
> }
> ```

> **about\_this\_app full type**
>
> ```ts theme={null}
> {
> }
> ```

> **ratings full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **media full type**
>
> ```ts theme={null}
> {
> }
> ```

> **permissions full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **data\_safety full type**
>
> ```ts theme={null}
> {
> }
> ```

> **developer\_contact full type**
>
> ```ts theme={null}
> {
> }
> ```

> **similar\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

***

### reviews

`googlePlay.reviews`

Get Google Play reviews filtered by rating and platform (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.googlePlay.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `product_id` | `string` | Yes | — |
| `store` | `apps \| books \| audiobooks \| movies \| tv` | No | — |
| `num` | `number` | No | — |
| `platform` | `phone \| tablet \| watch \| chromebook \| tv` | No | — |
| `rating` | `number` | No | — |
| `sort_by` | `1 \| 2 \| 3` | No | — |
| `hl` | `string` | No | — |
| `gl` | `string` | No | — |
| `next_page_token` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `litescrape_pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **litescrape\_pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string
> }
> ```

***

## Keys

### status

`keys.status`

Get LiteScrape key status, remaining calls and concurrency limit

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.keys.status({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `remaining_calls` | `number` | Yes | — |
| `concurrency_limit` | `number` | Yes | — |
| `status` | `string` | Yes | — |
| `zdr_enabled` | `boolean` | No | — |
| `zdr_available` | `boolean` | No | — |

***

## Tripadvisor

### place

`tripadvisor.place`

Get Tripadvisor place details by place ID

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.tripadvisor.place({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `place_id` | `number` | Yes | — |
| `tripadvisor_domain` | `string` | No | — |
| `locale` | `string` | No | — |
| `currency` | `string` | No | — |
| `geo_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `place_results` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **place\_results full type**
>
> ```ts theme={null}
> {
> }
> ```

***

### reviews

`tripadvisor.reviews`

Get Tripadvisor reviews sorted by recency or relevance

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.tripadvisor.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `place_id` | `number` | Yes | — |
| `tripadvisor_domain` | `string` | No | — |
| `locale` | `string` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |
| `sort_by` | `recent \| relevance` | No | — |
| `translate` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `sort` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **sort full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### search

`tripadvisor.search`

Search Tripadvisor hotels, restaurants and attractions

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.tripadvisor.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | Yes | — |
| `tripadvisor_domain` | `string` | No | — |
| `locale` | `string` | No | — |
| `geo_id` | `string` | No | — |
| `lat` | `number` | No | — |
| `lon` | `number` | No | — |
| `place_type` | `all \| accommodation \| attraction \| attraction_product \| eatery \| geo` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `search_results` | `object[]` | No | — |
| `map_previews` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_results full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **map\_previews full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

## Web

### fetch

`web.fetch`

Render a public web page and return it as Markdown, HTML or text (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.web.fetch({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | — |
| `respond_with` | `markdown \| html \| text` | No | — |
| `target_selector` | `string` | No | — |
| `remove_selector` | `string` | No | — |
| `retain_links` | `none \| all \| text \| gpt-oss` | No | — |
| `retain_images` | `none \| all \| alt` | No | — |
| `with_iframe` | `true \| false \| quoted` | No | — |
| `with_shadow_dom` | `boolean` | No | — |
| `respond_timing` | `html \| visible-content \| mutation-idle \| resource-idle \| media-idle \| network-idle` | No | — |
| `wait_for_selector` | `string` | No | — |
| `page_timeout` | `number` | No | — |
| `timeout` | `number` | No | — |
| `locale` | `string` | No | — |
| `user_agent` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `content` | `string` | No | — |
| `html` | `string` | No | — |
| `text` | `string` | No | — |

***

### screenshot

`web.screenshot`

Capture a web page screenshot as a PNG download URL (Alpha)

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.web.screenshot({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | — |
| `full_page` | `boolean` | No | — |
| `respond_timing` | `html \| visible-content \| mutation-idle \| resource-idle \| media-idle \| network-idle` | No | — |
| `wait_for_selector` | `string` | No | — |
| `page_timeout` | `number` | No | — |
| `timeout` | `number` | No | — |
| `locale` | `string` | No | — |
| `user_agent` | `string` | No | — |
| `referer` | `string` | No | — |
| `remove_overlay` | `boolean` | No | — |
| `detach_invisibles` | `boolean` | No | — |
| `assert_status_code` | `number` | No | — |
| `robots_txt` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `screenshot_url` | `string` | Yes | — |
| `full_page` | `boolean` | No | — |

***

## Yelp

### reviews

`yelp.reviews`

Get Yelp reviews with rating, text, reviewer and owner replies

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.yelp.reviews({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `place_id` | `string` | Yes | — |
| `yelp_domain` | `string` | No | — |
| `hl` | `string` | No | — |
| `sortby` | `relevance_desc \| date_desc \| date_asc \| rating_desc \| rating_asc \| elites_desc` | No | — |
| `rating` | `string` | No | — |
| `start` | `number` | No | — |
| `num` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `reviews` | `object[]` | No | — |
| `review_languages` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **reviews full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   rating?: number,
>   title?: string,
>   snippet?: string,
>   text?: string,
>   date?: string,
>   author?: string,
>   reviewer?: string,
>   likes?: number
> }[]
> ```

> **review\_languages full type**
>
> ```ts theme={null}
> {
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***

### search

`yelp.search`

Search Yelp businesses with rating, reviews, categories and filters

**Risk:** `read`

```ts theme={null}
await corsair.litescrape.api.yelp.search({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `find_desc` | `string` | No | — |
| `find_loc` | `string` | Yes | — |
| `yelp_domain` | `string` | No | — |
| `l` | `string` | No | — |
| `cflt` | `string` | No | — |
| `sortby` | `recommended \| rating \| review_count` | No | — |
| `attrs` | `string` | No | — |
| `start` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `search_metadata` | `object` | No | — |
| `search_parameters` | `object` | No | — |
| `search_information` | `object` | No | — |
| `organic_results` | `object[]` | No | — |
| `ads_results` | `object[]` | No | — |
| `filters` | `object[]` | No | — |
| `related_links` | `object[]` | No | — |
| `pagination` | `object` | No | — |

> **search\_metadata full type**
>
> ```ts theme={null}
> {
>   id?: string,
>   status?: string,
>   total_time_taken?: number,
>   google_url?: string,
>   bing_url?: string
> }
> ```

> **search\_parameters full type**
>
> ```ts theme={null}
> {
> }
> ```

> **search\_information full type**
>
> ```ts theme={null}
> {
> }
> ```

> **organic\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **ads\_results full type**
>
> ```ts theme={null}
> {
>   position?: number,
>   title?: string,
>   place_id?: string,
>   data_id?: string,
>   type?: string,
>   address?: string,
>   phone?: string,
>   website?: string,
>   rating?: number,
>   reviews?: number
> }[]
> ```

> **filters full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   value?: string
> }[]
> ```

> **related\_links full type**
>
> ```ts theme={null}
> {
>   title?: string,
>   link?: string,
>   snippet?: string
> }[]
> ```

> **pagination full type**
>
> ```ts theme={null}
> {
>   next?: string,
>   next_page_token?: string,
>   page?: number
> }
> ```

***


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