/citilink/cities

POST /api/citilink/cities

Price: 20 credits

List the citilink.ru delivery cities with the code every other citilink endpoint takes as `city`, plus the city name, its regional hub code, the federal subject, the settlement type, KLADR-style locality code where published, coordinates and the local phone number. Search by name or walk the whole catalogue.

How to use it

Resolve a city name here before calling anything that returns a price — `id` is the value the other endpoints take, and it is not the city name. Most settlements have an `id` of the form `hub:code` while `space_id` names the regional hub they are served from; pass `id`, which is what the other endpoints echo back. Leaving `query` empty walks the whole catalogue, which is how you enumerate a region; a name prefix is enough to disambiguate the towns that repeat across Russia, and `region` settles the rest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of cities to return (min: 1)
• query string — City name or its first letters; leave empty to walk the whole catalogue alphabetically (default: ""; examples: "Казан", "Новосибирск", "")

Response

• @type string (default: "CitilinkCity")
• id string required
• space_id string nullable
• kladr_id string nullable
• name string nullable
• name_in_declination string nullable
• region string nullable
• settlement_type string nullable
• is_main_in_region boolean nullable
• is_unique_name boolean nullable
• latitude number nullable
• longitude number nullable
• phone string 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 — The entity was not found, or a precondition failed 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 — citilink.ru did not return the city catalogue. 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.