API

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

New to Corsair? See API access, authentication, and error handling.

Account

getStatus

account.getStatus Return the remaining request quota for the API key Risk: read

await corsair.zenserp.api.account.getStatus({});

Input: empty object Output

Name	Type	Required	Description
`remaining_requests`	`number`	Yes	—

Batches

list

batches.list List submitted Zenserp batches Risk: read

await corsair.zenserp.api.batches.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—

Output: object

Output full type

{
}[] | {
  data: {
  }[]
}

Metadata

listCountries

metadata.listCountries List supported Google country parameters Risk: read

await corsair.zenserp.api.metadata.listCountries({});

Input: empty object Output: object[]

Output full type

{
  name?: string,
  value?: string,
  code?: string
}[]

listLanguages

metadata.listLanguages List supported Google interface languages Risk: read

await corsair.zenserp.api.metadata.listLanguages({});

Input: empty object Output: object[]

Output full type

{
  name?: string,
  value?: string,
  code?: string
}[]

listLocations

metadata.listLocations List supported geolocation targets Risk: read

await corsair.zenserp.api.metadata.listLocations({});

Input

Name	Type	Required	Description
`q`	`string`	No	—

Output: object[]

Output full type

{
  name?: string,
  canonical_name?: string,
  country_code?: string
}[]

listSearchEngines

metadata.listSearchEngines List supported search-engine domains Risk: read

await corsair.zenserp.api.metadata.listSearchEngines({});

Input: empty object Output: object[]

Output full type

{
  name?: string,
  domain?: string
}[]

Search

bing

search.bing Search Bing and return structured SERP data Risk: read

await corsair.zenserp.api.search.bing({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	—
`location`	`string`	No	—
`hl`	`string`	No	—
`gl`	`string`	No	—
`device`	`desktop \| tablet \| mobile`	No	—
`num`	`number`	No	—
`start`	`number`	No	—

Output

Name	Type	Required	Description
`query`	`object`	Yes	—
`organic`	`object[]`	No	—
`paid`	`object[]`	No	—
`images`	`object[]`	No	—
`related_searches`	`object[]`	No	—
`pagination`	`object`	No	—
`number_of_results`	`number`	No	—
`knowledge_graph`	`object`	No	—

query full type

{
}

organic full type

{
}[]

paid full type

{
}[]

images full type

{
}[]

pagination full type

{
}

knowledge_graph full type

{
}

google

search.google Search Google and return structured SERP data Risk: read

await corsair.zenserp.api.search.google({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	—
`location`	`string`	No	—
`hl`	`string`	No	—
`gl`	`string`	No	—
`device`	`desktop \| tablet \| mobile`	No	—
`num`	`number`	No	—
`start`	`number`	No	—

Output

Name	Type	Required	Description
`query`	`object`	Yes	—
`organic`	`object[]`	No	—
`paid`	`object[]`	No	—
`images`	`object[]`	No	—
`related_searches`	`object[]`	No	—
`pagination`	`object`	No	—
`number_of_results`	`number`	No	—
`knowledge_graph`	`object`	No	—

query full type

{
}

organic full type

{
}[]

paid full type

{
}[]

images full type

{
}[]

pagination full type

{
}

knowledge_graph full type

{
}

reverseImage

search.reverseImage Run a Google reverse-image search for a public image URL Risk: read

await corsair.zenserp.api.search.reverseImage({});

Input

Name	Type	Required	Description
`imageUrl`	`string`	Yes	—
`location`	`string`	No	—
`gl`	`string`	No	—
`hl`	`string`	No	—

Output

Name	Type	Required	Description
`query`	`object`	Yes	—
`organic`	`object[]`	No	—
`paid`	`object[]`	No	—
`images`	`object[]`	No	—
`related_searches`	`object[]`	No	—
`pagination`	`object`	No	—
`number_of_results`	`number`	No	—
`knowledge_graph`	`object`	No	—

query full type

{
}

organic full type

{
}[]

paid full type

{
}[]

images full type

{
}[]

pagination full type

{
}

knowledge_graph full type

{
}

yandex

search.yandex Search Yandex and return structured SERP data Risk: read

await corsair.zenserp.api.search.yandex({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	—
`location`	`string`	No	—
`hl`	`string`	No	—
`gl`	`string`	No	—
`device`	`desktop \| tablet \| mobile`	No	—
`num`	`number`	No	—
`start`	`number`	No	—

Output

Name	Type	Required	Description
`query`	`object`	Yes	—
`organic`	`object[]`	No	—
`paid`	`object[]`	No	—
`images`	`object[]`	No	—
`related_searches`	`object[]`	No	—
`pagination`	`object`	No	—
`number_of_results`	`number`	No	—
`knowledge_graph`	`object`	No	—

query full type

{
}

organic full type

{
}[]

paid full type

{
}[]

images full type

{
}[]

pagination full type

{
}

knowledge_graph full type

{
}

Shopping

getProduct

shopping.getProduct Retrieve Google Shopping product details Risk: read

await corsair.zenserp.api.shopping.getProduct({});

Input

Name	Type	Required	Description
`productId`	`string`	Yes	—
`location`	`string`	No	—
`gl`	`string`	No	—
`hl`	`string`	No	—

Output

Name	Type	Required	Description
`query`	`object`	Yes	—
`title`	`string`	Yes	—
`description`	`string`	No	—
`image`	`string`	No	—
`reviews`	`object[]`	No	—
`specifications`	`object[]`	No	—
`sellers`	`object[]`	No	—

query full type

{
}

reviews full type

{
}[]

specifications full type

{
}[]

sellers full type

{
}[]

Trends

get

trends.get Retrieve Google Trends data for one or more keywords Risk: read

await corsair.zenserp.api.trends.get({});

Input

Name	Type	Required	Description
`keywords`	`string[]`	Yes	—
`location`	`string`	No	—
`timeframe`	`string`	No	—

Output

Name	Type	Required	Description
`json`	`object`	Yes	—
`html`	`string`	No	—

json full type

{
}

Overview

Plugins

Account

getStatus

Batches

list

Metadata

listCountries

listLanguages

listLocations

listSearchEngines

Search

bing

google

reverseImage

yandex

Shopping

getProduct

Trends

get

​Account

​getStatus

​Batches

​list

​Metadata

​listCountries

​listLanguages

​listLocations

​listSearchEngines

​Search

​bing

​google

​reverseImage

​yandex

​Shopping

​getProduct

​Trends

​get

Account

getStatus

Batches

list

Metadata

listCountries

listLanguages

listLocations

listSearchEngines

Search

bing

google

reverseImage

yandex

Shopping

getProduct

Trends

get