郵便番号検索 APIリファレンス
APIリクエストURI：https://zipcode.milkyfieldcompany.com/api/v1/
共通
メソッド名は、APIリクエストURIに連結してください。
ex) https://zipcode.milkyfieldcompany.com/api/v1/version
返却値は JSON形式 でレスポンスします。
JSONP形式 を希望する場合は、callback パラメータに実行先の関数名を指定してください。
UTF-8での返却を希望する場合は、esc パラメータに off を指定してください。
指定しない場合は、Unicodeエスケープシーケンスで返却します。
バージョン取得(郵便番号)
メソッド名：version郵便番号検索サービスで提供している郵便番号データの更新日を取得します。
パラメータ：なし
返却値：
status：api実行状態
ex) success ：成功
VersionText：データベースの更新日を返却します。
ex) 2020/06/30
バージョン取得(法人番号)
メソッド名：houjinversion郵便番号検索サービスで提供している法人番号データの更新日を取得します。
パラメータ：なし
返却値：
status：api実行状態
ex) success ：成功
VersionText：データベースの更新日を返却します。
ex) 2021/10/29
郵便番号から住所検索
メソッド名：findaddr郵便番号から住所を検索します。
検索結果が複数ある場合には、最大で1,500件まで返却します。
一致する住所地がない場合は近隣の住所を返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
zipcode：検索したい7桁の郵便番号を指定します。
ex) 4520961 / 9218046 etc...
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降(*2)
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
JigyoushoName(*2)：事業所名
JigyoushoKana(*2)：事業所名(カナ)
※1 カナ返却プランの場合に返却
※2 事業所郵便番号で検索した場合に返却
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降(*2)
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
JigyoushoName(*2)：事業所名
JigyoushoKana(*2)：事業所名(カナ)
※1 カナ返却プランの場合に返却
※2 事業所郵便番号で検索した場合に返却
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
住所から郵便番号検索
メソッド名：findzipcode住所から郵便番号を検索します。
住所途中で地名の文字不足(文字抜け・脱字)も考慮して逆検索をします。
また、新旧字体の違いを考慮するように機能を追加いたしました。
１１丁目・11丁目・十一丁目など、漢数字や全角半角数字も同じ条件で検索します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
address：検索したい住所や地名を指定します。
ex1) 六本木
※地名の一部でも検索し、部分一致する結果を返却します。
ex2) 京都市 栄町
※全角/半角スペースで区切ることでスペース部分に任意の文字が含まれる文言として部分一致検索します。
ex3) 福岡県紫野市立明寺
※福岡県筑紫野市立明寺 が正しいですが、住所文字列から文字が不足していても独自の検索アルゴリズムで特定し、結果を返却します。
※地名の一部でも検索し、部分一致する結果を返却します。
ex2) 京都市 栄町
※全角/半角スペースで区切ることでスペース部分に任意の文字が含まれる文言として部分一致検索します。
ex3) 福岡県紫野市立明寺
※福岡県筑紫野市立明寺 が正しいですが、住所文字列から文字が不足していても独自の検索アルゴリズムで特定し、結果を返却します。
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
zipcode：郵便番号
address：住所
addresskana：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名
componentskana(※1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
zipcode：郵便番号
address：住所
addresskana：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名
componentskana(※1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
脱字住所から郵便番号検索（非推奨）
メソッド名：findzipcodeambgこのAPIは過去の互換性のために残しております。
住所から郵便番号検索は結果返却性能を向上させており、そちらでも文字抜け(脱字)に対応した検索が可能ですので、そちらをご利用ください。
住所から郵便番号を強く検索します。
findzipcodeメソッドと同様ですが、住所途中の文字抜けにも対応させた逆検索をします。
検索結果が複数ある場合には、最大で1,500件まで返却します。
findzipcodeメソッドで意図した結果が取得できない場合に利用すると特定できる可能性があります。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
address：検索したい住所や地名を指定します。
ex1) 福岡県紫野市立明寺
※福岡県筑紫野市立明寺 が正しいですが、住所文字列から文字が不足していても独自の検索アルゴリズムで結果を特定して返却します。
ex2) 京都市 栄町
※全角/半角スペースで区切ると findzipcodeメソッド と同じ結果を返却します。
※福岡県筑紫野市立明寺 が正しいですが、住所文字列から文字が不足していても独自の検索アルゴリズムで結果を特定して返却します。
ex2) 京都市 栄町
※全角/半角スペースで区切ると findzipcodeメソッド と同じ結果を返却します。
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
zipcode：郵便番号
address：住所
addresskana：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名
componentskana(※1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
zipcode：郵便番号
address：住所
addresskana：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名
componentskana(※1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
事業所検索
メソッド名：findoffice事業所名から入力さらた文字列で部分一致検索し、事業所(企業など)のリストを返却します。
検索結果が複数ある場合には、最大で1,500件まで返却します。
事業所郵便番号詳細情報は、getofficeinfメソッドを使用して取得します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
office：検索したい事業所名(企業名など)を指定します。
ex1) 総務省
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
rid：事業所郵便番号情報のレコードID（事業所郵便番号情報取得[getofficeinfメソッド]で使用可能）
o：事業所名(企業名など)
rid：事業所郵便番号情報のレコードID（事業所郵便番号情報取得[getofficeinfメソッド]で使用可能）
o：事業所名(企業名など)
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
法人検索
メソッド名：findhoujin国税庁の法人番号データを用いて[商号又は名称]から入力された文字列で部分一致検索もしくは、所在地から検索し、法人情報のリストを返却します。
検索結果が複数ある場合には、最大で10,000件まで返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
n：法人番号または適格請求書発行事業者登録番号(T+13桁の数字)を指定します。完全一致検索します。(省略可能)
name：事業所名(企業名など)を２文字以上指定します。(省略可能)
商号又は名称・フリガナ・英語表記に登録されている内容から部分一致検索します。
postcode：郵便番号を指定します。該当する企業情報を完全一致検索します。(省略可能)
kind：法人種別(数値3桁)を指定します。該当する企業情報を完全一致検索します。(省略可能)
指定できる法人種別は返却値の法人種別をご参照ください。
p：都道府県名を指定します。該当する企業情報を完全一致検索します。(省略可能)
c：市区町村を指定します。該当する企業情報を完全一致検索します。(省略可能)
省略可能なパラメータを1つ以上指定してください。
各パラメータを組み合わせると絞り込み検索を行えます。
都道府県名と市区町村は、指定パラメータ数が2つ以上となった場合に適用となります。(pとc、nameとcなど)
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
corporateNumber: 法人番号(13桁)。
法人番号の指定を受けた者（以下「法人番号保有者」という。）の法人番号を示すデータ項目。
process: 処理区分。
法人番号の指定、商号又は所在地に変更等が発生した事由をコード値で表す項目。
※英語表記及びフリガナの登録並びに検索対象除外の情報の更新に係る処理区分はありません
（これらの項目は、提供済みのデータに英語表記若しくはフリガナの登録又は検索対象除外の情報を追加した上で、訂正データとして提供するため）。
01:新規
11:商号又は名称の変更
12:国内所在地の変更
13:国外所在地の変更
21:登記記録の閉鎖等
22:登記記録の復活等
71:吸収合併
72:吸収合併無効
81:商号の登記の抹消
99:削除
correct: 訂正区分。
処理区分が「99：削除」の場合は、訂正区分はブランクとなる。
0:訂正以外
1:訂正
updateDate: 更新年月日(YYYY-MM-DD)
法務省等からデータを受け取り、当庁でデータを更新した日付を表す。
changeDate: 変更年月日(YYYY-MM-DD)
事由が発生した日付を表すデータ項目。
○処理区分が新規（01）の場合
法人番号が指定された年月日を意味する。
○処理区分が新規（01）以外の場合
・設立登記法人：処理区分の事由に係る登記年月日を意味する。
・設立登記法人以外：処理区分の事由が生じた年月日を意味する。
name: 商号又は名称
法人番号保有者の商号又は名称を示すデータ項目。
商号又は名称の文字数が、150文字を超過した場合、151文字目以降の文字は格納されないため、151文字目以降の情報は、イメージファイルを閲覧することにより確認することができる。
nameImageId: "商号又は名称イメージID
商号又は名称イメージIDは、イメージファイルを閲覧するために指定する値（情報）。
当該データ項目は、商号又は名称にJIS第１・第２水準以外の文字を使用している場合及び商号又は名称の文字数が150文字を超過した場合に値を設定する項目。
なお、当該イメージIDの値を設定したURL※でアクセスすることにより、国税庁法人番号公表サイトの検索画面で確認できるイメージファイルと同様のイメージファイルを直接閲覧することができる。
※（https://www.houjin-bangou.nta.go.jp/image?imageid=イメージID）
各システムの画面にイメージファイルを表示したいなどの要件がある場合に活用することができる。
kind: 法人種別
法人種別を判別するためのデータ項目。
例えば、データの取込み処理を行う場合などにおいて、処理対象として必要としない法人（組織区分）のデータを、法人種別のコード値を利用して除外設定を行うなどの活用が考えられるために提供する項目。
コード化した法人種別は、以下のとおり。
101:国の機関
201:地方公共団体
301:株式会社
302:有限会社
303:合名会社
304:合資会社
305:合同会社
399:その他の設立登記法人
401:外国会社等
499:その他
prefectureName: 国内所在地（都道府県）
cityName: 国内所在地（市区町村）
streetNumber: 国内所在地（丁目番地等）
addressImageId: 国内所在地イメージID
国内所在地イメージIDは、イメージファイルを閲覧するために指定する値（情報）。
当該データ項目は、国内所在地にJIS第１・第２水準以外の文字を使用している場合及び国内所在地の文字数が300文字を超過した場合に値を設定する項目。
なお、当該イメージIDの値を設定したURL※でアクセスすることにより、国税庁法人番号公表サイトの検索画面で確認できるイメージファイルと同様のイメージファイルを直接閲覧することができる。
※（https://www.houjin-bangou.nta.go.jp/image?imageid=イメージID）
各システムの画面にイメージファイルを表示したいなどの要件がある場合に活用することができる。
prefectureCode: 都道府県コード(JIS X 0401)
データを取り込み、名寄せ作業や不要なデータを識別する際、当該コードを活用することにより、効率的な作業を行うことができる。
都道府県コード及び市区町村コードの詳細については、以下のURL※（日本産業標準調査会/データベース検索）を参照のこと。
※（https://www.jisc.go.jp/）
cityCode: 市区町村コード(JIS X 0402)
postCode: 郵便番号
国内所在地の文字情報を基に設定した郵便番号。
全国町・字ファイルを基に設定しているため、所在地に外字が含まれる場合や、誤字脱字がある場合には、正確な郵便番号が設定されていない場合がある。
なお、同一の字・大字内の特定の地番に付される郵便番号や、ビルや大口事業所に係る個別郵便番号には対応していない。
addressOutside: 国外所在地
addressOutsideImageId: 国外所在地イメージID
closeDate: 登記記録の閉鎖等年月日
closeCause: 登記記録の閉鎖等の事由
successorCorporateNumber: 承継先法人番号
changeCause: 変更事由の詳細
assignmentDate: 法人番号指定年月日
latest: 最新履歴
enName: 商号又は名称（英語表記）
enPrefectureName: 国内所在地（都道府県）(英語表記）
enCityName: 国内所在地（市区町村丁目番地等）（英語表記）
enAddressOutside: 国外所在地（英語表記）
furigana: フリガナ
hihyoji: 検索対象除外。設立登記法人のうち、登記上の所在地が、住居表示の実施や区画整理等で既に廃止されており、現在では存在しない住所表記となっていることが確認できた法人について、検索対象から除外していることを示すデータ項目。なお、この情報は法人単位で設定しており、データ提供時点の情報を表している。
値「0」は、検索対象となっている情報であることを意味する。
値「1」は、検索対象から除外した情報であることを意味する。
invoiceRegist: 国税庁への適格請求書発行事業者登録の有無(1:登録済み 0:未登録)
invoiceRegistratedNumber: 適格請求書発行事業者登録番号
invoiceValid: 適格請求書発行事業者の状態(1:有効 0:無効)
invoiceTradeName: 適格請求書発行事業者の主たる屋号
invoiceName: 適格請求書発行事業者の氏名又は名称
invoiceLastUpdateDate: 適格請求書発行事業者の情報データベース最終更新日
invoiceRegistrationDate: 適格請求書発行事業者の登録年月日
invoiceUpdateDate: 適格請求書発行事業者の更新年月日
invoiceDisposalDate: 適格請求書発行事業者の取消年月日(※取消し状態の場合に返却)
invoiceExpireDate: 適格請求書発行事業者の失効年月日(※失効状態の場合に返却)
invoiceAnnouncement: 適格請求書発行事業者の公表情報
※適格請求書発行事業者に関する情報は、返却件数が1件の場合に付加します。
※適格請求書発行事業者が個人事業主の場合には、invoice〜で始まる項目を返却します。
※公表情報は、「基本+カナ」プランでご利用の場合にのみ提供いたします。
※このサービスは、国税庁適格請求書発行事業者公表システムのWeb-API機能を利用して取得した情報をもとに作成しておりますが、サービスの内容は国税庁によって保証されたものではありません。
corporateNumber: 法人番号(13桁)。
法人番号の指定を受けた者（以下「法人番号保有者」という。）の法人番号を示すデータ項目。
process: 処理区分。
法人番号の指定、商号又は所在地に変更等が発生した事由をコード値で表す項目。
※英語表記及びフリガナの登録並びに検索対象除外の情報の更新に係る処理区分はありません
（これらの項目は、提供済みのデータに英語表記若しくはフリガナの登録又は検索対象除外の情報を追加した上で、訂正データとして提供するため）。
01:新規
11:商号又は名称の変更
12:国内所在地の変更
13:国外所在地の変更
21:登記記録の閉鎖等
22:登記記録の復活等
71:吸収合併
72:吸収合併無効
81:商号の登記の抹消
99:削除
correct: 訂正区分。
処理区分が「99：削除」の場合は、訂正区分はブランクとなる。
0:訂正以外
1:訂正
updateDate: 更新年月日(YYYY-MM-DD)
法務省等からデータを受け取り、当庁でデータを更新した日付を表す。
changeDate: 変更年月日(YYYY-MM-DD)
事由が発生した日付を表すデータ項目。
○処理区分が新規（01）の場合
法人番号が指定された年月日を意味する。
○処理区分が新規（01）以外の場合
・設立登記法人：処理区分の事由に係る登記年月日を意味する。
・設立登記法人以外：処理区分の事由が生じた年月日を意味する。
name: 商号又は名称
法人番号保有者の商号又は名称を示すデータ項目。
商号又は名称の文字数が、150文字を超過した場合、151文字目以降の文字は格納されないため、151文字目以降の情報は、イメージファイルを閲覧することにより確認することができる。
nameImageId: "商号又は名称イメージID
商号又は名称イメージIDは、イメージファイルを閲覧するために指定する値（情報）。
当該データ項目は、商号又は名称にJIS第１・第２水準以外の文字を使用している場合及び商号又は名称の文字数が150文字を超過した場合に値を設定する項目。
なお、当該イメージIDの値を設定したURL※でアクセスすることにより、国税庁法人番号公表サイトの検索画面で確認できるイメージファイルと同様のイメージファイルを直接閲覧することができる。
※（https://www.houjin-bangou.nta.go.jp/image?imageid=イメージID）
各システムの画面にイメージファイルを表示したいなどの要件がある場合に活用することができる。
kind: 法人種別
法人種別を判別するためのデータ項目。
例えば、データの取込み処理を行う場合などにおいて、処理対象として必要としない法人（組織区分）のデータを、法人種別のコード値を利用して除外設定を行うなどの活用が考えられるために提供する項目。
コード化した法人種別は、以下のとおり。
101:国の機関
201:地方公共団体
301:株式会社
302:有限会社
303:合名会社
304:合資会社
305:合同会社
399:その他の設立登記法人
401:外国会社等
499:その他
prefectureName: 国内所在地（都道府県）
cityName: 国内所在地（市区町村）
streetNumber: 国内所在地（丁目番地等）
addressImageId: 国内所在地イメージID
国内所在地イメージIDは、イメージファイルを閲覧するために指定する値（情報）。
当該データ項目は、国内所在地にJIS第１・第２水準以外の文字を使用している場合及び国内所在地の文字数が300文字を超過した場合に値を設定する項目。
なお、当該イメージIDの値を設定したURL※でアクセスすることにより、国税庁法人番号公表サイトの検索画面で確認できるイメージファイルと同様のイメージファイルを直接閲覧することができる。
※（https://www.houjin-bangou.nta.go.jp/image?imageid=イメージID）
各システムの画面にイメージファイルを表示したいなどの要件がある場合に活用することができる。
prefectureCode: 都道府県コード(JIS X 0401)
データを取り込み、名寄せ作業や不要なデータを識別する際、当該コードを活用することにより、効率的な作業を行うことができる。
都道府県コード及び市区町村コードの詳細については、以下のURL※（日本産業標準調査会/データベース検索）を参照のこと。
※（https://www.jisc.go.jp/）
cityCode: 市区町村コード(JIS X 0402)
postCode: 郵便番号
国内所在地の文字情報を基に設定した郵便番号。
全国町・字ファイルを基に設定しているため、所在地に外字が含まれる場合や、誤字脱字がある場合には、正確な郵便番号が設定されていない場合がある。
なお、同一の字・大字内の特定の地番に付される郵便番号や、ビルや大口事業所に係る個別郵便番号には対応していない。
addressOutside: 国外所在地
addressOutsideImageId: 国外所在地イメージID
closeDate: 登記記録の閉鎖等年月日
closeCause: 登記記録の閉鎖等の事由
successorCorporateNumber: 承継先法人番号
changeCause: 変更事由の詳細
assignmentDate: 法人番号指定年月日
latest: 最新履歴
enName: 商号又は名称（英語表記）
enPrefectureName: 国内所在地（都道府県）(英語表記）
enCityName: 国内所在地（市区町村丁目番地等）（英語表記）
enAddressOutside: 国外所在地（英語表記）
furigana: フリガナ
hihyoji: 検索対象除外。設立登記法人のうち、登記上の所在地が、住居表示の実施や区画整理等で既に廃止されており、現在では存在しない住所表記となっていることが確認できた法人について、検索対象から除外していることを示すデータ項目。なお、この情報は法人単位で設定しており、データ提供時点の情報を表している。
値「0」は、検索対象となっている情報であることを意味する。
値「1」は、検索対象から除外した情報であることを意味する。
invoiceRegist: 国税庁への適格請求書発行事業者登録の有無(1:登録済み 0:未登録)
invoiceRegistratedNumber: 適格請求書発行事業者登録番号
invoiceValid: 適格請求書発行事業者の状態(1:有効 0:無効)
invoiceTradeName: 適格請求書発行事業者の主たる屋号
invoiceName: 適格請求書発行事業者の氏名又は名称
invoiceLastUpdateDate: 適格請求書発行事業者の情報データベース最終更新日
invoiceRegistrationDate: 適格請求書発行事業者の登録年月日
invoiceUpdateDate: 適格請求書発行事業者の更新年月日
invoiceDisposalDate: 適格請求書発行事業者の取消年月日(※取消し状態の場合に返却)
invoiceExpireDate: 適格請求書発行事業者の失効年月日(※失効状態の場合に返却)
invoiceAnnouncement: 適格請求書発行事業者の公表情報
※適格請求書発行事業者に関する情報は、返却件数が1件の場合に付加します。
※適格請求書発行事業者が個人事業主の場合には、invoice〜で始まる項目を返却します。
※公表情報は、「基本+カナ」プランでご利用の場合にのみ提供いたします。
※このサービスは、国税庁適格請求書発行事業者公表システムのWeb-API機能を利用して取得した情報をもとに作成しておりますが、サービスの内容は国税庁によって保証されたものではありません。
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
都道府県リスト取得
メソッド名：getlistpref郵便番号データに含まれる都道府県名を検索し、リストで返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
s(省略可)：ソート順を指定します。(省略時はデータ順)
ex) kana：都道府県名のカナ順でソート
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
都道府県の配列を返却します。
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
市区町村リスト取得
メソッド名：getlistcities郵便番号データに含まれる、指定された都道府県に含まれる市区町村名を検索し、リストで返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
p：都道府県名を指定します。
ex) 東京都
s(省略可)：ソート順を指定します。(省略時はデータ順)
ex) kana：市区町村名のカナ順でソート
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
市区町村の配列を返却します。
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
町域リスト取得
メソッド名：getlisttowns郵便番号データに含まれる、指定された都道府県・市区町村名の町域を検索し、リストで返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
p：都道府県名を指定します。
ex) 東京都
c：市区町村名を指定します。
ex) 千代田区
s(省略可)：ソート順を指定します。(省略時はデータ順)
ex) kana：町域名のカナ順でソート
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
rid：郵便番号住所情報のレコードID（郵便番号住所情報取得[getzipinfメソッド]で使用可能） zipcode：郵便番号
townname：町域名
rid：郵便番号住所情報のレコードID（郵便番号住所情報取得[getzipinfメソッド]で使用可能） zipcode：郵便番号
townname：町域名
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
事業所リスト取得
メソッド名：getlistoffices事業所郵便番号データに含まれる、指定された都道府県・市区町村名から事業所を検索し、リストで返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
p：都道府県名を指定します。
ex) 東京都
c(省略可能)：市区町村名を指定します。
ex) 千代田区
s(省略可)：ソート順を指定します。(省略時はデータ順)
ex) kana：事業所名のカナ順でソート
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列とした1レコードを配列で返却します。
rid：事業所郵便番号情報のレコードID（事業所郵便番号情報取得[getofficeinfメソッド]で使用可能）
o：事業所名(企業名など)
rid：事業所郵便番号情報のレコードID（事業所郵便番号情報取得[getofficeinfメソッド]で使用可能）
o：事業所名(企業名など)
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
郵便番号住所情報取得
メソッド名：getzipinf郵便番号データに含まれる、指定された郵便番号詳細情報を返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
r：getlisttownsで取得した結果から、取得したい郵便番号住所情報のレコードIDを指定します。
ex) 37157
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
item：検索結果
次の項目を連想配列として1レコード返却します。
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降(*2)
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降(*2)
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
※1 カナ返却プランの場合に返却
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
事業所郵便番号情報取得
メソッド名：getofficeinf事業所郵便番号データに含まれる、指定された事業所郵便番号詳細情報を返却します。
パラメータ(post/get)：
apikey：マイページで発行したAPIキーを指定します。
findofficeメソッド、getlistofficesメソッドで取得した結果から、取得したい郵便番号住所情報のレコードIDを指定します。
ex) 4949
返却値：
status：api実行状態
ex) success：成功 / error：失敗
length：検索結果の件数
ex) 1
items：検索結果配列
次の項目を連想配列として1レコード返却します。
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
JigyoushoName：事業所名
JigyoushoKana：事業所名(カナ)
※1 カナ返却プランの場合に返却
zipcode：郵便番号
address：住所
addresskana(*1)：住所(カナ)
state：全国地方公共団体コード（JIS X0401、X0402）(5桁)
state_name：都道府県名称
components：(配列)都道府県、市区町村、町域名、以降
componentskana(*1)：(配列)都道府県(カナ)、市区町村(カナ)、町域名(カナ)
JigyoushoName：事業所名
JigyoushoKana：事業所名(カナ)
※1 カナ返却プランの場合に返却
message：statusがerrorの場合(失敗時)にエラー説明を返却します。
各APIの呼び出しについて
ご契約のプランごとにAPIの利用に関する制限を説明します。○の記載はリクエスト回数無制限でご利用可能です。
合計100回/日とあるAPIは、同日内にその回数を超えてリクエストした場合はエラーを返却します。
リクエスト回数はバージョン取得を除く各APIコール数の合算値であり、API個別の回数ではございません。
| フリー | 基本 | 基本+カナ | |
|---|---|---|---|
| バージョン取得(郵便番号) : version | ○ | ○ | ○ |
| バージョン取得(法人番号) : houjinversion | ○ | ○ | ○ |
| 郵便番号から住所検索 : findaddr | 合計100回/日 (カナを除く) |
○(カナを除く) | ○ |
| 住所から郵便番号検索 : findzipcode | ○(カナを除く) | ○ | |
| 脱字住所から郵便番号検索 : findzipcodeambg | 合計100回/日 (カナを除く) |
○ | |
| 事業所検索 : findoffice | ○ | ||
| 法人検索 : findhoujin | ○ | ||
| 都道府県リスト取得 : getlistpref | ○ | ||
| 市区町村リスト取得 : getlistcities | ○ | ||
| 町域リスト取得 : getlisttowns | ○ | ||
| 事業所リスト取得 : getlistoffices | ○ | ||
| 郵便番号住所情報取得 : getzipinf | ○ | ||
| 事業所郵便番号情報取得 : getofficeinf | ○ |
フリープランおよび基本プランでこれまでに提供していたAPIへのサービス内容に変更はありません。
新しく追加したAPIを含め、基本+カナプランは全APIを制限無くご利用可能です。
※ ベストエフォートでのサービスとなります。
※ 専用サーバーをご希望の場合は要件に応じてお見積もりいたしますので、問い合わせください。