Search
Autocomplete, address search, reverse geocoding with entrances.
/v1/geocode/autocompleteҚолжетімдіType-ahead suggestions (kk / ru / en, mixed Cyrillic and Latin)
- Хост
https://api.atasumaps.com·autocomplete- Рұқсат
- API кілті, рұқсат аясы: search
- Есепке алу
- autocomplete_session (session сайын)
Normalizes with kz-text (transliteration, мкр / микр. / шағын аудан, дом / үй, подъезд / кіреберіс), then recalls from both the osm and ugc documents (never merged into one record).
Metered per autocomplete session: requests sharing session_token count once; a session ends
when a suggestion is resolved with getPlace / searchAddress or after 3 minutes idle.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|---|---|---|---|
q | query | string | иә | |
near | query | LngLat | Bias point lng,lat. | |
lang | query | Lang | Response language; overrides Accept-Language. Default kk (Cyrillic). | |
session_token | query | string (uuid) | Client-generated UUID grouping the keystrokes of one search for metering. | |
limit | query | integer |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|---|---|
200 | Suggestions | AutocompleteResponse |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
402 | A budget cap is reached and no degraded answer exists (budget_exhausted; context.level is organization or product, context.product the product) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
503 | Dependency down (routing_unavailable, search_unavailable, budget_unavailable, traffic_unavailable, auth_unavailable, db_unavailable, tiles_unavailable) | Problem |
/v1/geocode/searchҚолжетімдіFull-text and structured address / place search
- Хост
https://api.atasumaps.com·searchAddress- Рұқсат
- API кілті, рұқсат аясы: search
- Есепке алу
- geocode (request сайын)
Either q (free text), the structured fields, or category with near / bbox. House,
microdistrict-house, entrance and flat numbers must match exactly (no typo tolerance). Returns
building or street precision when there is no entrance evidence — never a forced entrance.
Category browse / filter (the "Cafe · Restaurant · Parking · School · Market" shortcuts):
categoryrestricts results totype: placedocuments whosecategoryis in the list. It impliestypes=place: together with atypeslist that does not containplacethe result is empty. House-number matching is skipped (addresses have no category).- With
q(or structured fields): the normal text search, filtered to those categories. - Without
qand structured fields: a pure category browse. It requiresnearorbbox(400 invalid_requestotherwise). Withnear, places are sorted by distance from it (nearest first,distance_mset); with onlybbox, by static rank inside the box. - The vocabulary is the place
categoryfield as returned inSearchResult.category(today the OSMamenity/shop/ … value, e.g.cafe,restaurant,parking,school,marketplace,pharmacy). Which sources feed places depends on the POI decision, so coverage varies and a valid category can return no results.
Entrance evidence is an OSM entrance node of the building or an approved crowdsourced entrance
submitted for it (parent_place_id = the building's OSM id; decision D42). The result stays the OSM
address (its id, source: osm, attribution); the crowdsourced entrance is listed in entrances
with source: ugc and its own ugc.* id, and with the same number as an OSM node it is the one
chosen (a moderated correction). A reverted entrance is no longer listed.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|---|---|---|---|
q | query | string | ||
city | query | string | ||
street | query | string | ||
house | query | HouseNumber | ||
mkr | query | string | ||
mkr_house | query | HouseNumber | ||
near | query | LngLat | Bias point lng,lat. | |
bbox | query | number[] | Restrict to min_lng,min_lat,max_lng,max_lat. | |
types | query | ResultType[] | ||
category | query | string[] | Only places of these categories (comma-separated, e.g. cafe,restaurant). Makes q optional when near or bbox is given (category browse). See the operation description. | |
lang | query | Lang | Response language; overrides Accept-Language. Default kk (Cyrillic). | |
session_token | query | string (uuid) | Ends the autocomplete session with the same token. | |
limit | query | integer |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|---|---|
200 | Ranked results | SearchResponse |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
402 | A budget cap is reached and no degraded answer exists (budget_exhausted; context.level is organization or product, context.product the product) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
503 | Dependency down (routing_unavailable, search_unavailable, budget_unavailable, traffic_unavailable, auth_unavailable, db_unavailable, tiles_unavailable) | Problem |
/v1/geocode/reverseҚолжетімдіCoordinates → address and nearest entrance
- Хост
https://api.atasumaps.com·reverseGeocode- Рұқсат
- API кілті, рұқсат аясы: search
- Есепке алу
- reverse (request сайын)
KNN in osm and ugc separately, assembled in the API. The nearest point is not assumed to be
the user's building: building outlines and distance thresholds decide. precision says how
exact the answer is.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|---|---|---|---|
lng | query | number | иә | |
lat | query | number | иә | |
radius_m | query | integer | ||
lang | query | Lang | Response language; overrides Accept-Language. Default kk (Cyrillic). |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|---|---|
200 | Best match plus nearest entrance | ReverseResponse |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
402 | A budget cap is reached and no degraded answer exists (budget_exhausted; context.level is organization or product, context.product the product) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
422 | Understood but cannot be done (outside_coverage, no_route, unresolvable_waypoint, too_far_from_report, event_type_disabled, no_evidence, target_not_editable) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
503 | Dependency down (routing_unavailable, search_unavailable, budget_unavailable, traffic_unavailable, auth_unavailable, db_unavailable, tiles_unavailable) | Problem |