Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Search API
    • All guides
      • General connection procedure
      • Query testing
      • Authentication with the API
      • Requesting limits
      • Performing search queries
      • Mobile search results
  • Access management
  • Pricing policy
  • Audit Trails events

In this article:

  • Prepare your cloud environment
  • Prepare a service account
  • Create a service account
  • Assign a role
  • Create an API key
  • Sign up to Yandex Search API
  • Create a test request
  • Set up integration with Yandex Search API
  1. Step-by-step guides
  2. API v1
  3. General connection procedure

General connection procedure

Written by
Yandex Cloud
Improved by
Danila N.
Updated at May 7, 2025
  • Prepare your cloud environment
  • Prepare a service account
    • Create a service account
    • Assign a role
    • Create an API key
  • Sign up to Yandex Search API
  • Create a test request
  • Set up integration with Yandex Search API

To submit queries to the Yandex search database using Yandex Search API via API v1, configure a service account.

Follow these steps to set up Yandex Search API to operate via API v1:

  1. Prepare your cloud environment.
  2. Prepare a service account.
  3. Sign up to Yandex Search API.
  4. Create a test request.
  5. Set up integration with Yandex Search API.

Prepare your cloud environment

Sign up in Yandex Cloud and create a billing account:

  1. Navigate to the management console and log in to Yandex Cloud or register a new account.
  2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one and link a cloud to it.

If you have an active billing account, you can navigate to the cloud page to create or select a folder for your infrastructure to operate in.

Learn more about clouds and folders.

Prepare a service account

Create a service account

Management console
  1. Go to the management console.

  2. On the left side of the screen, click the line with the name of the folder where you want to create a service account.

  3. In the list of services, select Identity and Access Management.

  4. Click Create service account.

  5. Enter a name for the service account.

    The name format requirements are as follows:

    • It must be from 2 to 63 characters long.
    • It may contain lowercase Latin letters, numbers, and hyphens.
    • It must start with a letter and cannot end with a hyphen.

    Make sure the service account name is unique within your cloud.

  6. Click Create.

Assign a role

Assign to the service account the search-api.executor role it needs to query Yandex Search API via API v1.

Management console
  1. In the management console, select the appropriate folder.
  2. Go to the Access bindings tab.
  3. Click Configure access.
  4. In the window that opens, select Service accounts.
  5. Select a service account from the list or use the search.
  6. Click Add role and select the role in the folder.
  7. Click Save.

Create an API key

The service account will need a Yandex Search API API key for authentication in API v1. Create an API key for the service account:

Management console
  1. In the management console, navigate to the folder the service account belongs to.
  2. From the list of services, select Identity and Access Management.
  3. In the left-hand panel, select Service accounts.
  4. Select the service account to create an API key for. Create a new service account if you need to.
  5. In the top panel, click Create new key and select Create API key.
  6. Enter a description of the key so that you can easily find it in the management console.
  7. In the Scope field, select one or multiple scopes.
  8. Optionally, specify Expires at.
  9. Click Create.
  10. Save the ID and secret key.

Alert

After you close this dialog, the key value will not be shown again.

Sign up to Yandex Search API

To use the API v1 interface, you must register in Yandex Search API:

Management console
  1. In the management console, select the folder you are going to use to work with Yandex Search API or create a new one.

  2. In the list of services, select Yandex Search API.

  3. Fill in the form fields:

    • Select the Search type: Russian, Turkish, or International.

    • Set at least one trusted IP address to send requests to the Yandex search database from.

      You can send requests to Yandex Search API's API v1 only from one of the IP addresses added to the service settings during registration. Attempts to run a request from a non-registered IP address will be rejected.

  4. Click Save.

After that, you will be able to change the search type and the trusted IP address list. In the management console, go to the Yandex Search API service and click Edit in the top-right corner.

Create a test request

To interactively explore the principle of formation of Yandex Search API search queries via API v1, use the special query testing form:

Management console
  1. In the management console, select the folder you are going to use to work with Yandex Search API.

  2. In the list of services, select Yandex Search API.

  3. In the left-hand panel, select Test queries.

  4. Select a Request method (GET and POST methods are supported) and fill in the form fields.

    Note

    You cannot edit the Search query text in a test query. Queries are submitted from a Yandex IP address on behalf of the service.

    As the values in the form fields change, the search query URL for the specified values will be formed in the Search query field. If you select the POST method, a relevant query body will be formed in the Request body field.

  5. Click Run test. The query execution result will be displayed below.

  6. If necessary, change the parameters to adjust the search results and resubmit your query.

Set up integration with Yandex Search API

  1. Learn about authentication in API v1 and configure querying.
  2. Configure response handling based on the response format in XML or HTML.
  3. If necessary, request information about hourly limits for the next 24 hours.

Was the article helpful?

Previous
All guides
Next
Query testing
© 2025 Direct Cursus Technology L.L.C.