Thinkware API Center

주소검색(주소->좌표)

주소로 좌표를 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/coordinates?query={query}&coordtype={coordtype}&startposition={startposition}&reqcount={reqcount}&admcode={admcode}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
query	String	O	검색어
coordtype	String	X	좌표형식 0 : TW 좌표 1 : WGS84 좌표 2 : TM 좌표
startposition	String	X	검색 시작 위치 0 : 첫번째 위치 미입력 시 0으로 조회
reqcount	String	X	검색 요청 개수 0으로 설정시 Max Count 반환
admcode	String	X	행정코드

Response Json

값			타입	설명
header (Object)	isSuccessful		Boolean	성공여부
	resultCode		Integer	실패 코드
	resultMessage		String	실패 메시지
address (Object)	result		Boolean	성공여부
	totalcount		Integer	전체 검색결과 대상 개수
	res_type		String	검색결과Type명칭 명칭, 카테고리, 주소, 전화번호 순 (ex) NYNN: 명칭 No, 카테고리 YES, 주소 NO, 전화번호 NO
	adm (Array)	type	String	검색 type 1 : 행정계 검색 2 : 지번 검색 3 : 새주소 검색
		posx	String	X좌표
		posy	String	Y좌표
		admcode	String	행정코드
		address	String	주소
		roadname	String	새주소 도로명
		roadjibun	String	새주소 지번
		accuracy	Integer	지번 정확도 0 : 정확 검색 1 : 호지번 확장 2 : 모지번 확장

좌표검색(좌표->주소)

좌표로 주소를 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/addresses?query={query}&posX={posX}&posY={posY}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
posX	String	O	X좌표
posY	String	O	Y좌표
coordtype	String	X	좌표형식 0 : TW 좌표 1 : WGS84 좌표 미입력 시 TW 좌표로 조회

Response Json

값			타입	설명
header (Object)	isSuccessful		Boolean	성공여부
	resultCode		Integer	실패 코드
	resultMessage		String	실패 메시지
location (Object)	result		Boolean	성공여부
	adm (Object)	posx	String	X좌표
		posy	String	Y좌표
		admcode	String	행정코드
		address	String	주소
		jibun	String	지번
		roadname	String	새주소 도로명
		roadjibun	String	새주소 지번
		accuracy	Integer	지번 정확도 0 : 정확 검색 1 : 호지번 확장 2 : 모지번 확장

통합검색

Tel, Address, POI 를 통합적으로 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/searches&query={query}&coordtype&startposition={startposition}&reqcount={reqcount}&spopt={spopt}&radius={radius}&admcode={admcode}&depth={depth}&x1={x1}&y1={y1}&x2={x2}&y2={y2}&sortopt={sortopt}&catecode={catecode}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
query	String	O	검색어
coordtype	String	X	좌표형식 0 : TW 좌표 1 : WGS84 좌표 2 : TM 좌표
startposition	String	X	검색 시작 위치 0 : 첫번째 위치 미입력 시 0으로 조회
reqcount	String	X	검색 요청 개수 0으로 설정시 Max Count 반환
spopt	String	X	공간검색 option 0 : 공간검색 사용 안함 1 : Extent 검색 2 : Range 검색 *spopt값이 설정되지 않은 경우 0으로 설정
radius	String	X	반경 spopt가 2인 경우 사용 Meter 단위
admcode	String	X	행정코드
depth	String	X	하위시설물 요구 depth 1 : 1 depth 만 요청(최상위 depth) 2 : 2 depth 까지 요청 3 : 3 depth 까지 요청 *depth값이 설정되지 않은 경우 1로 설정
x1	String	X	X1좌표 spopt가 0인 경우 기준점 X좌표 spopt가 1인 경우 Extent의 좌상단 X좌표 spopt가 2인 경우 기준점 X좌표
y1	String	X	Y1좌표 spopt가 0인 경우 기준점 Y좌표 spopt가 1인 경우 Extent의 좌상단 Y좌표 spopt가 2인 경우 기준점 Y좌표
x2	String	X	X2좌표 spopt가 1인 경우 Extent의 우하단 X좌표 spopt가 2인 경우 사용안함
y2	String	X	Y2좌표 spopt가 1인 경우 Extent의 우하단 Y좌표 spopt가 2인 경우 사용안함
sortopt	String	X	정렬option 1 : 명칭순 정렬 2 : 거리순 정렬 (좌표를 입력한 경우) 3 : 이름매치->거리순 정렬(좌표를 입력한 경우) 4 : 검색어 Weight 정렬 (엔진기준) 5 : 검색어 Weight 정렬 + length(엔진기준) 6 : 선호카테고리 우선 정렬[V8.1.5 미지원] 7 : 최신데이터 순 정렬 8 : 검색어 Weight 정렬(Landmark>거리>PoiWeight) + 거리순(좌표를 입력한 경우) *sortopt값이 설정되지 않은 경우 4로설정
catecode	String	X	카테고리 코드 EX) 음식점 : 100000

Response Json

값				타입	설명
header (Object)	isSuccessful			Boolean	성공여부
	resultCode			Integer	실패 코드
	resultMessage			String	실패 메시지
search (Object)	result			Boolean	성공여부
	type			Integer	0 : 일반 검색 1 : Reference 검색
	totalcount			Integer	전체 검색결과 대상 개수
	count			Integer	검색 결과 개수
	poitotalcount			Integer	전체 검색결과 대상 개수(Thinkware POI)
	poicount			Integer	검색 결과 개수(Thinkware POI)
	tel_poitotalcount			Integer	전체 검색결과 대상 개수(Tel POI)
	tel_poicount			Integer	검색 결과 개수(Tel POI)
	ucp_poitotalcount			Integer	전체 검색결과 대상 개수(User POI)
	ucp_poicount			Integer	검색 결과 개수(User POI)
	admtotalcount			Integer	adm 전체 검색결과 대상 개수
	admcount			Integer	adm 검색 결과 개수
	reftotalcount			Integer	ref 전체 검색결과 대상 개수
	refcount			Integer	ref 검색 결과 개수
	recommendedQuery			String	검색결과가 없는 경우 오타보정 결과 제공(NULL가능)
	recommendedCost			Integer	오타보정 결과 Cost(0~10000)
	res_type			String	검색결과Type명칭 명칭, 카테고리, 주소, 전화번호 순 (ex) NYNN: 명칭 No, 카테고리 YES, 주소 NO, 전화번호 NO
	poi (Array)	poiid		Integer	POI ID
		depth		String	POI depth
		dpx		String	display X좌표(WGS84의 경우 longitude)
		dpy		String	display Y좌표(WGS84의 경우 latitude)
		rpx		String	탐색 X좌표(WGS84의 경우 longitude)
		rpy		String	탐색 Y좌표(WGS84의 경우 latitude)
		name1		String	정식명칭
		name2		String	축약명칭
		name4		String	확장명칭2
		admcode		String	행정코드
		address		String	주소
		jibun		String	지번
		roadname		String	새주소 도로명
		roadjibun		String	새주소 지번
		detailaddress		String	상세주소
		catecode		String	분류코드
		catename		String	분류명칭
		dp_catecode		String	DP 분류코드
		distance		Integer	좌표와의 거리(해당시에만)
		tel		String	전화번호
		hasoildata		Boolean	유가 데이터 존재여부
		hasdetailinfo		Boolean	상세정보 존재여부
		hassubpoi		Boolean	하위시설물 존재여부
		adv_count		Integer	광고코드 개수
		islandmark		Boolean	랜드마크 여부
		updateTS		String	최종변경 일시 (Y4-MM-DD HH:mm:ss)포맷
		data_source		String	poi 생성 정보 구분 (Thinkware/Tel/User)
		badgeflag		Boolean	Badge 유무(Not Yet:FALSE, Badged:TRUE)
		userid		String	poi 등록 사용자 ID (UCP인 경우에만)
		imagecount		Integer	poi 이미지 개수
		oildata (Object)	g_price	Integer	휘발유 가격
			hg_price	Integer	고급휘발유 가격
			d_price	Integer	경유 가격
			l_price	Integer	LPG 가격
			updatetime	String	Update 시간
			priceinfo	String	최고,최저 유가 정보 (H:최고L:최저X:해당없음) 휘발유, 고급휘발유, 경유, LPG 순
			wash	Boolean
			fix	Boolean	정비가능여부
			mart	Boolean	매점여부
		AdInfo (Array)	ADCODE	Integer	광고코드.. 1 ~ 99까지 부여가능 (최대99개)
		subpoi (Object)	count	Integer	하위 시설물 개수
		subpoi (Object)	poi	Array	하위시설물 List poi 정보와 동일
	tel			Array	TEL 검색결과 List poi 정보와 동일
	ucp			Array	User POI 검색결과 List poi 정보와 동일
	adm (Array)	type		String	검색 type
		posx		String	X좌표(WGS84의 경우 longitude)
		posy		String	Y좌표(WGS84의 경우 latitude)
admcode		String	행정코드
address		String	주소
jibun		String	지번
roadname		String	새주소 도로명
roadjibun		String	새주소 지번
accuracy		Integer	지번 정확도 0 : 정확 검색 1 : 호지번 확장 2 : 모지번 확장
hasgasstation			Boolean	oilprice 정보 제공 여부
oilprice (Object)		max_g_price		Integer	최고 휘발유 가격
		min_g_price		Integer	최저 휘발유 가격
		avg_g_price		Integer	평균 휘발유 가격
		max_hg_price		Integer	최고 고급 휘발유 가격
		min_hg_price		Integer	최저 고급 휘발유 가격
		avg_hg_price		Integer	평균 고급 휘발유 가격
	max_d_price		Integer	최고 경유 가격
	min_d_price		Integer	최저 경유 가격
	avg_d_price		Integer	평균 경유 가격
	max_l_price		Integer	최고 LPG 가격
	min_l_price		Integer	최저 LPG 가격
	avg_l_price		Integer	평균 LPG 가격

추천어검색

검색어의 추천어를 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/proposers?query={query}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
query	String	O	한글/영문/숫자 50Byte(한글 25자)

Response Json

값			타입	설명
header (Object)	isSuccessful		Boolean	성공여부
	resultCode		Integer	실패 코드
	resultMessage		String	실패 메시지
proposer (Object)	result		Boolean	성공여부
	count		Integer	추천 검색어 개수
	keyword (Array)	keyword	String	추천 검색어
	keyword (Array)	frequency	Integer	조회 빈도

POI 상세 검색

POI들에 대한 상세 정보를 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/pois?poiid={poiid}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
poiid	String	O	POI ID poiid를 구분자","와 함께 입력(복수개 가능 186개까지) ex) poiid=123,234,567

Response Json

값				타입	설명
header (Object)	isSuccessful			Boolean	성공여부
	resultCode			Integer	실패 코드
	resultMessage			String	실패 메시지
poi (Object)	result			Boolean	성공여부
	totalcount			Integer	전체 검색결과 대상 개수
	count			Integer	검색 결과 개수
	poiinfo (Array)	poiid		Integer	POI ID
		dpx		String	display X좌표(WGS84의 경우 longitude)
		dpy		String	display Y좌표(WGS84의 경우 latitude)
		rpx		String	탐색 X좌표(WGS84의 경우 longitude)
		rpy		String	탐색 Y좌표(WGS84의 경우 latitude)
		name1		String	정식명칭
		name2		String	축약명칭
		name4		String	확장명칭2
		admcode		String	행정코드
		address		String	주소
		jibun		String	지번
		roadname		String	새주소 도로명
		roadjibun		String	새주소 지번
		detailaddress		String	상세주소
		catecode		String	분류코드
		catename		String	분류명칭
		fulladdress		String	전체주소(행정주소+지번+상세주소)
		zip		String	우편번호
		homeage		String	홈페이지 url
		email		String	email
		howtogo		String	교통편
		tel1		String	전화번호1
		tel2		String	전화번호2
		fax1		String	팩스번호1
		fax2		String	팩스번호2
		icode		String	ICODE
		detail_count		Integer	분류상세항목갯수
		etc_count		Integer	분류기타항목갯수
		badgeflag		Boolean	Badge 유무(Not Yet:FALSE, Badged:TRUE)
		imagecount		Integer	poi 이미지 개수
		hasoildata		Boolean	유가 데이터 존재 유무
		detailinfo (Array)	name	String	분류상세항목설명
		detailinfo (Array)	value	String	분류상세항목내용
		etcinfo (Array)	name	String	분류기타항목설명
		etcinfo (Array)	value	String	분류기타항목내용
		oildata (Object)	g_price	Integer	휘발유 가격
			hg_price	Integer	고급휘발유 가격
			d_price	Integer	경유 가격
			l_price	Integer	LPG 가격
			updatetime	String	Update 시간
			priceinfo	String	최고,최저 유가 정보 (H:최고L:최저X:해당없음) 휘발유,고급휘발유, 경유, LPG 순
			wash	Boolean	세차시설여부
			fix	Boolean	정비가능여부
			mart	Boolean	매점여부

POI 하위 시설물 검색

해당 POI에 대한 하위 시설물들을 검색

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/sub-pois?poiid={poiid}&x1={x1}&y1={y1}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
poiid	String	O	POI ID 복수개 지원 안됨
x1	String	X	현위치 또는 지도중심좌표. x, y좌표가 모두 NULL또는 0일 경우 거리 계산을 수행하지 않음. 복수개 지원 안됨
y1	String	X	현위치 또는 지도중심좌표. x, y좌표가 모두 NULL또는 0일 경우 거리 계산을 수행하지 않음. 복수개 지원 안됨

Response Json

값				타입	설명
header (Object)	isSuccessful			Boolean	성공여부
	resultCode			Integer	실패 코드
	resultMessage			String	실패 메시지
subpoi (Object)	result			Boolean	성공여부
	totalcount			Integer	전체 검색결과 대상 개수
	count			Integer	검색 결과 개수
	poi (Array)	poiid		Integer	POI ID
		depth		String	poi depth
		dpx		String	display X좌표(WGS84의 경우 longitude)
		dpy		String	display Y좌표(WGS84의 경우 latitude)
		rpx		String	탐색 X좌표(WGS84의 경우 longitude)
		rpy		String	탐색 Y좌표(WGS84의 경우 latitude)
		name1		String	정식명칭
		name2		String	축약명칭
		name3		String	확장명칭1
		name4		String	확장명칭2
		admcode		String	행정코드
		address		String	주소
		jibun		String	지번
		roadname		String	새주소 도로명
		roadjibun		String	새주소 지번
		detailaddress		String	상세주소
		catecode		String	분류코드
		catename		String	분류명칭
		dp_catecode		String	DP 분류코드
		distance		Integer	좌표와의 거리 (해당시에만)
		tel		String	전화번호
		hasoildata		Boolean	유가 데이터 존재 유무
		hasdetailinfo		Boolean	상세정보 존재 유무
		hassubpoi		Boolean	하위시설물 존재 유무
		adv_count		Integer	광고코드 개수
		islandmark		Boolean	랜드마크 여부
		updateTS		String	최종변경 일시(Y4-MM-DD HH:mm:ss)포맷
		data_source		String	poi 생성 정보 구분 (Thinkware/Tel/User)
		badgeflag		Boolean	Badge 유무(Not Yet:FALSE, Badged:TRUE)
		userid		String	poi 등록 사용자 ID (UCP인 경우에만)
		imagecount		Integer	poi 이미지 개수
		oildata (Object)	g_price	Integer	휘발유 가격
			hg_price	Integer	고급휘발유 가격
			d_price	Integer	경유 가격
			l_price	Integer	LPG 가격
			updatetime	String	Update 시간
			priceinfo	String	최고,최저 유가 정보 (H:최고L:최저X:해당없음) 휘발유,고급휘발유, 경유, LPG 순
			wash	Boolean	세차시설여부
			fix	Boolean	정비가능여부
			mart	Boolean	매점여부
		AdInfo (Array)	ADCODE	Integer	광고코드.. 1 ~ 99까지 부여가능(최대99개)
		subpoi (Object)	count	Integer	subpoi 개수
		subpoi (Object)	poi	Array	poi 정보와 동일

좌표변환 (WGS84 <-> TM)

WGS84좌표와 TM좌표 간 변환

Request URL

Http Method	URL
GET	https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/trans-coordinates?coortype={coortype}&x={x}&y={y}

Request Path parameter

값	타입	설명
appKey	String	고유의 appKey

Request Query Parameters

값	타입	필수	설명
coordtype	String	O	좌표형식 0 : WGS84 -> TM 1 : TM -> WGS84
x	String	O	X좌표
y	String	O	Y좌표

Response Json

값		타입	설명
header (Object)	isSuccessful	Boolean	성공여부
	resultCode	Integer	실패 코드
	resultMessage	String	실패 메시지
coordinate (Object)
	x	String	변환X좌표
	y	String	변환Y좌표
coordtype	String	변환좌표형태

결과코드

결과 코드값 리스트

결과코드

resultCode	resultMessage	비고	설명
0		공통	성공
100	Result Not Found	검색전용	결과없음
101	Argument Error	공통	파라미터 오류
102	Internal Server Error	검색전용	서버 오류
201	Searching for Security	검색전용	POI 보안시설물
202	Longitude/Latitude	검색전용	경위도
203	Mobile Phone Number	검색전용	전화번호(Mobile)
204	Invalid Query	검색전용	서버 오류
205	POI not in given Admin	검색전용	결과없음(지역설정)
206	POI not in given Area	검색전용	결과없음(영역설정)
207	POI not in given Category	검색전용	결과없음(분류설정)
208	Neighbor Search Only	검색전용	결과없음(주변검색만입력)
209	Neighbor Search not Found	검색전용	결과없음(주변 + 키워드 검색 결과 없음)
300	AppKey Error	공통	AppKey 인증 오류

Toast Maps Search API Reference