# API Parameters

When using our Yandex API, it's essential to familiarize yourself with the available parameters. These parameters empower you to tailor your requests, ensuring that the results align with your specific needs.

*Note*: Always ensure the `engine` parameter is set to `yandex` for this API.

| Parameter          | Type     | Description                                                                                                                            |
| ------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key` Required | `string` | ​The API key required to authorise requests.                                                                                           |
| `engine` Required  | `string` | The engine of the SERP API. Needs to be set to **`yandex`** for requests to Yandex.com.                                                |
| `text` Required    | `string` | The keywords that you are searching for (the query).                                                                                   |
| `yandex_domain`    | `string` | The Yandex domain from where the search is performed.                                                                                  |
| `device`           | `string` | The device used for your Yandex search. Can be set to `desktop`, `mobile` or `tablet`.                                                 |
| `lr`               | `string` | The country code from where you want to perform the ID of the country or region to search. Determines the rules for ranking documents. |
| `lang`             | `string` | The language to use for the search.                                                                                                    |
| `p`                | `int`    | The page number. Count starts from `0`.                                                                                                |
| `location`         | `string` | Defines where you want the search to originate from.                                                                                   |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.shifter.io/yandex-serp-api/api-parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.