기준 주소. 좌표와 둘 중 하나는 필요합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
예시
서울특별시 강남구 역삼동 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 허용.