{
"operationId": "getNearbyCategorySearchesResult",
"method": "GET",
"path": "/maps/v3.0/appkeys/{APPKEY}/nearby-category-searches",
"category": "search-place",
"tags": [
"장소/주소 검색"
],
"summary": "주변 카테고리 검색",
"description": "중심 좌표와 반경을 기준으로 한 반경 검색과, 좌상단(x1,y1) 및 우하단(x2,y2) 좌표로 지정한 사각형 영역 내에서 검색하는 공간 검색을 지원합니다
지정한 범위와 카테고리 코드에 해당하는 관심지점(POI)을 조회합니다",
"deprecated": false,
"parameters": [
{
"name": "APPKEY",
"in": "path",
"description": "해당 API 사용 권한이 있는 API 키",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "catecode",
"in": "query",
"description": "검색 대상 카테고리 코드",
"required": true,
"schema": {
"type": "string",
"description": "검색 대상 카테고리 코드",
"example": 130602
},
"example": 130602
},
{
"name": "spopt",
"in": "query",
"description": "공간 검색 옵션",
"required": true,
"schema": {
"maximum": 2,
"minimum": 1,
"type": "string",
"description": "공간 검색 옵션",
"example": 1,
"enum": [
"1",
"2"
],
"x-enum-descriptions": {
"1": "공간 검색",
"2": "반경 검색"
}
},
"example": 1,
"x-enum-descriptions": {
"1": "공간 검색",
"2": "반경 검색"
}
},
{
"name": "x1",
"in": "query",
"description": "X1 좌표값
*전체 검색인 경우 기준점 X좌표(경도)
*공간 검색인 경우 Extent 좌상단 X좌표(경도)
*반경 검색인 경우 중심 X좌표(경도)",
"required": true,
"schema": {
"type": "string",
"description": "X1 좌표값
*전체 검색인 경우 기준점 X좌표(경도)
*공간 검색인 경우 Extent 좌상단 X좌표(경도)
*반경 검색인 경우 중심 X좌표(경도)",
"example": 127.11075
},
"example": 127.11075
},
{
"name": "y1",
"in": "query",
"description": "Y1 좌표값
*전체 검색인 경우 기준점 Y좌표(위도)
*공간 검색인 경우 Extent 좌상단 Y좌표(위도)
*반경 검색인 경우 중심 Y좌표(위도)",
"required": true,
"schema": {
"type": "string",
"description": "Y1 좌표값
*전체 검색인 경우 기준점 Y좌표(위도)
*공간 검색인 경우 Extent 좌상단 Y좌표(위도)
*반경 검색인 경우 중심 Y좌표(위도)",
"example": 37.402159
},
"example": 37.402159
},
{
"name": "x2",
"in": "query",
"description": "X2 좌표값
*공간 검색인 경우 Extent 우하단 X좌표(경도)",
"required": false,
"schema": {
"type": "string",
"description": "X2 좌표값
*공간 검색인 경우 Extent 우하단 X좌표(경도)"
}
},
{
"name": "y2",
"in": "query",
"description": "Y2 좌표값
*공간 검색인 경우 Extent 우하단 Y좌표(위도)",
"required": false,
"schema": {
"type": "string",
"description": "Y2 좌표값
*공간 검색인 경우 Extent 우하단 Y좌표(위도)"
}
},
{
"name": "coordtype",
"in": "query",
"description": "좌표 체계",
"required": false,
"schema": {
"maximum": 1,
"minimum": 0,
"type": "string",
"description": "좌표 체계",
"default": "1",
"enum": [
"0",
"1"
],
"x-enum-descriptions": {
"0": "TW 좌표",
"1": "WGS84 좌표"
}
},
"x-enum-descriptions": {
"0": "TW 좌표",
"1": "WGS84 좌표"
}
},
{
"name": "startposition",
"in": "query",
"description": "검색 시작 위치
*0은 첫 번째 위치를 의미",
"required": false,
"schema": {
"type": "string",
"description": "검색 시작 위치
*0은 첫 번째 위치를 의미",
"default": "0"
}
},
{
"name": "reqcount",
"in": "query",
"description": "요청 개수
*0~9999",
"required": false,
"schema": {
"maximum": 9999,
"minimum": 0,
"type": "string",
"description": "요청 개수
*0~9999",
"default": "100"
}
},
{
"name": "sortopt",
"in": "query",
"description": "검색 결과 정렬 옵션",
"required": false,
"schema": {
"maximum": 2,
"minimum": 1,
"type": "string",
"description": "검색 결과 정렬 옵션",
"default": "1",
"enum": [
"1",
"2"
],
"x-enum-descriptions": {
"1": "거리순",
"2": "명칭순"
}
},
"x-enum-descriptions": {
"1": "거리순",
"2": "명칭순"
}
},
{
"name": "radius",
"in": "query",
"description": "검색 반경(m)
*반경 검색일 경우 사용",
"required": false,
"schema": {
"type": "string",
"description": "검색 반경(m)
*반경 검색일 경우 사용"
}
},
{
"name": "depth",
"in": "query",
"description": "하위 시설물 포함 수준",
"required": false,
"schema": {
"maximum": 3,
"minimum": 0,
"type": "string",
"description": "하위 시설물 포함 수준",
"default": "0",
"enum": [
"0",
"1",
"2",
"3"
],
"x-enum-descriptions": {
"0": "사용 안함",
"1": "일반 시설물 포함",
"2": "하위 시설물 포함",
"3": "최하위 시설물 포함"
}
},
"x-enum-descriptions": {
"0": "사용 안함",
"1": "일반 시설물 포함",
"2": "하위 시설물 포함",
"3": "최하위 시설물 포함"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"isSuccessful": {
"type": "boolean",
"description": "API 요청 성공 여부",
"example": true
},
"resultCode": {
"type": "integer",
"description": "API 응답 결과 코드",
"format": "int32",
"example": 0
},
"resultMessage": {
"type": "string",
"description": "API 응답 결과 문구",
"example": "Success"
}
},
"description": "API 응답 결과"
},
"cate": {
"type": "object",
"properties": {
"result": {
"type": "boolean",
"description": "검색 결과 성공 여부",
"example": true
},
"totalcount": {
"type": "integer",
"description": "총 검색 결과 개수",
"format": "int32",
"example": 192
},
"count": {
"type": "integer",
"description": "총 응답 결과 개수",
"format": "int32",
"example": 102
},
"poi": {
"type": "array",
"description": "POI 검색 결과 목록(배열)",
"items": {
"type": "object",
"properties": {
"poiid": {
"type": "integer",
"description": "POI 고유 ID",
"format": "int32",
"example": 8827198
},
"depth": {
"type": "string",
"description": "계층 정보",
"example": "0",
"x-enum-descriptions": {
"0": "일반 시설물",
"1": "하위 시설물",
"2": "최하위 시설물"
}
},
"dpx": {
"type": "string",
"description": "지도 표출용 X좌표(경도)",
"example": "127.110762"
},
"dpy": {
"type": "string",
"description": "지도 표출용 Y좌표(위도)",
"example": "37.402184"
},
"rpx": {
"type": "string",
"description": "차량 진입로 X좌표(경도)",
"example": "127.110862"
},
"rpy": {
"type": "string",
"description": "차량 진입로 Y좌표(위도)",
"example": "37.402334"
},
"routepoints": {
"type": "array",
"description": "차량 진입로 좌표 정보 목록(배열)
>*차량 경로 탐색 시 사용 가능",
"items": {
"type": "object",
"properties": {
"rpx": {
"type": "string",
"description": "차량 진입로 X좌표(경도)",
"example": "127.110862"
},
"rpy": {
"type": "string",
"description": "차량 진입로 Y좌표(위도)",
"example": "37.402334"
}
},
"description": "차량 진입로 좌표 정보 목록(배열)
>*차량 경로 탐색 시 사용 가능"
}
},
"entrypoint": {
"type": "object",
"properties": {
"px": {
"type": "string",
"description": "진입 지점의 X좌표(경도)",
"example": "127.109987"
},
"py": {
"type": "string",
"description": "진입 지점의 Y좌표(위도)",
"example": "37.401942"
}
},
"description": "진입 지점 정보"
},
"name1": {
"type": "string",
"description": "대표 명칭",
"example": "아이나비시스템즈"
},
"name2": {
"type": "string",
"description": "축약 명칭"
},
"name3": {
"type": "string",
"description": "확장 명칭1"
},
"name4": {
"type": "string",
"description": "확장 명칭2"
},
"admcode": {
"type": "string",
"description": "행정구역 코드(법정동/행정동)
*법정동 검색 → 법정동 코드
*행정동 검색 → 행정동 코드",
"example": "4113510900"
},
"haengcode": {
"type": "string",
"description": "행정동 코드",
"example": "4113565500"
},
"address": {
"type": "string",
"description": "전체 주소",
"example": "경기도 성남시 분당구 삼평동"
},
"address_haeng": {
"type": "string",
"description": "행정동 기준 주소",
"example": "삼평동"
},
"jibun": {
"type": "string",
"description": "지번 주소",
"example": "678"
},
"roadname": {
"type": "string",
"description": "도로명주소",
"example": "경기도 성남시 분당구 판교역로"
},
"roadjibun": {
"type": "string",
"description": "건물 번호",
"example": "240"
},
"detailaddress": {
"type": "string",
"description": "상세 주소 정보",
"example": "삼환하이펙스 A동 8층"
},
"catecode": {
"type": "string",
"description": "카테고리 코드",
"example": "130602"
},
"catename": {
"type": "string",
"description": "카테고리 명칭",
"example": "팅크웨어"
},
"dp_catecode": {
"type": "string",
"description": "전시용 카테고리 코드",
"example": "000"
},
"distance": {
"type": "integer",
"description": "기준 좌표와의 거리(m)",
"format": "int32",
"example": 21713
},
"tel": {
"type": "string",
"description": "대표 전화번호",
"example": "02-589-9610"
},
"hasoildata": {
"type": "boolean",
"description": "주유소 유가 정보 보유 여부"
},
"hasdetailinfo": {
"type": "boolean",
"description": "상세 정보 보유 여부"
},
"hassubpoi": {
"type": "boolean",
"description": "하위 POI 존재 여부"
},
"islandmark": {
"type": "boolean",
"description": "랜드마크 여부"
},
"updateTS": {
"type": "string",
"description": "데이터의 최종 갱신 시각",
"example": "2023-08-17"
},
"subpoi": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "하위 POI 개수",
"format": "int32",
"example": 2
},
"poi": {
"type": "array",
"description": "하위 POI 정보",
"items": "[Circular Reference]"
}
},
"description": "하위 POI 정보"
},
"externallink": {
"type": "array",
"description": "연동 Site 정보 목록(배열)",
"items": {
"type": "object",
"properties": {
"Site": {
"type": "string",
"description": "연동 Site"
},
"ID": {
"type": "string",
"description": "연동 ID"
},
"ExtraInfo1": {
"type": "string",
"description": "추가정보1"
},
"ExtraInfo2": {
"type": "string",
"description": "추가정보2"
}
},
"description": "연동 Site 정보 목록(배열)"
}
},
"popularity": {
"type": "boolean",
"description": "인기 여부"
},
"pop_tv": {
"type": "boolean",
"description": "TV 기반 인기 여부"
},
"pop_sns": {
"type": "boolean",
"description": "SNS 기반 인기 여부"
},
"pop_hot": {
"type": "boolean",
"description": "HOT 인기 여부"
},
"pop_hit": {
"type": "boolean",
"description": "HIT 인기 여부"
},
"pop_top": {
"type": "string",
"description": "TOP 인기 단계",
"example": "경기_1,분당구_1"
}
},
"description": "POI 검색 결과 목록(배열)"
}
}
},
"description": "주변 카테고리 검색 결과"
}
},
"description": "주변 카테고리 검색 API의 전체 응답"
}
}
}
},
"400": {
"description": "잘못된 요청",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": "[Circular Reference]"
},
"description": "API 응답 결과의 상태"
}
}
}
},
"404": {
"description": "API 없음",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": "[Circular Reference]"
},
"description": "API 응답 결과의 상태"
}
}
}
},
"415": {
"description": "허용되지 않는 메서드",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": "[Circular Reference]"
},
"description": "API 응답 결과의 상태"
}
}
}
},
"500": {
"description": "서버 내부 오류",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"header": "[Circular Reference]"
},
"description": "API 응답 결과의 상태"
}
}
}
}
},
"baseUrl": "https://imaps.inavi.com"
}