About this endpoint
What it does
Retrieves SERP ranking results for a keyword and returns them in a JSON object. You provide a search keyword, with optional size, language, and location inputs, and the response contains a data.results array of result objects.
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 (for example: en, de, fr, ja, zh-cn). Default: en. |
| location | String | No | ISO 3166-1 alpha-2 country code (for example: us, gb, de, in, au). Default: us. |
Response
Returns a JSON object with a data object field. data contains a results array of result objects; each result includes url, rank, type, title, domain, breadcrumb, and description fields. Success returns HTTP 200.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Response wrapper containing the results array. |
| data.results | Object Array | No | List of SERP result objects. |
| data.results[].url | String | No | Result URL. Format: URI. |
| data.results[].rank | Integer | No | Result position in the SERP. |
| data.results[].type | String | No | Result type. |
| data.results[].title | String | No | Result title. |
| data.results[].domain | String | No | Result domain. |
| data.results[].breadcrumb | String | No | Result breadcrumb text. |
| data.results[].description | String | No | Result description snippet. |