Skip to content
Japan postal code dictionary(so‐called ken_all.csv) utility.
Java HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
src
.gitattributes
.gitignore
LICENSE Initial commit Feb 5, 2020
README.ja.md
README.md Modify README.md Feb 15, 2020
build.gradle Modify build.gradle Feb 15, 2020
gradlew
gradlew.bat
settings.gradle

README.md

JPostal

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

Feature

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

Usage

Add dependencies

dependencies {
    implementation 'com.mammb:jpostal:0.1.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": ""}]

PostalServer

If you needs rest server, run jpostal.jar.

$ git clone https://github.com/naotsugu/jpostal.git
$ cd jpostal
$ ./gradlew jar
$ java -jar build/libs/jpostal.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()
    .fineAddressSupport(true)
    .leftMatchSupport(true)
    .leftMatchLimitCount(15)
    .officeSourceSupport(true)
    .autoUpdateSupport(true);
Option Default
fineAddressSupport true
leftMatchSupport true
leftMatchLimitCount 20
officeSourceSupport false
autoUpdateSupport false

Details

See README.ja.md

You can’t perform that action at this time.