JPostal

Japan postal code dictionary(so‐called ken_all.csv) utility.

• Read this in other languages: 日本語

Feature

• Automatically download japan postal code csv from japanpost.jp
• Format address pretty well
• Auto update support (monthly)
• Minimal REST web server included
• CSV output
• No dependencies (only jdk)

Usage

Add dependencies

dependencies {
    implementation 'com.mammb:jpostal:0.5.0'
}

Create and initialize Postal.

Postal postal = Postal.of();
postal.initialize();

Get address by postal code query.

String code = "105001";
Collection<Address> addresses = postal.get(code);
//[{"code": "1050011", "prefecture": "東京都", "city": "港区", "town": "芝公園", "street": ""},
// {"code": "1050012", "prefecture": "東京都", "city": "港区", "town": "芝大門", "street": ""},
// {"code": "1050013", "prefecture": "東京都", "city": "港区", "town": "浜松町", "street": ""}, 
// {"code": "1050014", "prefecture": "東京都", "city": "港区", "town": "芝", "street": ""}]

CSV file

You can output a formatted CSV file.

The -o option specifies the output file name.

$ java -jar jpostal-0.5.0.jar -o out.csv

PostalServer

If you needs rest server, run jpostal.jar.

Get jpostal.jar from https://github.com/naotsugu/jpostal/releases and run it.

Or clone and build and run.

$ git clone https://github.com/naotsugu/jpostal.git
$ cd jpostal
$ ./gradlew jar
$ java -jar build/libs/jpostal-0.5.0.jar

Or use PostalServer.

PostalServer server = PostalServer.of(postal);
server.start();

Go to http://localhost:8080/postal/105001, then you gets address by json format.

In addition, console page is http://localhost:8080/postal/console.html.

Options

Postal postal = Postal.of()
    .useLegacySource(false)
    .fineAddressSupport(true)
    .leftMatchSupport(true)
    .leftMatchLimitCount(15)
    .officeSourceSupport(true)
    .autoUpdateSupport(true);

Option	Default
useLegacySource	false
fineAddressSupport	true
leftMatchSupport	true
leftMatchLimitCount	20
officeSourceSupport	false
autoUpdateSupport	false

Details

See README.ja.md