개발가이드공간정보주변 생활시설 분석

주변 생활시설 분석 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

기준 주소·좌표 반경 안의 편의점·지하철역·학교·병원·약국 등을 분류별로 찾아 가까운 순서와 평균 거리로 요약합니다. 상권·입지 후보를 빠르게 비교할 때 씁니다.

POSThttps://apick.app/rest/geo_neighborhood
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개

알아둘 점

이용 전 확인

성공한 요청 한 건당 40P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다.

categories를 생략하면 편의점·지하철역·학교·병원·약국 5개 분류를 봅니다. 분류 이름은 자유롭게 넣을 수 있습니다(예: 카페, 어린이집, 주차장).

분류별 count는 분류마다 가까운 후보 최대 20곳 안에서 반경 안에 든 수입니다. 밀집 지역의 전체 시설 수가 아니라 입지 비교용 지표로 쓰세요.

반경 안에서 시설을 하나도 찾지 못하면 실패로 끝나며 과금되지 않습니다. 반경을 넓히거나 분류를 바꿔 다시 요청하세요.

좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다.

요청과 응답

API 요청
POST/rest/geo_neighborhood
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 8개
파라미터
설명
addressstring조건부
기준 주소. 좌표와 둘 중 하나는 필요합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
예시
서울특별시 강남구 역삼동 808
xnumber조건부
기준점 경도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
ynumber조건부
기준점 위도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
pointstring조건부
기준점 "경도,위도" 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
radiusnumber선택
반경(m). 기본 500 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
범위
100 ~ 2000
예시
800
categoriesarray선택
분류 이름 목록 (최대 6개). 생략하면 편의점·지하철역·학교·병원·약국
limitinteger선택
분류별 가까운 시설 수 (기본 5, 최대 10) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
범위
1 ~ 10
addrTypestring선택
auto(기본)·parcel(지번)·road(도로명) 중 하나입니다. auto 는 지번·도로명을 알아서 판단합니다. jibun·지번·도로명 표기도 받습니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다.
응답 필드 22개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.centerobject
'center' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.labelstring
기준점의 동네 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.radiusinteger
적용한 반경(m)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summaryobject
공고의 짧은 요약입니다. 본문 전체는 description_html에서 확인하세요.
data.categoriesarray
상품 카테고리 목록입니다. 카테고리 이름과 페이지 주소가 들어 있습니다.
data.errorstring
오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
하위 필드 11개 더 보기
응답 필드
설명
data.center.xnumber
기준점 경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.center.ynumber
기준점 위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.center.crsstring
'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.summary.categoriesinteger
분석한 분류 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summary.totalinteger
상태 집계 대상 택배사의 전체 수입니다. 조회 가능·점검 중인 수를 합한 값과 일치합니다.
data.summary.partialboolean
시간 초과로 일부 분류를 분석하지 못했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.categories[].namestring
상품이 속한 카테고리 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.categories[].countinteger
반경 안 시설 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.categories[].nearestarray
가까운 시설 목록(이름·분류·주소·좌표·거리)입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.
data.categories[].nearest[].distanceMnumber
기준점과의 거리(m)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.categories[].averageDistanceMnumber
반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. null 허용.
입력 조건·전송 규칙
항목
설정
메서드·주소
POST https://apick.app/rest/geo_neighborhood
인증 헤더
Authorization: Bearer — 내 계정의 API 인증키
본문 형식
multipart/form-data
요청 예시

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 입지 후보 주변 시설 비교

후보 주소 반경 800m 안의 편의점·지하철역·약국을 분류별로 셉니다.

요청POST/rest/geo_neighborhood
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. 좌표 기준 기본 분류 분석

좌표만 있을 때 분류를 생략하면 편의점·지하철역·학교·병원·약국을 봅니다.

요청POST/rest/geo_neighborhood
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로 실패하며 과금되지 않습니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

{
  "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.center.x
number
기준점 경도입니다.
data.center.y
number
기준점 위도입니다.
data.label
string
기준점의 동네 이름입니다.
data.radius
number
적용한 반경(m)입니다.
data.summary.categories
integer
분석한 분류 수입니다.
data.summary.total
integer
반경 안에서 찾은 시설 수의 합입니다.
data.summary.partial
boolean
시간 초과로 일부 분류를 분석하지 못했으면 true 입니다.
data.categories[].name
string
분류 이름입니다.
data.categories[].count
integer
반경 안 시설 수입니다.
data.categories[].nearest[]
array
가까운 시설 목록(이름·분류·주소·좌표·거리)입니다.
data.categories[].nearest[].distanceM
number
기준점과의 거리(m)입니다.
data.categories[].averageDistanceM
number
반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다.
data.error
string
실패 사유입니다. 이 필드가 있으면 과금되지 않습니다.
api.cost
integer
차감된 포인트입니다. 실패한 응답은 0입니다.
api.ms
integer
처리 시간(밀리초)입니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
서비스 코드·조건

오류 코드

상황
data.error 예
대처
입력 누락·형식 오류
검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …
문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다.
개수·길이 초과
주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …
표의 최대값 안으로 줄이거나 나눠서 요청합니다.
위치를 찾지 못함
입력한 위치를 찾지 못했습니다.
주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다.
처리 시간 초과
처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.
목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다.
일시적 실패
공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.
잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
무료 포인트로 사용할 수 없는 서비스입니다.
200
최소 1회 결제 후 이용할 수 있습니다. result.error 전체 문구를 그대로 표시하세요.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 40P · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.