{"openapi":"3.0.3","info":{"title":"APICK 행정구역 코드 조회","version":"1.0.0","description":"주소나 좌표에서 시도·시군구·읍면동·행정동 이름과 법정동코드·행정동코드·지역코드를 뽑습니다. 다른 시스템의 지역 코드와 맞출 때 씁니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/geo_admin_code":{"post":{"summary":"행정구역 코드 조회","description":"주소나 좌표에서 시도·시군구·읍면동·행정동 이름과 법정동코드·행정동코드·지역코드를 뽑습니다. 다른 시스템의 지역 코드와 맞출 때 씁니다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"point":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"crs":{"type":"string"}}},"zipcode":{"type":"string","description":"우편번호입니다."},"hierarchy":{"type":"object","properties":{"sido":{"type":"string","description":"시도 이름입니다."},"sigungu":{"type":"string","description":"시군구 이름입니다."},"eupmyeondong":{"type":"string","description":"읍면동(법정동) 이름입니다."},"ri":{"type":"string","description":"리 이름입니다. 없으면 빈 문자열입니다."},"adminDong":{"type":"string","description":"행정동 이름입니다."}}},"codes":{"type":"object","properties":{"pnu":{"type":"string","description":"필지번호 19자리입니다. 좌표로 조회했으면 빈 문자열일 수 있습니다."},"bjdongCode":{"type":"string","description":"법정동코드 10자리입니다."},"lawdCd":{"type":"string","description":"시군구 단위 지역코드 5자리입니다."},"adminDongCode":{"type":"string","description":"행정동코드 10자리입니다."},"sidoCode":{"type":"string","description":"시도 코드 2자리입니다."},"sigunguCode":{"type":"string","description":"시군구 코드 5자리입니다."}}},"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":false,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"address":{"type":"string","description":"주소. 좌표와 둘 중 하나는 필요합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. (string)","example":"서울특별시 강남구 역삼동 808"},"x":{"type":"string","description":"경도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. (number)"},"y":{"type":"string","description":"위도 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. (number)"},"point":{"type":"string","description":"좌표 문자열 \"경도,위도\" 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. (string)"},"addrType":{"type":"string","description":"주소 유형 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다. (string)","enum":["auto","parcel","road"]},"includeZipcode":{"type":"string","description":"우편번호 포함 여부 (기본 true) true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. (boolean)"}}}}}}}}},"x-code-tables":[{"title":"오류 코드","columns":["상황","data.error 예","대처"],"rows":[["입력 누락·형식 오류","검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …","문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다."],["개수·길이 초과","주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …","표의 최대값 안으로 줄이거나 나눠서 요청합니다."],["위치를 찾지 못함","입력한 위치를 찾지 못했습니다.","주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다."],["처리 시간 초과","처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.","목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다."],["일시적 실패","공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.","잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}