Skip to main content

郵便番号検索API

GET /v1/postalcode/:郵便番号

与えられた郵便番号を元に、該当する郵便区画のリソースを取得します。

リソースURL

https://api.kenall.jp/v1/postalcode/:郵便番号?version=...

パラメーター

名前必須かどうか説明
:郵便番号string必須取得したい郵便区画の郵便番号、あるいは取得したい住所の個別事業所番号。ハイフンなしで、7桁の郵便番号を指定する必要があります。郵便番号には頭がゼロのものが存在するため、数値型ではなく文字列型を用いて取り扱うことを推奨します。FAQ も参照してください。"0893443"
versionstring省略可取得したい郵便番号データのバージョンを指定します。省略した場合は、リクエスト時点での最新バージョンを指定したものとみなされます。"2021-02-26"

レスポンス

以下は郵便番号データのレスポンスの一例です。

{
"version": "2022-09-30",
"data": [
{
"jisx0402": "13101",
"old_code": "100",
"postal_code": "1000001",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"town_kana": "チヨダ",
"town_kana_raw": "チヨダ",
"prefecture": "東京都",
"city": "千代田区",
"town": "千代田",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": false,
"town_multi": false,
"town_raw": "千代田",
"corporation": null,
"town_jukyohyoji": false,
"update_status": 0,
"update_reason": 0,
"prefecture_roman": "Tokyo",
"county": "",
"county_kana": "",
"county_roman": "",
"city_without_county_and_ward": "千代田区",
"city_without_county_and_ward_kana": "チヨダク",
"city_without_county_and_ward_roman": "Chiyoda-ku",
"city_ward": "",
"city_ward_kana": "",
"city_ward_roman": "",
"city_roman": "Chiyoda-ku",
"town_roman": "Chiyoda"
}
]
}

個別事業所番号データのレスポンスは以下のようになります。

{
"version": "2022-09-30",
"data": [
{
"jisx0402": "13104",
"old_code": "16001",
"postal_code": "1638001",
"prefecture_kana": "トウキョウト",
"city_kana": "シンジュクク",
"town_kana": "",
"town_kana_raw": "",
"prefecture": "東京都",
"city": "新宿区",
"town": "西新宿",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": false,
"town_multi": false,
"town_raw": "西新宿",
"corporation": {
"name": "東京都庁",
"name_kana": "トウキヨウトチヨウ",
"block_lot": "2丁目8-1",
"block_lot_num": "2-8-1",
"post_office": "新宿",
"code_type": 0
},
"town_jukyohyoji": true,
"update_status": 0,
"update_reason": 0,
"prefecture_roman": "Tokyo",
"county": "",
"county_kana": "",
"county_roman": "",
"city_without_county_and_ward": "新宿区",
"city_without_county_and_ward_kana": "シンジュクク",
"city_without_county_and_ward_roman": "Shinjuku-ku",
"city_ward": "",
"city_ward_kana": "",
"city_ward_roman": "",
"city_roman": "Shinjuku-ku",
"town_roman": ""
}
]
}

レスポンスのデータは以下のような構成になっています。

名前説明
versionstringデータのバージョン番号。YYYY-MM-DD形式のデータ作成日付となっている。"2022-01-31"
dataarray郵便区画レコードの配列(後述)

data配列内の郵便区画レコードは以下のような構成になっています。

名前説明
jisx0402string全国地方公共団体コード (JIS X0401、X0402)"13101"
old_codestring(旧) 郵便番号 (3/5桁)"100"
postal_codestring郵便番号 (7桁)"1008105"
prefecturestring都道府県名"東京都"
prefecture_kanastring都道府県名(全角カナ)"トウキョウト"
prefecture_romanstring都道府県名(ローマ字)"Tokyo"
citystring市区町村名"千代田区"
city_kanastring市区町村名(全角カナ)"チヨダク"
city_romanstring市区町村名(ローマ字)"Naka-ku, Yokohama"
countystring郡名"北佐久郡"
county_kanastring郡名(全角カナ)"キタサクグン"
county_romanstring郡名(ローマ字)"Kitasaku"
city_without_county_and_wardstring地方自治体の市区町村のうち、郡及び政令指定都市の行政区を除いたもの"横浜市"
city_without_county_and_ward_kanastring地方自治体の市区町村のうち、郡及び政令指定都市の行政区を除いたもの(全角カナ)"ヨコハマシ"
city_without_county_and_ward_romanstring地方自治体の市区町村のうち、郡及び政令指定都市の行政区を除いたもの(ローマ字)"Yokohama"
city_wardstring政令指定都市の行政区"中区"
city_ward_kanastring政令指定都市の行政区(全角カナ)"ナカク"
city_ward_romanstring政令指定都市の行政区(ローマ字)"Naka-ku"
townstring町域名をベースにして、複数行の結合や括弧書きの除去等の処理を行ったもの。"千代田"
town_kanastring町域名 (全角カナ) 既知の問題があります。詳細はFAQを参照してください。"チヨダ"
town_romanstring市区町村名(ローマ字)"Chiyoda"
town_kana_rawstring郵便番号データ上の町域名 (全角カナ)"オオエ (2チョウメ651、662、668バンチ、3チョウメ103、118、210 、254、267、372、444、469バンチ) "
koazastring町域名から分離された小字・丁目"2丁目"
kyoto_streetstring京都市特有の通り名"先斗町通四条上る"
buildingstringビル名"オフィスタワーX"
floorstringビルの階層"1階"
town_partialboolean一町域が二以上の郵便番号で表される場合の表示 (trueは該当、falseは該当せず) 「一町域が二以上の郵便番号で表される場合の表示」とは、町域のみでは郵便番号が特定できず、丁目、番地、小字などにより番号が異なる町域のことfalse
town_addressed_koazaboolean小字毎に番地が起番されている町域の表示 (trueは該当、falseは該当せず) 「小字毎に番地が起番されている町域の表示」とは、郵便番号を設定した町域 (大字) が複数の小字を有しており、各小字毎に番地が起番されているため、町域 (郵便番号) と番地だけでは住所が特定できない町域のことfalse
town_chomeboolean丁目を有する町域の場合の表示 (trueは該当、falseは該当せず)false
town_multiboolean一つの郵便番号で二以上の町域を表す場合の表示 (trueは該当、falseは該当せず) 「一つの郵便番号で二以上の町域を表す場合の表示」とは、一つの郵便番号で複数の町域をまとめて表しており、郵便番号と番地だけでは住所が特定できないことを示すfalse
town_jukyohyojistring当該町域が住居表示実施地域かどうか。この判定には国土地理院の電子国土基本図 (地名情報) 「住居表示住所」を用いています
town_rawstring郵便番号データ上の町域名、ただし複数行にまたがって記載されていたものについては結合している"大江 (2丁目651、662、668番地、3丁目103、118、210、254、267、372、444、469番地) "
update_statusnumberこのバージョンで変更された郵便番号・個別事業所番号かどうかを表す数字。0:変更なし、1:追加・変更、2:廃止
update_reasonnumber変更事由。0:変更なし、1:市政・区政・町政・分区・政令指定都市施行、2:住居表示の実施、3:区画整理、4:郵便区調整等、5:訂正、6:廃止
corporationobjectまたはnull与えられた郵便番号が個別事業所番号に該当した場合JSONオブジェクトとして個別事業所番号レコードが、一般的な郵便番号の場合はnullが与えられる(後述)

corporationに与えられる個別事業所番号レコードは以下のような構成になっています。

名前説明
namestring事業所名 (漢字)"総務省"
name_kanastring事業所名 (カナ)"ソウムシヨウ"
block_lotstring小字名、丁目、番地等"2丁目1-2"
block_lot_numstringまたはnull住居表示の行われている地域では丁目・番地・号を、そうでない地域では番地の部分を半角算用数字およびハイフン繋ぎにしたものを与える"2-1-2"
post_officestring取扱郵便局"銀座"
code_typenumber個別番号の種別の表示 (0: 大口事業所 1: 私書箱)"0"
info

個別事業所番号におけるtownkyoto_streetbuildingfloorは、block_lotの住所要素を解析した結果を格納しています。ただし、私書箱情報は解析しておりません。

ローマ字フィールド

バージョン2022-11-01から住所フィールドのローマ字表記を追加しました。

このデータは、郵便番号データに含まれるカナ情報を元に、ケンオールが独自に変換して生成したローマ字です。

このデータを利用すると次に挙げるようなメリットがあります。

  • 日本郵便株式会社が公開する「郵便番号データ(ローマ字)」は、更新頻度が低く、更新タイミングが「郵便番号データ」と一致していないため、利用し辛いユースケースがあります。 ケンオールのローマ字データは、常に最新の情報を利用でき、「郵便番号データ」との一貫性に優れています。
  • 郵便番号データ(ローマ字)」は、文字数制限により、その収録時に本来含めるべき文字が欠落するデータがあります。ケンオールのローマ字データは、含めるべき文字が欠落することのないようデータ処理していますので、安心してご利用いただけます。

ローマ字の変換方式は外務省の公開するヘボン式変換表をベースとしていますが、変換表に記載がない一部の変換パターンについては「郵便番号データ(ローマ字)」に記載されている内容にもとづき変換しています。

GET /v1/postalcode/versions/

現在ケンオールで提供しているすべての郵便番号データのバージョンを返します。

リソースURL

https://api.kenall.jp/v1/postalcode/versions/

パラメータ

なし

レスポンス

{
"versions": [
"2020-10-30",
"2020-11-30",
"2020-12-28",
"2021-01-29",
"2021-02-26",
"2021-03-31",
"2021-04-30",
"2021-05-31",
"2021-06-30",
"2021-07-30",
"2021-08-31",
"2021-09-30",
"2021-10-29",
"2021-11-30",
"2021-12-28",
"2022-01-31",
"2022-02-28",
"2022-03-31",
"2022-04-28",
"2022-05-31",
"2022-06-30"
]
}

レスポンスのデータは以下のような構成になっています。

名前説明
versionsarrayデータのバージョン番号を文字列で格納した配列。バージョン番号はYYYY-MM-DD形式の、データ作成日付となっている。

GET /v1/postalcode/updates/

郵便番号データの指定バージョンにおける更新差分を取得します。

リソースURL

https://api.kenall.jp/v1/postalcode/updates/?version=...

パラメータ

名前必須かどうか説明
versionstring省略可取得したい郵便番号データのバージョンを指定します。省略した場合は、リクエスト時点での最新バージョンを指定したものとみなされます。"2021-02-26"

レスポンス

レスポンスのデータは以下のような構成になっています。

名前説明
versionstringデータのバージョン番号。YYYY-MM-DD形式のデータ作成日付となっている。"2022-01-31"
dataarray郵便区画レコードの配列

郵便区画レコードの仕様は、郵便番号APIのものと同一です。他の郵便番号APIと異なり、本APIのレスポンスには 削除された郵便区画レコード も含まれていることに留意してください。