jpostcode

README

go-jpostcode

• go-jpostcode is a Go package to find Japanese address data from Japanese postal code.
  • This package was created to provide data from https://github.com/kufu/jpostcode-data
• This package requires Go 1.16+.

Usage

// Find an address
address, err := jpostcode.Find("0010928")

// Search addresses (Some addresses have same postal code)
addresses, err := jpostcode.Search("1138654")

// Print address as a JSON
addressJSON, err := address.ToJSON()
if err != nil { // error handling }
fmt.Println(addressJSON)

Example

• HTTP server example

$ go run github.com/syumai/go-jpostcode/_examples/server@latest
$ curl http://localhost:8090/0010928

Install a CLI tool to get address from postcode

• A CLI tool is given as jpost.

Installation

go install github.com/syumai/go-jpostcode/cmd/jpost@latest

Usage of jpost

• To get address, just give postal code as argument.

# Get address from postal code: 0010928.
$ jpost 0010928
{"postcode":"0010928","prefecture":"北海道",...

Update jpostcode-data

$ make update

License

• MIT

Author

• syumai

Original data

• jpostcode-data

Documentation

Index

• Variables
• type Adapter
• type Address
  • func Find(postCode string) (*Address, error)
  • func Search(postCode string) ([]*Address, error)
  • func (addr *Address) ToJSON() (string, error)

Variables

var (
	ErrNotFound        = fmt.Errorf("postcode is not found")
	ErrInvalidArgument = fmt.Errorf("postcode is invalid")
	ErrInternal        = fmt.Errorf("internal error")
)

Types

type Adapter

type Adapter interface {
	SearchAddressesFromPostCode(postCode string) ([]*Address, error)
}

type Address

type Address struct {
	PostCode       string `json:"postCode" mapstructure:"postcode"`
	Prefecture     string `json:"prefecture" mapstructure:"prefecture"`
	PrefectureKana string `json:"prefectureKana" mapstructure:"prefecture_kana"`
	PrefectureCode int    `json:"prefectureCode" mapstructure:"prefecture_code"`
	City           string `json:"city" mapstructure:"city"`
	CityKana       string `json:"cityKana" mapstructure:"city_kana"`
	Town           string `json:"town" mapstructure:"town"`
	TownKana       string `json:"townKana" mapstructure:"town_kana"`
	Street         string `json:"street" mapstructure:"street"`
	OfficeName     string `json:"officeName" mapstructure:"office_name"`
	OfficeNameKana string `json:"officeNameKana" mapstructure:"office_name_kana"`
}

func Find

func Find(postCode string) (*Address, error)

func Search

func Search(postCode string) ([]*Address, error)

func (*Address) ToJSON

func (addr *Address) ToJSON() (string, error)