About this endpoint
What it does
Retrieves SERP rankings for a keyword and returns the matching results in the response. You provide the keyword to search for, and can optionally set the number of results, language, and location.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| keyword | String | Yes | Search keyword or phrase. |
| size | Integer | No | Number of results to return. Default: 10. Minimum: 1. |
| language | String | No | ISO 639-1 language code (e.g. en, de, fr, ja, zh-cn). Default: en. |
| location | String | No | ISO 3166-1 alpha-2 country code (e.g. us, gb, de, in, au). Default: us. |
Response
Returns a JSON object with a data array field. data contains SERP result objects directly, each with url, rank, type, title, domain, breadcrumb, and description fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object Array | No | Array of result objects, ranked across all result types (organic and sponsored). |
| data[].url | String | No | URL of the ranked result (URI string). |
| data[].rank | Integer | No | Position of the result in the combined ranked result set. |
| data[].type | String | No | Result type (e.g. organic or inorganic). |
| data[].title | String | No | Title of the ranked page. |
| data[].domain | String | No | Domain of the ranked page. |
| data[].breadcrumb | String | No | Breadcrumb or URL path shown for the result. |
| data[].description | String | No | Snippet or description text for the result. |