주소 품질 진단 API 개발가이드

알아둘 점

이용 전 확인

성공한 요청 한 건당 30P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다.

등급은 90점 이상 A, 75점 이상 B, 55점 이상 C, 그 밖 D 이며 찾지 못한 주소는 F(0점)입니다. 상세 주소(동·호·건물명)가 빠졌거나 너무 짧거나 괄호 같은 특수문자가 섞이면 점수가 낮아집니다.

감점된 이유는 issues에 문장으로 담기므로 주소를 고치는 안내에 그대로 쓸 수 있습니다.

한 건이라도 찾으면 성공 응답이며 요청 한 번에 위 단가가 한 번 차감됩니다. 모든 주소를 찾지 못하면 실패로 끝나고 과금되지 않습니다.

좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다.

요청과 응답

API 요청

POST/rest/geo_address_quality

Bearer 인증
multipart/form-data
JSON 응답

요청 예제

curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'addresses[0]=서울특별시 강남구 역삼동 808' \
  --form-string 'addresses[1]=서울 강남구 없는동 999'

curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --connect-timeout 10 --max-time 120 \
  --form-string 'addresses[0]=서울특별시 강남구 역삼동 808' \
  --form-string 'addresses[1]=서울 강남구 없는동 999'

POSIX 셸 · APICK_API_KEY 환경변수를 먼저 설정하세요. Windows에서는 Unicode 지원 cURL을 사용하세요.

const form = new FormData();
form.append("addresses[0]", "서울특별시 강남구 역삼동 808");
form.append("addresses[1]", "서울 강남구 없는동 999");
const response = await fetch("https://apick.app/rest/geo_address_quality", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

const form = new FormData();
form.append("addresses[0]", "서울특별시 강남구 역삼동 808");
form.append("addresses[1]", "서울 강남구 없는동 999");
const response = await fetch("https://apick.app/rest/geo_address_quality", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
if (result.error || result.data?.error || result.result?.error || result.success === false || result.api?.success === false) {
  throw new Error(JSON.stringify(result));
}
console.log(result);

Node.js 22+ · 서버에서 실행하는 ESM 예제입니다. 키를 브라우저에 넣지 마세요.

import os
import requests
parts = [
    ("addresses[0]", (None, "서울특별시 강남구 역삼동 808")),
    ("addresses[1]", (None, "서울 강남구 없는동 999")),
]
response = requests.request("POST", "https://apick.app/rest/geo_address_quality",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

import os
import requests
parts = [
    ("addresses[0]", (None, "서울특별시 강남구 역삼동 808")),
    ("addresses[1]", (None, "서울 강남구 없는동 999")),
]
response = requests.request("POST", "https://apick.app/rest/geo_address_quality",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
if result.get("error") or (isinstance(result.get("data"), dict) and result["data"].get("error")) or (isinstance(result.get("result"), dict) and result["result"].get("error")) or result.get("success") is False or (result.get("api") or {}).get("success") is False:
    raise RuntimeError(result)
print(result)

Python 3 · requests 설치가 필요합니다. 키는 서버 환경변수로 읽습니다.

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'addresses[0]' => '서울특별시 강남구 역삼동 808',
    'addresses[1]' => '서울 강남구 없는동 999',
];
$curl = curl_init('https://apick.app/rest/geo_address_quality');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'addresses[0]' => '서울특별시 강남구 역삼동 808',
    'addresses[1]' => '서울 강남구 없는동 999',
];
$curl = curl_init('https://apick.app/rest/geo_address_quality');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
if (!empty($result["error"]) || !empty($result["data"]["error"]) || !empty($result["result"]["error"]) || ($result["success"] ?? true) === false || ($result["api"]["success"] ?? true) === false) {
    throw new RuntimeException($body);
}
print_r($result);

PHP 8 · cURL 확장이 필요합니다. 키는 서버 환경변수로 읽습니다.

응답 예시200

{
  "data": {
    "summary": {
      "total": 2,
      "valid": 1,
      "invalid": 1,
      "averageScore": 50,
      "partial": false,
      "elapsedMs": 210
    },
    "items": [
      {
        "input": "서울특별시 강남구 역삼동 808",
        "valid": true,
        "score": 100,
        "grade": "A",
        "issues": [],
        "normalized": {
          "full": "서울특별시 강남구 역삼동 808"
        },
        "codes": {
          "pnu": "1168010100108080000",
          "lawdCd": "11680"
        },
        "point": {
          "x": 127.0250516,
          "y": 37.5043681,
          "crs": "EPSG:4326"
        },
        "suggestions": []
      },
      {
        "input": "서울 강남구 없는동 999",
        "valid": false,
        "score": 0,
        "grade": "F",
        "issues": [
          "주소를 찾지 못했습니다."
        ],
        "suggestions": [
          {
            "roadAddress": "서울특별시 강남구 테헤란로 152",
            "parcelAddress": "서울특별시 강남구 역삼동 808",
            "zipcode": "06123"
          }
        ]
      }
    ]
  },
  "api": {
    "cost": 30,
    "success": true,
    "ms": 220
  }
}

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

요청 파라미터 2개 · 필수 1

파라미터

설명

addressesarray필수

진단할 주소 목록 (최대 20건) 배열로 보내며, 항목이 없으면 빈 배열을 보내거나 필드를 생략합니다.

addrTypestring선택

주소 유형 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다.

허용값: auto parcel road

응답 필드 32개

응답 필드

설명

dataobject

요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.

data.summaryobject

공고의 짧은 요약입니다. 본문 전체는 description_html에서 확인하세요.

data.itemsarray

조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다.

data.errorstring

오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.

apiobject

API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.

api.costinteger

이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.

api.successboolean

API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.

api.msinteger

서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.

하위 필드 24개 더 보기

응답 필드

설명

data.summary.totalinteger

상태 집계 대상 택배사의 전체 수입니다. 조회 가능·점검 중인 수를 합한 값과 일치합니다.

data.summary.validinteger

찾은 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.summary.invalidinteger

찾지 못한 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.summary.averageScoreinteger

평균 점수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.summary.partialboolean

시간 초과로 일부를 진단하지 못했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.

data.summary.elapsedMsinteger

'elapsedMs' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.items[].inputstring

입력한 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.items[].validboolean

주소를 찾았으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.

data.items[].scoreinteger

0~100 점수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.items[].gradestring

A·B·C·D·F 등급입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.items[].issuesarray

보완할 점입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.

data.items[].normalizedobject

'normalized' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.

data.items[].normalized.fullstring

찾은 주소의 표준 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.items[].codesobject

'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.

data.items[].codes.pnustring

필지번호입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.items[].codes.lawdCdstring

'lawdCd' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

data.items[].pointobject

'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.

data.items[].point.xnumber

'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.items[].point.ynumber

'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

data.items[].point.crsstring

'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

data.items[].suggestionsarray

찾지 못한 주소의 대안 후보(도로명·지번·우편번호, 최대 3건)입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.

data.items[].suggestions[].roadAddressstring

'roadAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

data.items[].suggestions[].parcelAddressstring

'parcelAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

data.items[].suggestions[].zipcodestring

'zipcode' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

입력 조건·전송 규칙

항목

설정

메서드·주소

POST https://apick.app/rest/geo_address_quality

인증 헤더

Authorization: Bearer — 내 계정의 API 인증키

본문 형식

multipart/form-data

요청 예시

form-data 전체 예제 보기

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 주소록 품질 진단

고객 주소록 일부를 넣어 점수·등급과 보완할 점을 받습니다(최대 20건).

요청POST/rest/geo_address_quality

curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'addresses[0]=서울특별시 강남구 역삼동 808' \
  --form-string 'addresses[1]=서울 강남구 없는동 999'

const form = new FormData();
form.append("addresses[0]", "서울특별시 강남구 역삼동 808");
form.append("addresses[1]", "서울 강남구 없는동 999");
const response = await fetch("https://apick.app/rest/geo_address_quality", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

import os
import requests
parts = [
    ("addresses[0]", (None, "서울특별시 강남구 역삼동 808")),
    ("addresses[1]", (None, "서울 강남구 없는동 999")),
]
response = requests.request("POST", "https://apick.app/rest/geo_address_quality",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'addresses[0]' => '서울특별시 강남구 역삼동 808',
    'addresses[1]' => '서울 강남구 없는동 999',
];
$curl = curl_init('https://apick.app/rest/geo_address_quality');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

data.items[].grade가 C 이하인 주소는 issues[] 안내로 보완을 요청합니다.
grade가 F인 주소는 suggestions[]의 후보 중에서 고르게 합니다.

예시 2. 줄바꿈 목록으로 보내기

텍스트 파일의 주소를 줄마다 하나씩 넣은 문자열 그대로 보낼 수 있습니다.

요청POST/rest/geo_address_quality

curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string '__apick_encoding[addresses]=base64-utf8' \
  --form-string 'addresses=7ISc7Jq47Yq567OE7IucIOqwleuCqOq1rCDsl63sgrzrj5kgODA4CuyEnOyauO2KueuzhOyLnCDqsJXrgqjqtawg6rCV64Ko64yA66GcIDM5Ng=='

const form = new FormData();
form.append("__apick_encoding[addresses]", "base64-utf8");
form.append("addresses", "7ISc7Jq47Yq567OE7IucIOqwleuCqOq1rCDsl63sgrzrj5kgODA4CuyEnOyauO2KueuzhOyLnCDqsJXrgqjqtawg6rCV64Ko64yA66GcIDM5Ng==");
const response = await fetch("https://apick.app/rest/geo_address_quality", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

import os
import requests
parts = [
    ("__apick_encoding[addresses]", (None, "base64-utf8")),
    ("addresses", (None, "7ISc7Jq47Yq567OE7IucIOqwleuCqOq1rCDsl63sgrzrj5kgODA4CuyEnOyauO2KueuzhOyLnCDqsJXrgqjqtawg6rCV64Ko64yA66GcIDM5Ng==")),
]
response = requests.request("POST", "https://apick.app/rest/geo_address_quality",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    '__apick_encoding[addresses]' => 'base64-utf8',
    'addresses' => '7ISc7Jq47Yq567OE7IucIOqwleuCqOq1rCDsl63sgrzrj5kgODA4CuyEnOyauO2KueuzhOyLnCDqsJXrgqjqtawg6rCV64Ko64yA66GcIDM5Ng==',
];
$curl = curl_init('https://apick.app/rest/geo_address_quality');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

data.summary.averageScore로 주소록 전체 품질을 수치로 비교합니다.
모든 주소를 찾지 못하면 실패로 끝나며 과금되지 않습니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

{
  "data": {
    "summary": {
      "total": 2,
      "valid": 1,
      "invalid": 1,
      "averageScore": 50,
      "partial": false,
      "elapsedMs": 210
    },
    "items": [
      {
        "input": "서울특별시 강남구 역삼동 808",
        "valid": true,
        "score": 100,
        "grade": "A",
        "issues": [],
        "normalized": {
          "full": "서울특별시 강남구 역삼동 808"
        },
        "codes": {
          "pnu": "1168010100108080000",
          "lawdCd": "11680"
        },
        "point": {
          "x": 127.0250516,
          "y": 37.5043681,
          "crs": "EPSG:4326"
        },
        "suggestions": []
      },
      {
        "input": "서울 강남구 없는동 999",
        "valid": false,
        "score": 0,
        "grade": "F",
        "issues": [
          "주소를 찾지 못했습니다."
        ],
        "suggestions": [
          {
            "roadAddress": "서울특별시 강남구 테헤란로 152",
            "parcelAddress": "서울특별시 강남구 역삼동 808",
            "zipcode": "06123"
          }
        ]
      }
    ]
  },
  "api": {
    "cost": 30,
    "success": true,
    "ms": 220
  }
}

원문 응답 필드 표 보기

필드

타입

설명

data.summary.total

integer

진단한 주소 수입니다.

data.summary.valid

integer

찾은 주소 수입니다.

data.summary.invalid

integer

찾지 못한 주소 수입니다.

data.summary.averageScore

number

평균 점수입니다.

data.summary.partial

boolean

시간 초과로 일부를 진단하지 못했으면 true 입니다.

data.items[].input

string

입력한 주소입니다.

data.items[].valid

boolean

주소를 찾았으면 true 입니다.

data.items[].score

integer

0~100 점수입니다.

data.items[].grade

string

A·B·C·D·F 등급입니다.

data.items[].issues[]

array

보완할 점입니다.

data.items[].normalized.full

string

찾은 주소의 표준 주소입니다.

data.items[].codes.pnu

string

필지번호입니다.

data.items[].suggestions[]

array

찾지 못한 주소의 대안 후보(도로명·지번·우편번호, 최대 3건)입니다.

data.error

string

실패 사유입니다. 이 필드가 있으면 과금되지 않습니다.

api.cost

integer

차감된 포인트입니다. 실패한 응답은 0입니다.

api.ms

integer

처리 시간(밀리초)입니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

HTTP 상태전송·인증·입력 오류
api.successAPI 처리 여부
data · result업무 결과와 오류 문구
api.cost이번 요청의 과금

업무 실패 응답 data.error

입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.

{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}

서비스 코드·조건

오류 코드

상황

data.error 예

대처

입력 누락·형식 오류

검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …

문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다.

개수·길이 초과

주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …

표의 최대값 안으로 줄이거나 나눠서 요청합니다.

위치를 찾지 못함

입력한 위치를 찾지 못했습니다.

주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다.

처리 시간 초과

처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.

목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다.

일시적 실패

공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.

잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.

인증·포인트 오류 result.error 문구

코드

HTTP

의미·조치

유효하지 않은 API키 입니다.

401

Authorization: Bearer 헤더의 인증키를 확인하세요.

허용되지 않은 IP주소 입니다.

401

마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.

비활성화된 계정입니다.

401

계정 이용 상태를 고객지원으로 문의하세요.

사용 가능한 포인트이 부족합니다.

200

HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.

무료 포인트로 사용할 수 없는 서비스입니다.

200

최소 1회 결제 후 이용할 수 있습니다. result.error 전체 문구를 그대로 표시하세요.

인증 정보를 확인할 수 없습니다.

424

일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.

폼 입력 오류 error.code

코드

HTTP

의미·조치

FORM_DATA_INVALID

400

필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.

FORM_DATA_FIELD_CONFLICT

400

같은 값과 중첩 경로를 동시에 지정하지 마세요.

MULTIPART_LIMIT_OR_PARSE_ERROR

400·413

boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 30P · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

주소 품질 진단 API

알아둘 점

이용 전 확인

요청과 응답

API 요청

요청 파라미터 2개 · 필수 1

응답 필드 32개

입력 조건·전송 규칙

요청 예시

사용 예시

예시 1. 주소록 품질 진단

예시 2. 줄바꿈 목록으로 보내기

응답 처리

오류 코드

업무 실패 응답 data.error

서비스 코드·조건

오류 코드

인증·포인트 오류 result.error 문구

폼 입력 오류 error.code

요금·이용 조건

연동 팁

개발가이드 검색

AI•LLM

전체상품

API 체험하기

요금정책

고객지원

개발가이드