Skip to main content
POST
Live Google AI Mode SERP

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
keyword
string
required

Keyword; you can specify up to 700 characters

location_code
integer

Search engine location code; required if location_name or location_coordinate is not specified

location_name
string

Full name of search engine location; required if location_code or location_coordinate is not specified

location_coordinate
string

GPS coordinates of a location; required if location_name or location_code is not specified

language_name
string

Full name of search engine language; required if language_code is not specified

language_code
string

Search engine language code; required if language_name is not specified

device
string

Device type: desktop or mobile

calculate_rectangles
boolean

Enable pixel ranking calculations for elements in SERP

browser_screen_width
integer

Custom browser screen width

browser_screen_height
integer

Custom browser screen height

browser_screen_resolution_ratio
number

Screen resolution ratio for rectangle calculations

Response

Successful response

version
string

The current version of the API

status_code
integer

General status code

status_message
string

General informational message

time
string

Execution time, seconds

cost
number

Total tasks cost, USD

tasks_count
integer

The number of tasks in the tasks array

tasks_error
integer

The number of tasks in the tasks array returned with an error

tasks
string[]

Array of tasks

tasks[].result
string[]

Array of live SERP results

tasks[].result[].keyword
string

Keyword received in the POST array

tasks[].result[].type
string

Search engine type in the POST array

tasks[].result[].se_domain
string

Search engine domain in the POST array

tasks[].result[].location_code
integer

Location code in the POST array

tasks[].result[].language_code
string

Language code in the POST array

tasks[].result[].check_url
string

Search URL with refinement parameters

tasks[].result[].item_types
string[]

Types of search results found in SERP

tasks[].result[].items_count
integer

Number of results returned in the items array

tasks[].result[].items
string[]

Elements of search results found in SERP