# 장소 검색·거리 정렬 장소명으로 검색해 분류·주소·좌표를 정리하고, 기준점이 있으면 각 결과의 거리·방위를 계산해 가까운 순으로 정렬합니다. 주변 후보를 가까운 순서로 보여줄 때 씁니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/geo_place_search 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.query` (string): 검색에 사용한 키워드를 그대로 반환한 값입니다. 응답의 결과가 어떤 검색어 기준인지 확인할 때 사용합니다. - `data.origin` (object): 적용한 기준점입니다. 없으면 null 입니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. null 허용. - `data.origin.x` (number): 'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.origin.y` (number): 'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.origin.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.radius` (integer): 'radius' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.page` (object): 조회한 리뷰 페이지 번호입니다. 1부터 시작합니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.page.current` (integer): 'current' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.page.size` (integer): 'size' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.page.total` (integer): 'total' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.count` (integer): 반환한 결과 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items` (array): 조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다. - `data.items[].index` (integer): 'index' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].id` (string): YouTube 항목의 고유 ID입니다. 영상은 11자리, 채널은 UC로 시작하는 ID가 옵니다. - `data.items[].name` (string): 장소 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].category` (object): 'category' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].category.full` (string): 분류 전체 표기입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].category.large` (string): 대분류입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].category.middle` (string): 중분류입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].category.small` (string): 소분류입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].address` (object): 장소의 도로명·지번 주소입니다. 여러 줄이면 줄바꿈이 포함될 수 있습니다. - `data.items[].address.road` (string): 도로명 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].address.parcel` (string): 지번 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].point` (object): 'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].point.x` (number): 경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.y` (number): 위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].distanceM` (number): 기준점과의 거리(m)입니다. 기준점이 있을 때만 있습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].bearing` (number): 기준점에서 본 방위(도, 북쪽 0·동쪽 90)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. ## API 요청: POST /rest/geo_place_search ### 입력 - `query` (string, 필수): 장소 검색어 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `origin` (string, 선택): 기준점 "경도,위도" (예: 127.025,37.504) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `x` (number, 선택): 기준점 경도. origin 대신 사용합니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `y` (number, 선택): 기준점 위도. origin 대신 사용합니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `radius` (number, 선택): 반경(m). 주면 반경 밖 결과를 제외합니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `sort` (string, 선택): 정렬 (기본 distance, 기준점이 있을 때만 적용) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 2가지입니다. distance = distance 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. relevance = 검색어와의 관련도가 높은 순서로 정렬하는 값입니다. 기본 정렬로 가장 많이 쓰입니다. 허용값: distance, relevance - `page` (integer, 선택): 조회할 페이지 번호입니다. 1부터 시작하며, 전체 결과 범위를 넘으면 빈 배열이 옵니다. - `size` (integer, 선택): 출력 이미지의 크기입니다. 1024x1024 같은 WxH 형식으로 보내며, 모델별 지원 크기를 확인하세요. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "string" }, "origin": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "crs": { "type": "string" } }, "description": "적용한 기준점입니다. 없으면 null 입니다.", "nullable": true }, "radius": { "type": "integer" }, "page": { "type": "object", "properties": { "current": { "type": "integer" }, "size": { "type": "integer" }, "total": { "type": "integer" } } }, "count": { "type": "integer", "description": "반환한 결과 수입니다." }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "id": { "type": "string", "description": "장소 식별자입니다." }, "name": { "type": "string", "description": "장소 이름입니다." }, "category": { "type": "object", "properties": { "full": { "type": "string", "description": "분류 전체 표기입니다." }, "large": { "type": "string", "description": "대분류입니다." }, "middle": { "type": "string", "description": "중분류입니다." }, "small": { "type": "string", "description": "소분류입니다." } } }, "address": { "type": "object", "properties": { "road": { "type": "string", "description": "도로명 주소입니다." }, "parcel": { "type": "string", "description": "지번 주소입니다." } } }, "point": { "type": "object", "properties": { "x": { "type": "number", "description": "경도입니다." }, "y": { "type": "number", "description": "위도입니다." }, "crs": { "type": "string" } } }, "distanceM": { "type": "number", "description": "기준점과의 거리(m)입니다. 기준점이 있을 때만 있습니다." }, "bearing": { "type": "number", "description": "기준점에서 본 방위(도, 북쪽 0·동쪽 90)입니다." } } } }, "error": { "type": "string", "description": "실패 사유입니다. 이 필드가 있으면 과금되지 않습니다." } } }, "api": { "type": "object", "properties": { "cost": { "type": "integer", "description": "차감된 포인트입니다. 실패한 응답은 0입니다." }, "success": { "type": "boolean" }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." } } } } } ``` ### 정적 응답 예시 ```json { "data": { "query": "강남역", "origin": { "x": 127.0249287, "y": 37.5044445, "crs": "EPSG:4326" }, "radius": 1000, "page": { "current": 1, "size": 5, "total": 196 }, "count": 1, "items": [ { "index": 0, "id": "POI01000000HD5DLT", "name": "강남역", "category": { "full": "철도시설 > 철도/지하철 > 지하철역", "large": "철도시설", "middle": "철도/지하철", "small": "지하철역" }, "address": { "road": "", "parcel": "서울특별시 강남구 역삼동 858" }, "point": { "x": 127.0277694, "y": 37.4977446, "crs": "EPSG:4326" }, "distanceM": 770.2, "bearing": 152.4 } ] }, "api": { "cost": 20, "success": true, "ms": 45 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/geo_place_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=강남역' \ --form-string 'origin=127.0249287,37.5044445' \ --form-string 'radius=1000' \ --form-string 'size=5' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("query", "강남역"); form.append("origin", "127.0249287,37.5044445"); form.append("radius", "1000"); form.append("size", "5"); const response = await fetch("https://apick.app/rest/geo_place_search", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("query", (None, "강남역")), ("origin", (None, "127.0249287,37.5044445")), ("radius", (None, "1000")), ("size", (None, "5")), ] response = requests.request("POST", "https://apick.app/rest/geo_place_search", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '강남역', 'origin' => '127.0249287,37.5044445', 'radius' => '1000', 'size' => '5', ]; $curl = curl_init('https://apick.app/rest/geo_place_search'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 현재 위치 주변 장소를 가까운 순으로 기준점에서 1km 안의 장소를 가까운 순으로 받습니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_place_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=약국' \ --form-string 'origin=127.0249287,37.5044445' \ --form-string 'radius=1000' \ --form-string 'size=20' ``` - `data.items[].distanceM`(m)과 `bearing`(방위)을 함께 보여 줍니다. - 반경 안에 장소가 없으면 `data.error`로 실패하며 과금되지 않습니다. ## 사용 예시 2. 기준점 없이 장소 검색 장소명만으로 위치·분류를 찾을 때는 기준점을 빼고 보냅니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_place_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=서울역' ``` - `data.items[].category.large`·`middle`·`small`로 분류를 확인합니다. 기준점이 없으면 `distanceM`이 없습니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 이용 전 확인 성공한 요청 한 건당 20P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다. 기준점(origin 또는 x·y)을 보내면 각 결과에 distanceM·bearing이 붙고 가까운 순으로 정렬됩니다. 기준점이 없으면 검색 관련도 순입니다.radius는 이번 페이지 결과 중 기준점에서 그 거리 안에 있는 것만 남깁니다. 검색 범위 자체를 넓히지는 않으므로, 결과가 적으면 검색어에 지역명을 넣거나 page를 넘겨 더 찾으세요.조건에 맞는 장소가 하나도 없으면 실패로 끝나며 과금되지 않습니다. 좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/geo_place_search 인증 헤더Authorization: Bearer — 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 data.originobject적용한 기준점입니다. 없으면 null 입니다.data.countinteger반환한 결과 수입니다.data.items[].idstring장소 식별자입니다.data.items[].namestring장소 이름입니다.data.items[].category.fullstring분류 전체 표기입니다.data.items[].category.largestring대분류입니다.data.items[].category.middlestring중분류입니다.data.items[].category.smallstring소분류입니다.data.items[].address.roadstring도로명 주소입니다.data.items[].address.parcelstring지번 주소입니다.data.items[].point.xnumber경도입니다.data.items[].point.ynumber위도입니다.data.items[].distanceMnumber기준점과의 거리(m)입니다. 기준점이 있을 때만 있습니다.data.items[].bearingnumber기준점에서 본 방위(도, 북쪽 0·동쪽 90)입니다. data.errorstring실패 사유입니다. 이 필드가 있으면 과금되지 않습니다. api.costinteger차감된 포인트입니다. 실패한 응답은 0입니다. api.msinteger처리 시간(밀리초)입니다. { "data": { "query": "강남역", "origin": { "x": 127.0249287, "y": 37.5044445, "crs": "EPSG:4326" }, "radius": 1000, "page": { "current": 1, "size": 5, "total": 196 }, "count": 1, "items": [ { "index": 0, "id": "POI01000000HD5DLT", "name": "강남역", "category": { "full": "철도시설 > 철도/지하철 > 지하철역", "large": "철도시설", "middle": "철도/지하철", "small": "지하철역" }, "address": { "road": "", "parcel": "서울특별시 강남구 역삼동 858" }, "point": { "x": 127.0277694, "y": 37.4977446, "crs": "EPSG:4326" }, "distanceM": 770.2, "bearing": 152.4 } ] }, "api": { "cost": 20, "success": true, "ms": 45 } } ## 상세 코드·정책 오류 코드 상황data.error 예대처 입력 누락·형식 오류검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다. 개수·길이 초과주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …표의 최대값 안으로 줄이거나 나눠서 요청합니다. 위치를 찾지 못함입력한 위치를 찾지 못했습니다.주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다. 처리 시간 초과처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다. 일시적 실패공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.