Skip to main content

郵便番号API

ケンオールは、Webサービス等から郵便番号データを検索するためのREST APIを提供しています。

APIの概要については、ケンオールAPI概要をご参照ください。

GET /postalcode/:郵便番号#

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

リソースURL#

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

パラメータ#

名前必須かどうか説明
郵便番号string必須取得したい郵便区画の郵便番号、あるいは取得したい住所の個別事業所番号。ハイフンなしで、7桁の郵便番号を指定する必要があります。郵便番号には、頭がゼロのものが存在するため、int型ではなくstr型である必要があります。例: 0893443 FAQ も参照してください。https://api.kenall.jp/v1/postalcode/1000001

レスポンス#

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

{  "version": "2021-06-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    }  ]}

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

{  "version": "2021-06-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",        "post_office": "新宿",        "code_type": 0      }    }  ]}

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

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

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

名前説明
jisx0402string全国地方公共団体コード(JIS X0401、X0402)13101
old_codestring(旧)郵便番号(5桁)100
postal_codestring郵便番号(7桁)1008105
prefecture_kanastring都道府県名(全角カナ)トウキョウト
city_kanastring市区町村名(全角カナ)チヨダク
town_kanastring町域名(全角カナ) 既知の問題があります。詳細はFAQを参照してください。チヨダ
town_kana_rawstring郵便番号データ上の町域名(全角カナ)オオエ(2チョウメ651、662、668バンチ、3チョウメ103、118、210 、254、267、372、444、469バンチ)
prefecturestring都道府県名東京都
citystring市区町村名千代田区
townstring町域名をベースにして、複数行の結合や括弧書きの除去等の処理を行ったもの。千代田
koazastring町域名から分離された小字・丁目2丁目
kyoto_streetstring京都特有の通り名先斗町通四条上る
buildingstringビル名オフィスタワーX
floorstringビルの階層1階
town_partialbool一町域が二以上の郵便番号で表される場合の表示 (「true」は該当、「false」は該当せず)「一町域が二以上の郵便番号で表される場合の表示」とは、町域のみでは郵便番号が特定できず、丁目、番地、小字などにより番号が異なる町域のことfalse
town_addressed_koazabool小字毎に番地が起番されている町域の表示(「true」は該当、「false」は該当せず)「小字毎に番地が起番されている町域の表示」とは、郵便番号を設定した町域(大字)が複数の小字を有しており、各小字毎に番地が起番されているため、町域(郵便番号)と番地だけでは住所が特定できない町域のことfalse
town_chomebool丁目を有する町域の場合の表示 (「true」は該当、「false」は該当せず)false
town_multibool一つの郵便番号で二以上の町域を表す場合の表示 (「true」は該当、「false」は該当せず)「一つの郵便番号で二以上の町域を表す場合の表示」とは、一つの郵便番号で複数の町域をまとめて表しており、郵便番号と番地だけでは住所が特定できないことを示すfalse
town_rawstring郵便番号データ上の町域名、ただし複数行にまたがって記載されていたものについては結合している大江(2丁目651、662、668番地、3丁目103、118、210、254、267、372、444、469番地)
corporationmap個別事業所番号データに該当した場合、map形式で追加のデータが返される。一般的な郵便番号データの場合はnullが返される。null
corporation.namestring事業所名(漢字)総務省
corporation.name_kanastring事業所名(カナ)ソウムシヨウ
corporation.block_lotstring小字名、丁目、番地等2丁目1-2
corporation.post_officestring取扱郵便局銀座
corporation.code_typenumber個別番号の種別の表示 「0」大口事業所 「1」私書箱0

GET /postalcode/?q=...&offset=...&limit=...&facet=...#

caution

郵便番号逆引き検索APIはベータサービスです。ベータサービスは、正式リリース前の段階で、ユーザーの皆様に広くお試しいただくための試験的なサービスです。ベータサービスの利用の前に、必ずベータサービス利用規約をご一読し、同意の上でご利用ください。ベータサービスの利用によって発生した問題について、オープンコレクターは一切責任を負いません。ベータサービスの説明ページもご参照ください。

与えられた検索クエリを元に、該当する郵便区画のリソースを取得します。 郵便番号逆引き検索APIの概要については、ケンオールAPI概要をご参照ください。

リソースURL#

https://api-beta.kenall.jp/v1/postalcode/

パラメータ#

名前必須かどうか説明値の例
qstring必須検索クエリ。クエリの仕様については別項を参照のこと。神奈川県 AND 日本郵便
offsetnumber省略可結果を取得するオフセット値。省略した場合は0と見なされる。0
limitnumber省略可最大取得件数を指定する。1以上100以下の値を指定できる。50
facetstring省略可取得したいファセットの階層を指定する。/宮城県

検索クエリの仕様#

  • 検索ワードは2文字以上で、部分一致します。

  • 検索ワードは一つ以上の半角スペース、タブまたは改行文字で区切ります。

  • 検索ワードの間に AND もしくは OR といったキーワード文字列を挟むと、「かつ」「もしくは」といった条件で検索が可能です。キーワード文字列がない場合は「かつ」となります。

    (例1) 神奈川県 AND 日本郵便 → 「神奈川県」「日本郵便」の両方を含むレコードを検索する。

    (例2) 神奈川県 OR 日本郵便 → 「神奈川県」もしくは「日本郵便」 (またはその両方) を含むレコードを検索する。

    (例3) 神奈川県 日本郵便 → 「神奈川県」「日本郵便」の両方を含むレコードを検索する。

  • 特定の項目のみを対象に検索を行いたいときは、項目名に続けて : (半角コロン) を記述し、その後にキーワード文字列を記載します。

    (例) 京都の通り名に「上る」を含む京都市上京区の住所を取得する

    city:京都市上京区 AND kyoto_street:上る

  • 特定のファセットの階層以下の情報を取得したい場合は下記のクエリを使用します。

    (例1)_facet:/宮城県

    (例2)_facet:/宮城県/仙台市宮城野区

ファセット#

ファセットのパス名は必ず / で始まり、各階層は / で区切られます。ルート階層は /で表されます。

データの種類の指定#

デフォルトでは、郵便番号データと個別事業所番号データの両方を検索します。どちらか片方を検索する場合は、以下の検索オプションを指定してください。

  • 郵便番号データのみを検索する場合: _type:1
    • 例: 東京都 AND _type:1
  • 個別事業所番号データのみを検索する場合: _type:2
    • 例: prefecture:神奈川県 AND city:横浜市中区 AND _type:2

レスポンス#

以下はレスポンスの一例です。

{  "version": "2021-02-26",  "query": "神奈川県 AND 日本郵便",  "count": 3,  "offset": 0,  "limit": 100,  "facets": [    [      "/神奈川県", 3    ]  ],  "data": [    {      "jisx0402": "14131",      "old_code": "210",      "postal_code": "2108797",      "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": "1-2",        "post_office": "川崎港",        "code_type": 0      }    },    {      "jisx0402": "14131",      "old_code": "210",      "postal_code": "2108796",      "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": "1-2",        "post_office": "川崎港",        "code_type": 0      }    },    {      "jisx0402": "14131",      "old_code": "210",      "postal_code": "2108793",      "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": "1-2",        "post_office": "川崎港",        "code_type": 0      }    }  ]}

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

名前説明
versionstringデータのバージョン番号。YYYY-MM-DD形式の、データ作成日付となっている。
dataarray郵便区画レコードの配列
querystringq パラメータに与えられたクエリ文字列神奈川県 AND 日本郵便
countnumberクエリに合致したレコードの総数 (dataプロパティに返却されるレコードの数ではなく、合致したすべてのレコードの件数)42
offsetnumberoffset パラメータに与えられたオフセット0
limitnumberlimit パラメータに与えられた最大取得件数50
facetsarrayfacet パラメータが与えられた場合のみ、パラメータで示されたファセット階層配下のファセットとそのファセットに含まれるレコードの数のペアの配列[[""/東京都"", 1], [""/神奈川県"", 3]]

郵便区画レコードの仕様は、郵便番号APIのものと同一です。

GET /cities/:都道府県コード#

郵便番号データ内に存在する都道府県・市区町村のうち、指定された都道府県内の全ての市区町村の一覧を返します。

リソースURL#

https://api.kenall.jp/v1/cities/:都道府県コード

パラメータ#

名前必須かどうか説明
都道府県コードstring必須JIS X 0401 で定義された、都道府県コード。https://api.kenall.jp/v1/cities/01

レスポンス#

["version": "2021-02-26",  "data": [    {      "jisx0402": "13101",      "prefecture_code": "13",      "city_code": "101",      "prefecture_kana": "トウキョウト",      "city_kana": "チヨダク",      "prefecture": "東京都",      "city": "千代田区"    },...]

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

名前説明
versionstringデータのバージョン番号。YYYY-MM-DD形式の、データ作成日付となっている。
dataarray市区町村レコードの配列

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

名前説明
jisx0402string全国地方公共団体コード(JIS X 0401、X 0402)13101
prefecture_codestring都道府県コード(JIS X 0401)13
city_codestring市区町村コード(JIS X 0402)101
prefecture_kanastring都道府県名(全角カナ)トウキョウト
city_kanastring市区町村名(全角カナ)チヨダク
prefecturestring都道府県名東京都
citystring市区町村名千代田区

都道府県コード#

都道府県コードは、JIS X 0401 で定義されている、都道府県毎に付与された数字2桁のコードです。

市区町村APIを使う際に必要になりますので、以下のJSONコードをご利用ください。

{   "北海道":"01",   "青森県":"02",   "岩手県":"03",   "宮城県":"04",   "秋田県":"05",   "山形県":"06",   "福島県":"07",   "茨城県":"08",   "栃木県":"09",   "群馬県":"10",   "埼玉県":"11",   "千葉県":"12",   "東京都":"13",   "神奈川県":"14",   "新潟県":"15",   "富山県":"16",   "石川県":"17",   "福井県":"18",   "山梨県":"19",   "長野県":"20",   "岐阜県":"21",   "静岡県":"22",   "愛知県":"23",   "三重県":"24",   "滋賀県":"25",   "京都府":"26",   "大阪府":"27",   "兵庫県":"28",   "奈良県":"29",   "和歌山県":"30",   "鳥取県":"31",   "島根県":"32",   "岡山県":"33",   "広島県":"34",   "山口県":"35",   "徳島県":"36",   "香川県":"37",   "愛媛県":"38",   "高知県":"39",   "福岡県":"40",   "佐賀県":"41",   "長崎県":"42",   "熊本県":"43",   "大分県":"44",   "宮崎県":"45",   "鹿児島県":"46",   "沖縄県":"47"}