/kakaomap/places/search

POST /api/kakaomap/places/search

Price: 5 credits

Search Kakao Map (카카오맵) places by keyword: one row per place with category, address, coordinates, phone, rating, review and blog review counts, photos, keywords and amenities

How to use it

Put the area in the keyword, as in 강남역 맛집. Pass a returned id to kakaomap/places for hours, menu and facilities. A keyword returns at most 500 places.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search keyword, optionally with a place name (examples: "강남역 맛집"; minLength: 1)
• count integer required — Max number of places to return (min: 1; max: 500)

Response

• @type string (default: "KakaomapPlaceCard")
• id string required
• url string required
• name string nullable
• branch string nullable
• category string nullable
• category_path array (default: [])
• category_ids array (default: [])
• address string nullable
• road_address string nullable
• zipcode string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• homepage string nullable
• image string nullable
• images array (default: [])
• photo_count integer nullable
• rating number nullable
• review_count integer nullable
• blog_review_count integer nullable
• keywords array (default: [])
• payments array (default: [])
• services array (default: [])
• benefits array (default: [])
• takes_reservations boolean nullable
• offers_delivery boolean nullable
• offers_takeout boolean nullable
• has_parking boolean nullable
• allows_pets boolean nullable
• has_wifi boolean nullable
• is_wheelchair_accessible boolean nullable
• has_nursery boolean nullable
• has_smoking_room boolean nullable
• is_new_open boolean nullable
• kakao_channel_id string nullable
• fuel_prices array (default: [])
  • @type string (default: "KakaomapFuelPrice")
  • fuel string required
  • price number nullable
  • average_price number nullable
  • updated_at integer nullable
• is_self_service boolean nullable
• is_open_24h boolean nullable
• has_car_wash boolean nullable
• has_maintenance boolean nullable
• has_convenience_store boolean nullable
• sells_lottery boolean nullable
• sells_medicine boolean nullable
• offers_parcel_service boolean nullable
• has_atm boolean nullable
• first_hour_parking_fee number nullable
• has_free_parking boolean nullable
• parking_partnership string nullable
• booking_offers array (default: [])
  • @type string (default: "KakaomapBookingOffer")
  • store_type string nullable
  • service_type string nullable
  • product_name string nullable
  • price number nullable
• course_route string nullable
• course_length string nullable
• course_duration string nullable
• station_exits array (default: [])
  • @type string (default: "KakaomapRelatedPlace")
  • id string required
  • name string nullable
• ev_station_id string nullable
• ev_charger_count integer nullable
• indoor_floor string nullable
• train_types array (default: [])
• realty_category string nullable
• realty_complex_id string nullable
• realty_url 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 — 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.