{"openapi":"3.0.3","info":{"title":"APICK 주변 생활시설 분석","version":"1.0.0","description":"기준 주소·좌표 반경 안의 편의점·지하철역·학교·병원·약국 등을 분류별로 찾아 가까운 순서와 평균 거리로 요약합니다. 상권·입지 후보를 빠르게 비교할 때 씁니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/geo_neighborhood":{"post":{"summary":"주변 생활시설 분석","description":"기준 주소·좌표 반경 안의 편의점·지하철역·학교·병원·약국 등을 분류별로 찾아 가까운 순서와 평균 거리로 요약합니다. 상권·입지 후보를 빠르게 비교할 때 씁니다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"center":{"type":"object","properties":{"x":{"type":"number","description":"기준점 경도입니다."},"y":{"type":"number","description":"기준점 위도입니다."},"crs":{"type":"string"}}},"label":{"type":"string","description":"기준점의 동네 이름입니다."},"radius":{"type":"integer","description":"적용한 반경(m)입니다."},"summary":{"type":"object","properties":{"categories":{"type":"integer","description":"분석한 분류 수입니다."},"total":{"type":"integer","description":"반경 안에서 찾은 시설 수의 합입니다."},"partial":{"type":"boolean","description":"시간 초과로 일부 분류를 분석하지 못했으면 true 입니다."}}},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"분류 이름입니다."},"count":{"type":"integer","description":"반경 안 시설 수입니다."},"nearest":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"address":{"type":"string"},"point":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"crs":{"type":"string"}}},"distanceM":{"type":"number"}}},{}],"type":"object","properties":{"distanceM":{"type":"number","description":"기준점과의 거리(m)입니다."}}},"description":"가까운 시설 목록(이름·분류·주소·좌표·거리)입니다."},"averageDistanceM":{"type":"number","description":"반경 안 시설의 평균 거리(m)입니다. 없으면 null 입니다.","nullable":true}}}},"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)"},"radius":{"type":"string","description":"반경(m). 기본 500 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. (number)","example":"800"},"limit":{"type":"string","description":"분류별 가까운 시설 수 (기본 5, 최대 10) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. (integer)"},"addrType":{"type":"string","description":"auto(기본)·parcel(지번)·road(도로명) 중 하나입니다. auto 는 지번·도로명을 알아서 판단합니다. jibun·지번·도로명 표기도 받습니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다. (string)"}}}}}}}}},"x-code-tables":[{"title":"오류 코드","columns":["상황","data.error 예","대처"],"rows":[["입력 누락·형식 오류","검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …","문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다."],["개수·길이 초과","주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …","표의 최대값 안으로 줄이거나 나눠서 요청합니다."],["위치를 찾지 못함","입력한 위치를 찾지 못했습니다.","주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다."],["처리 시간 초과","처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.","목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다."],["일시적 실패","공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.","잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}