chibanjp-client

ChibanJP の公式軽量クライアントライブラリです。緯度経度から地番（登記所備付地図データ）を検索するAPIを、TypeScript/JavaScriptから型付きで呼び出せます。

• 依存パッケージなし（ランタイムは標準の fetch / URL のみ）
• Node.js 18+、ブラウザ、Cloudflare Workers、Deno、Bunで動作
• ESM専用
• APIキーは姉妹サービス ReverseGeoJP と共通です

インストール

npm install chibanjp-client

APIキーの取得

reversegeojp.com でアカウント登録すると発行されます（ChibanJP・ReverseGeoJPで共通のAPIキーです）。

使い方

import { ChibanJPClient } from 'chibanjp-client';

const client = new ChibanJPClient(process.env.CHIBANJP_API_KEY!);

const parcel = await client.parcel(35.6595, 139.6987);
console.log(parcel);
// { chiban: '1', oaza: '道玄坂二丁目', city: '渋谷区', precision: '甲三', representative_point: { lat: 35.6595, lon: 139.6987 }, dataset_version: 'v1' }

対応地域は東京都・大阪府・北海道・愛知県・神奈川県・兵庫県・福岡県・長野県の8都道府県です（出典と精度）。

エラーハンドリング

import { ChibanJPClient, ChibanJPError } from 'chibanjp-client';

try {
  await client.parcel(35.6595, 139.6987);
} catch (e) {
  if (e instanceof ChibanJPError) {
    console.error(e.status, e.code, e.message, e.requestId);
  }
}

API

new ChibanJPClient(apiKey, options?)

• options.baseUrl — 既定は https://api.chibanjp.com
• options.fetch — カスタムfetch実装を注入したい場合に指定

client.parcel(lat, lon): Promise<ParcelResult>

詳細な型定義は dist/index.d.ts を参照してください。

ライセンス

MIT