# 주변 생활시설 분석 기준 주소·좌표 반경 안의 편의점·지하철역·학교·병원·약국 등을 분류별로 찾아 가까운 순서와 평균 거리로 요약합니다. 상권·입지 후보를 빠르게 비교할 때 씁니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/geo_neighborhood 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.center` (object): 'center' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.center.x` (number): 기준점 경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.center.y` (number): 기준점 위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.center.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.label` (string): 기준점의 동네 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.radius` (integer): 적용한 반경(m)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.summary` (object): 공고의 짧은 요약입니다. 본문 전체는 description_html에서 확인하세요. - `data.summary.categories` (integer): 분석한 분류 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.summary.total` (integer): 상태 집계 대상 택배사의 전체 수입니다. 조회 가능·점검 중인 수를 합한 값과 일치합니다. - `data.summary.partial` (boolean): 시간 초과로 일부 분류를 분석하지 못했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.categories` (array): 상품 카테고리 목록입니다. 카테고리 이름과 페이지 주소가 들어 있습니다. - `data.categories[].name` (string): 상품이 속한 카테고리 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.categories[].count` (integer): 반경 안 시설 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.categories[].nearest` (array): 가까운 시설 목록(이름·분류·주소·좌표·거리)입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.categories[].nearest[].distanceM` (number): 기준점과의 거리(m)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.categories[].averageDistanceM` (number): 반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. null 허용. - `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_neighborhood ### 입력 - `address` (string, 조건부): 기준 주소. 좌표와 둘 중 하나는 필요합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `x` (number, 조건부): 기준점 경도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `y` (number, 조건부): 기준점 위도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `point` (string, 조건부): 기준점 "경도,위도" 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `radius` (number, 선택): 반경(m). 기본 500 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `categories` (array, 선택): 분류 이름 목록 (최대 6개). 생략하면 편의점·지하철역·학교·병원·약국 - `limit` (integer, 선택): 분류별 가까운 시설 수 (기본 5, 최대 10) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `addrType` (string, 선택): auto(기본)·parcel(지번)·road(도로명) 중 하나입니다. auto 는 지번·도로명을 알아서 판단합니다. jibun·지번·도로명 표기도 받습니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "center": { "type": "object", "properties": { "x": { "type": "number", "description": "기준점 경도입니다." }, "y": { "type": "number", "description": "기준점 위도입니다." }, "crs": { "type": "string" } } }, "label": { "type": "string", "description": "기준점의 동네 이름입니다." }, "radius": { "type": "integer", "description": "적용한 반경(m)입니다." }, "summary": { "type": "object", "properties": { "categories": { "type": "integer", "description": "분석한 분류 수입니다." }, "total": { "type": "integer", "description": "반경 안에서 찾은 시설 수의 합입니다." }, "partial": { "type": "boolean", "description": "시간 초과로 일부 분류를 분석하지 못했으면 true 입니다." } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "분류 이름입니다." }, "count": { "type": "integer", "description": "반경 안 시설 수입니다." }, "nearest": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "address": { "type": "string" }, "point": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "crs": { "type": "string" } } }, "distanceM": { "type": "number" } } }, {} ], "type": "object", "properties": { "distanceM": { "type": "number", "description": "기준점과의 거리(m)입니다." } } }, "description": "가까운 시설 목록(이름·분류·주소·좌표·거리)입니다." }, "averageDistanceM": { "type": "number", "description": "반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다.", "nullable": true } } } }, "error": { "type": "string", "description": "실패 사유입니다. 이 필드가 있으면 과금되지 않습니다." } } }, "api": { "type": "object", "properties": { "cost": { "type": "integer", "description": "차감된 포인트입니다. 실패한 응답은 0입니다." }, "success": { "type": "boolean" }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." } } } } } ``` ### 정적 응답 예시 ```json { "data": { "center": { "x": 127.0250516, "y": 37.5043681, "crs": "EPSG:4326" }, "label": "역삼동", "radius": 800, "summary": { "categories": 3, "total": 14, "partial": false }, "categories": [ { "name": "편의점", "count": 6, "nearest": [ { "name": "예시편의점 역삼점", "category": "상업시설 > 편의점", "address": "서울특별시 강남구 테헤란로 152", "point": { "x": 127.0253, "y": 37.5046, "crs": "EPSG:4326" }, "distanceM": 32.1 } ], "averageDistanceM": 210.4 }, { "name": "지하철역", "count": 2, "nearest": [], "averageDistanceM": 640.2 }, { "name": "약국", "count": 6, "nearest": [], "averageDistanceM": 180.9 } ] }, "api": { "cost": 40, "success": true, "ms": 620 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/geo_neighborhood' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'address=서울특별시 강남구 역삼동 808' \ --form-string 'radius=800' \ --form-string 'categories[0]=편의점' \ --form-string 'categories[1]=지하철역' \ --form-string 'categories[2]=약국' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("address", "서울특별시 강남구 역삼동 808"); form.append("radius", "800"); form.append("categories[0]", "편의점"); form.append("categories[1]", "지하철역"); form.append("categories[2]", "약국"); const response = await fetch("https://apick.app/rest/geo_neighborhood", { 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 = [ ("address", (None, "서울특별시 강남구 역삼동 808")), ("radius", (None, "800")), ("categories[0]", (None, "편의점")), ("categories[1]", (None, "지하철역")), ("categories[2]", (None, "약국")), ] response = requests.request("POST", "https://apick.app/rest/geo_neighborhood", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '서울특별시 강남구 역삼동 808', 'radius' => '800', 'categories[0]' => '편의점', 'categories[1]' => '지하철역', 'categories[2]' => '약국', ]; $curl = curl_init('https://apick.app/rest/geo_neighborhood'); 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. 입지 후보 주변 시설 비교 후보 주소 반경 800m 안의 편의점·지하철역·약국을 분류별로 셉니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_neighborhood' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'categories[0]=편의점' \ --form-string 'categories[1]=지하철역' \ --form-string 'categories[2]=약국' \ --form-string 'address=서울특별시 강남구 역삼동 808' \ --form-string 'radius=800' ``` - `data.categories[].count`와 `averageDistanceM`을 후보지끼리 비교합니다. - `data.categories[].nearest[]`로 가장 가까운 시설 이름과 거리를 보여 줍니다. ## 사용 예시 2. 좌표 기준 기본 분류 분석 좌표만 있을 때 분류를 생략하면 편의점·지하철역·학교·병원·약국을 봅니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_neighborhood' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'x=127.0283226' \ --form-string 'y=37.4981701' \ --form-string 'radius=500' \ --form-string 'limit=3' ``` - `data.summary.partial`이 true이면 일부 분류를 분석하지 못했으니 분류 수를 줄여 다시 요청합니다. - 반경 안에서 시설을 찾지 못하면 `data.error`로 실패하며 과금되지 않습니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 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 } } ``` ## 상세 기능·요금 이용 전 확인 성공한 요청 한 건당 40P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다. categories를 생략하면 편의점·지하철역·학교·병원·약국 5개 분류를 봅니다. 분류 이름은 자유롭게 넣을 수 있습니다(예: 카페, 어린이집, 주차장).분류별 count는 분류마다 가까운 후보 최대 20곳 안에서 반경 안에 든 수입니다. 밀집 지역의 전체 시설 수가 아니라 입지 비교용 지표로 쓰세요.반경 안에서 시설을 하나도 찾지 못하면 실패로 끝나며 과금되지 않습니다. 반경을 넓히거나 분류를 바꿔 다시 요청하세요. 좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/geo_neighborhood 인증 헤더Authorization: Bearer — 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 data.center.xnumber기준점 경도입니다.data.center.ynumber기준점 위도입니다.data.labelstring기준점의 동네 이름입니다.data.radiusnumber적용한 반경(m)입니다.data.summary.categoriesinteger분석한 분류 수입니다.data.summary.totalinteger반경 안에서 찾은 시설 수의 합입니다.data.summary.partialboolean시간 초과로 일부 분류를 분석하지 못했으면 true 입니다.data.categories[].namestring분류 이름입니다.data.categories[].countinteger반경 안 시설 수입니다.data.categories[].nearest[]array가까운 시설 목록(이름·분류·주소·좌표·거리)입니다.data.categories[].nearest[].distanceMnumber기준점과의 거리(m)입니다.data.categories[].averageDistanceMnumber반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다. data.errorstring실패 사유입니다. 이 필드가 있으면 과금되지 않습니다. api.costinteger차감된 포인트입니다. 실패한 응답은 0입니다. api.msinteger처리 시간(밀리초)입니다. { "data": { "center": { "x": 127.0250516, "y": 37.5043681, "crs": "EPSG:4326" }, "label": "역삼동", "radius": 800, "summary": { "categories": 3, "total": 14, "partial": false }, "categories": [ { "name": "편의점", "count": 6, "nearest": [ { "name": "예시편의점 역삼점", "category": "상업시설 > 편의점", "address": "서울특별시 강남구 테헤란로 152", "point": { "x": 127.0253, "y": 37.5046, "crs": "EPSG:4326" }, "distanceM": 32.1 } ], "averageDistanceM": 210.4 }, { "name": "지하철역", "count": 2, "nearest": [], "averageDistanceM": 640.2 }, { "name": "약국", "count": 6, "nearest": [], "averageDistanceM": 180.9 } ] }, "api": { "cost": 40, "success": true, "ms": 620 } } ## 상세 코드·정책 오류 코드 상황data.error 예대처 입력 누락·형식 오류검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다. 개수·길이 초과주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …표의 최대값 안으로 줄이거나 나눠서 요청합니다. 위치를 찾지 못함입력한 위치를 찾지 못했습니다.주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다. 처리 시간 초과처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다. 일시적 실패공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.