Skip to main content

Crate gbiz_info_api

Crate gbiz_info_api 

Source
Expand description

gBizINFO REST API (v2) の Rust クライアント。

gBizINFO は経済産業省が提供する法人情報サイトで、法人として登記されている約400万社を対象に、 法人番号・法人名・本社所在地に加え、届出・認定、表彰、財務、特許、調達、補助金、職場情報などの 法人活動情報を取得できる。

§セットアップ

API トークンを Web API利用申請で取得し、 GbizInfoClient::new に渡す。

§使い方

use gbiz_info_api::{GbizInfoClient, HojinSearchQuery, UpdateInfoQuery};

let client = GbizInfoClient::new("YOUR_API_TOKEN");

// 法人検索
let res = client
    .search(&HojinSearchQuery::new().name("トヨタ自動車").limit(10))
    .await?;
for info in res.into_hojin_infos() {
    println!("{}", info.name.unwrap_or_default());
}

// 法人番号を指定して基本情報を取得
let res = client.hojin("1180301018771").await?;

// メタデータ(出典元・最終更新日等)付きで財務情報を取得
let res = client.finance("1180301018771").metadata_flg(true).await?;

// 期間内に追加/更新された法人基本情報を取得(ページング付き)
let res = client
    .update_info(&UpdateInfoQuery::new("20260401", "20260430"))
    .await?;

§エラーハンドリング

すべての API 呼び出しは Result<_, GbizError> を返す。 HTTP ステータスエラーはレスポンスボディ付きの GbizError::Status になる。

match client.hojin("0000000000000").await {
    Ok(res) => { /* ... */ }
    Err(err) if err.is_not_found() => eprintln!("法人が見つかりません"),
    Err(GbizError::Status { status, body }) => eprintln!("API エラー {status}: {body}"),
    Err(err) => eprintln!("通信エラー等: {err}"),
}

§対応エンドポイント

GbizInfoClient のメソッドエンドポイントレスポンス
searchGET /v2/hojinSearchResponse
hojinGET /v2/hojin/{corporate_number}HojinResponse
certificationGET /v2/hojin/{corporate_number}/certificationHojinChildResponse
commendationGET /v2/hojin/{corporate_number}/commendationHojinChildResponse
corporationGET /v2/hojin/{corporate_number}/corporationHojinChildResponse
financeGET /v2/hojin/{corporate_number}/financeHojinChildResponse
patentGET /v2/hojin/{corporate_number}/patentHojinChildResponse
procurementGET /v2/hojin/{corporate_number}/procurementHojinChildResponse
subsidyGET /v2/hojin/{corporate_number}/subsidyHojinChildResponse
workplaceGET /v2/hojin/{corporate_number}/workplaceHojinChildResponse
update_infoGET /v2/hojin/updateInfoUpdateInfoHojinResponse
update_info_certificationGET /v2/hojin/updateInfo/certificationUpdateInfoChildResponse
update_info_commendationGET /v2/hojin/updateInfo/commendationUpdateInfoChildResponse
update_info_corporationGET /v2/hojin/updateInfo/corporationUpdateInfoChildResponse
update_info_financeGET /v2/hojin/updateInfo/financeUpdateInfoChildResponse
update_info_patentGET /v2/hojin/updateInfo/patentUpdateInfoChildResponse
update_info_procurementGET /v2/hojin/updateInfo/procurementUpdateInfoChildResponse
update_info_subsidyGET /v2/hojin/updateInfo/subsidyUpdateInfoChildResponse
update_info_workplaceGET /v2/hojin/updateInfo/workplaceUpdateInfoChildResponse

§関連リンク

Re-exports§

pub use client::DetailRequest;
pub use client::GbizInfoClient;
pub use client::GbizInfoClientBuilder;
pub use client::DEFAULT_BASE_URL;
pub use error::GbizError;
pub use query::HojinSearchQuery;
pub use query::UpdateInfoQuery;
pub use types::*;

Modules§

client
gBizINFO REST API (v2) のクライアント実装。
error
gBizINFO API のエラー型定義。
query
gBizINFO REST API (v2) のリクエストクエリ定義。
types
gBizINFO REST API (v2) のレスポンス型定義。