dart_kenall

Description:

dart kenall

dart_kenall 🦈 #




Unofficial kenall (ケンオール) client written by Dart.
Kenall is the useful Japanese postal code API service.
The official document is here.
"ken" means "prefecture" in Japanese. 🗾
🚨 IMPORTANT: Package is unofficial. It may not support the latest API.
Recommended that you use it for simple applications.
Support APIs #

❌ GET /v1/download/postalcode
✅ GET /v1/postalcode/{郵便番号}
✅ GET /v1/postalcode/?q=...&offset=...&limit=...&facet=...
✅ GET /v1/cities/:都道府県コード
✅ GET /v1/whoami
✅ GET /v1/houjinbangou/{法人番号}
✅ GET /v1/houjinbangou/?q=...&offset=...&limit=...&facet=...

Usage #
Client #
import 'package:dart_kenall/dart_kenall.dart';

Future<void> main() async {
final config = Config(
apiKey: 'KENALL_API_KEY',
);
final kenallClient = KenallClient(config, http.Client());
final response = await kenallClient.getCities(
GetCitiesRequest(prefectureCode: prefectureCode['東京都']!),
);
print(response.cities[0].toJson());
// => {jisx0402: 13101, prefecture_code: 13, city_code: 101, prefecture_kana: トウキョウト, city_kana: チヨダク, prefecture: 東京都, city: 千代田区}
}
copied to clipboard
CLI #
$> export KENALL_API_KEY=YOUR_API_KEY
$> kenall-cli get postalcode --code=1500001
send request to https://api.kenall.jp/v1/postalcode/1500001
city count: 1
address: {jisx0402: 13113, old_code: 150, postal_code: 1500001, prefecture: 東京都, prefecture_kana: トウキョウト, city: 渋谷区, city_kana: シブヤク, town: 神宮前, town_kana: ジングウマエ, town_raw: 神宮前, town_kana_raw: ジングウマエ, koaza: , kyoto_street: , building: , floor: , town_partial: false, town_addressed_koaza: false, town_multi: false, town_chome: true, corporation: null}
copied to clipboard
Curl #
$> curl -H "Authorization: Token YOUR_API_KEY" \ (git)-[playground-refactor]
$> https://api.kenall.jp/v1/postalcode/1500001
{
"version": "2021-11-30",
"data": [
{
"jisx0402": "13113",
"old_code": "150",
"postal_code": "1500001",
"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": true,
"town_multi": false,
"town_raw": "神宮前",
"corporation": null
}
]
}
copied to clipboard
Flutter #
Example app is here.



Get Address
Search Address
Get City










License #
MIT License.