/yandexmaps/organizations

POST /api/yandexmaps/organizations

Price: 10 credits

Get full Yandex Maps organization details by permalink (or organization URL): title, rating, review and rating counts, categories, phones, website, address with postal code and coordinates, working hours, features/amenities, nearby metro and stops, photos, awards and social links.

How to use it

Fetch a single Yandex Maps organization by its numeric permalink (e.g. '230955670099') or a full organization URL. Returns one item with title, rating, rating_count, review_count, categories, phones, website, address/full_address/postal_code, latitude/longitude, working_hours, features, metro, stops, photos, awards and links.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• organization string required — Yandex Maps organization permalink (numeric id) or a full organization URL (examples: "230955670099", "https://yandex.ru/maps/org/espressobar/230955670099/"; minLength: 1)

Response

• @type string (default: "YandexMapsOrganization")
• id string required
• alias string nullable
• description string nullable
• url string nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• categories array (default: [])
  • @type string (default: "YandexMapsCategory")
  • id string nullable
  • name string nullable
  • alias string nullable
  • type string nullable
• phones array (default: [])
• website string nullable
• address string nullable
• full_address string nullable
• additional_address string nullable
• postal_code string nullable
• locality string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• photo_count integer nullable
• photos array (default: [])
• working_status string nullable
• working_time_text string nullable
• is_open_now boolean nullable
• working_hours array (default: [])
  • @type string (default: "YandexMapsWorkingHours")
  • day string required
  • is_open boolean (default: false)
  • intervals array (default: [])
• features array (default: [])
  • @type string (default: "YandexMapsFeature")
  • id string required
  • name string nullable
  • type string nullable
  • value union nullable
  • is_important boolean (default: false)
• metro array (default: [])
  • @type string (default: "YandexMapsNearbyPlace")
  • id string nullable
  • name string nullable
  • type string nullable
  • distance string nullable
  • distance_value number nullable
  • color string nullable
• stops array (default: [])
  • @type string (default: "YandexMapsNearbyPlace")
  • id string nullable
  • name string nullable
  • type string nullable
  • distance string nullable
  • distance_value number nullable
  • color string nullable
• links array (default: [])
  • @type string (default: "YandexMapsLink")
  • type string nullable
  • url string nullable
• awards array (default: [])
• chain string nullable
• is_verified boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Organization not found (well-formed permalink but no such organization on Yandex Maps) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.