Skip to main content

ケンオールAPI概要

このページでは、ケンオールで提供しているAPIの概要について説明します。

使用例のシェルスクリプトは、特に注釈がない限り、bashを用いています。

郵便番号検索API#

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

APIリファレンス

使用例#

curl -H "Authorization: Token $YOUR_API_KEY" \https://api.kenall.jp/v1/postalcode/1000001 \| jq

レスポンスは以下の通りです。

{  "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    }  ]}

デモ#

https://kenall.jp/features/postalcode

郵便番号データダウンロードAPI#

info

本APIは、エンタープライズプランご購入のお客様のみが利用できます。

郵便番号データ全体を一括でダウンロードすることができます。

データは json 形式となっていて、郵便番号検索APIと同様のフォーマットになっています。

ダウンロードしたデータはxz 形式で圧縮されています。

APIリファレンス

使用例#

ダウンロードしたデータを展開して保存する場合、以下のようにcurlコマンドを実行します。

curl -L -H "Authorization: Token $YOUR_API_KEY" \https://api.kenall.jp/v1/download/postalcode/latest/kenall.json.xz \| xz -cd > kenall.json

郵便番号逆引き検索API#

caution

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

APIリファレンス

郵便番号・個別事業所番号逆引き検索APIは、郵便番号データや個別事業所番号データに記載されている以下の項目に対して全文検索を行うAPIです。

  • 都道府県名 (prefecture)
  • 市区町村名 (city)
  • 街区町域 (town)
  • 街区町域名の読み仮名 (town_kana_raw)
  • 小字 (koaza)
  • 京都の通り名 (kyoto_street)
  • 建物名 (building)
  • 階層 (floor)
  • 小字名、丁目、番地等 (block_lot)
  • 事業所名 (corporation)
  • 事業所名の読み仮名 (corporation_kana)

インデックスは、「都道府県名」「市区町村名」で階層化されており、検索結果にファセットを含めることが可能です。ファセットとは、合致するレコードの件数を階層ごとに数え上げたものです。

例えば /東京都 というファセットの配下にある /東京都/中央区 /東京都/港区/神奈川県 というファセットの配下にある /神奈川県/横浜市 /神奈川県/川崎市 のような副階層を考えた時、合致した 8 件のレコードのファセットごとの内訳が/東京都/中央区 については 1 件、 /東京都/港区 については 2 件、/神奈川県/横浜市 については 2 件、 /神奈川県/川崎市 については 3 件だとしたら、 /東京都というパスのファセットに合致するレコード数は 3 件、/神奈川県というパスのファセットに合致するレコード数は 5 件、となります。

使用例#

curl -H "Authorization: Token $YOUR_API_KEY" \https://api-beta.kenall.jp/v1/postalcode/\?q\=東京都\&limit\=1 \| jq

レスポンスは以下の通りです。

{  "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      }    }  ],  "query": "東京都",  "count": 8880,  "offset": 0,  "limit": 1,  "facets": null}

市区町村API#

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

APIリファレンス

使用例#

curl -H "Authorization: Token $YOUR_API_KEY" \https://api.kenall.jp/v1/cities/13 \| jq '.data[0]'

レスポンスは以下の通りです。

{  "jisx0402": "13101",  "prefecture_code": "13",  "city_code": "101",  "prefecture_kana": "トウキョウト",  "city_kana": "チヨダク",  "prefecture": "東京都",  "city": "千代田区"}

デモ#

https://codepen.io/kenall/pen/jOVjpgz

自己IPアドレス確認API#

アクセス元の IP アドレスを取得することができます。

APIリファレンス

使用例#

curl -s -H "Authorization: Token $YOUR_API_KEY" \https://api.kenall.jp/v1/whoami \| jq

レスポンスは以下の通りです。

{  "remote_addr": {    "type": "v4",    "address": "<IPアドレス>"  }}

法人番号API#

法人番号や法人名、住所などを元に、法人情報リソースを取得します。

APIリファレンス

使用例: 法人番号検索#

指定された法人番号に対応する最新の法人情報リソースを取得します。

curl -H "Authorization: Token $YOUR_API_KEY" \https://api.kenall.jp/v1/houjinbangou/2021001052596 \| jq

レスポンスは以下の通りです。

{  "version": "2021-08-20",  "data": {    "published_date": "2021-07-30",    "sequence_number": "1391194",    "corporate_number": "2021001052596",    "process": "12",    "correct": "0",    "update_date": "2021-01-12",    "change_date": "2021-01-04",    "name": "株式会社オープンコレクター",    "name_image_id": null,    "kind": "301",    "prefecture_name": "東京都",    "city_name": "千代田区",    "street_number": "麹町3丁目12-14麹町駅前ヒルトップ8階",    "address_image_id": null,    "jisx0402": "13101",    "post_code": "1020083",    "address_outside": "",    "address_outside_image_id": null,    "close_date": null,    "close_cause": null,    "successor_corporate_number": null,    "change_cause": "",    "assignment_date": "2015-10-05",    "en_name": "",    "en_prefecture_name": "Tokyo",    "en_address_line": "",    "en_address_outside": "",    "furigana": "オープンコレクター",    "hihyoji": "0"  }}

使用例: 法人名・住所検索#

法人名や住所などを元に、該当する法人情報リソースを取得します。

法人名・住所検索APIには以下の特長があります。

  • 非標準文字での検索に対応
  • 完全一致検索に対応。法人種別抜き・込みを選択可能
  • ファセット検索による絞り込みに対応
 curl -s -G -H "Authorization: Token $YOUR_API_KEY" \--data-urlencode "q=府庁" \--data-urlencode "limit=1" \--data-urlencode "facet_area=/" \--data-urlencode "facet_kind=/" \--data-urlencode "facet_process=/" \--data-urlencode "facet_close_cause=/" \https://api.kenall.jp/v1/houjinbangou | jq

レスポンスは以下の通りです。

{  "version": "2021-08-27",  "data": [    {      "published_date": "2021-07-30",      "sequence_number": "3447172",      "corporate_number": "4130005004608",      "process": "1",      "correct": "1",      "update_date": "2020-07-30",      "change_date": "2015-10-05",      "name": "京都府庁生活協同組合",      "name_image_id": null,      "kind": "399",      "prefecture_name": "京都府",      "city_name": "京都市上京区",      "street_number": "京都府庁内",      "address_image_id": null,      "jisx0402": "26102",      "post_code": "6020000",      "address_outside": "",      "address_outside_image_id": null,      "close_date": null,      "close_cause": null,      "successor_corporate_number": null,      "change_cause": "",      "assignment_date": "2015-10-05",      "en_name": "",      "en_prefecture_name": "",      "en_address_line": "",      "en_address_outside": "",      "furigana": "キョウトフチョウセイカツ",      "hihyoji": "0"    }  ],  "query": "府庁",  "count": 22,  "offset": 0,  "limit": 1,  "facets": {    "area": [      ["/京都府", 19],      ["/大阪府", 2],      ["/東京都", 1]    ],    "kind": [      ["/その他", 2],      ["/その他の設立登記法人", 14],      ["/合同会社", 2],      ["/地方公共団体", 1],      ["/有限会社", 1],      ["/株式会社", 1],      ["/行政機関など", 1]    ],    "process": [      ["/吸収合併", 1],      ["/国内所在地の変更", 1],      ["/新規", 17],      ["/登記記録の閉鎖等", 3]    ],    "close_cause": [      ["/その他", 19],      ["/その他の清算の結了等", 1],      ["/合併による解散等", 1],      ["/登記官による閉鎖", 1]    ]  }}

デモ#

https://kenall.jp/features/houjinbangou