{"openapi":"3.0.3","info":{"title":"APICK 주소 자동완성","version":"1.0.0","description":"입력 중인 주소의 도로명·지번 후보를 합쳐 일치도 순으로 제안합니다. 주소 입력 폼의 자동완성 목록을 만들 때 씁니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/geo_address_autocomplete":{"post":{"summary":"주소 자동완성","description":"입력 중인 주소의 도로명·지번 후보를 합쳐 일치도 순으로 제안합니다. 주소 입력 폼의 자동완성 목록을 만들 때 씁니다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer","description":"제안 수입니다."},"items":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"pnu":{"type":"string"},"roadAddress":{"type":"string","description":"도로명 주소 후보입니다."},"parcelAddress":{"type":"string","description":"지번 주소 후보입니다."},"jibun":{"type":"string"},"buildingName":{"type":"string","description":"건물명입니다."},"zipcode":{"type":"string","description":"우편번호입니다."},"category":{"type":"string"},"point":{"type":"object","properties":{"x":{"type":"number","description":"경도입니다."},"y":{"type":"number","description":"위도입니다."},"crs":{"type":"string"}}},"codes":{"type":"object","properties":{"pnu":{"type":"string"},"bjdongCode":{"type":"string"},"lawdCd":{"type":"string"}}},"rank":{"type":"integer","description":"입력과 얼마나 일치하는지 나타내는 점수입니다. 클수록 잘 맞습니다."}}}},"suggestions":{"type":"array","items":{"type":"string"},"description":"화면에 그대로 보여줄 주소 문자열 목록입니다."},"error":{"type":"string","description":"실패 사유입니다. 이 필드가 있으면 과금되지 않습니다."}}},"api":{"type":"object","properties":{"cost":{"type":"integer","description":"차감된 포인트입니다. 실패한 응답은 0입니다."},"success":{"type":"boolean"},"ms":{"type":"integer","description":"처리 시간(밀리초)입니다."}}}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"입력 중인 주소 (예: 테헤란로) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. (string)","example":"강남대로"},"size":{"type":"string","description":"출력 이미지의 크기입니다. 1024x1024 같은 WxH 형식으로 보내며, 모델별 지원 크기를 확인하세요. (integer)","example":"5"},"category":{"type":"string","description":"검색 범위 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. road = 도로명 주소를 기준으로 조회하는 값입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. (string)","enum":["auto","road","parcel"]}},"required":["query"]}}}}}}},"x-code-tables":[{"title":"오류 코드","columns":["상황","data.error 예","대처"],"rows":[["입력 누락·형식 오류","검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …","문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다."],["개수·길이 초과","주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …","표의 최대값 안으로 줄이거나 나눠서 요청합니다."],["위치를 찾지 못함","입력한 위치를 찾지 못했습니다.","주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다."],["처리 시간 초과","처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.","목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다."],["일시적 실패","공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.","잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}