postal_jp 1.0.0

A Flutter package for searching Japan postal codes from addresses and vice versa.

flutter_postal_jp

A Dart package for retrieving Japanese postal address information from a postal code.

This package depends on the Zip Cloud web service.

[demo]

Features

• Retrieve address information (prefecture, city, town) based on a 7-digit Japanese postal code.
• Provides PostalCodeService to fetch data from an external API.
• Returns data as AddressInfo objects, including Japanese address components and kana readings.
• Handles API errors and returns ApiFailure with error messages.

Getting started

1. Add the dependency to your pubspec.yaml file:

   dependencies:
     postal_jp: ^<latest_version> # Replace with the latest version
   

2. Install the package:

   flutter pub get
   

Usage

import 'package:postal_jp/postal_jp.dart';

void main() async {
  final service = PostalJP();
  final result = await service.getAddress(postalCode: '0790177');
  switch (result) {
    case ApiSuccess(data: var addressInfoList):
      for (var address in addressInfoList) {
        print(
          'Address: ${address.address1} ${address.address2} ${address.address3}',
        );
      }
    case ApiFailure():
      print('Error: ${result.error}');
  }
}