PHPackages                             ticknical/postalian - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ticknical/postalian

AbandonedArchivedProject[API Development](/categories/api)

ticknical/postalian
===================

Skeleton providing Japanese postal code API.

04PHP

Since Nov 1Pushed 8y ago1 watchersCompare

[ Source](https://github.com/ticknical/postalian)[ Packagist](https://packagist.org/packages/ticknical/postalian)[ RSS](/packages/ticknical-postalian/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

postalian
=========

[](#postalian)

postalianは自分用の郵便番号APIサーバーの作成・公開を支援するスケルトンです。

必須条件
----

[](#必須条件)

- [PHP](http://php.net/) 7.0+
- [Lumen](https://lumen.laravel.com/) 5.5.\*
- [Guzzle](http://docs.guzzlephp.org/en/latest/) 5.3.\*

インストール
------

[](#インストール)

### Composer

[](#composer)

```
$ composer create-project --prefer-dist ticknical/postalian [your project name]
```

使用方法
----

[](#使用方法)

### 郵便番号CSVの取り込み

[](#郵便番号csvの取り込み)

日本郵便からのCSVダウンロード・取り込み・取得前後のデータ加工までをコマンド一発で行います。

```
$ php artisan postalcode:storeall
```

ダウンロードした郵便番号CSVについては、少しデータを加工して取り込んでいます。

- 町域名が多すぎて複数行に分割されている場合はマージ
- 「以下に掲載がない場合」を空文字へ置換
- 「＊＊の次に番地がくる場合」を空文字へ置換
- 「＊＊一円」を空文字へ置換

### 簡単な郵便番号API

[](#簡単な郵便番号api)

簡単な郵便番号APIを公開できます。

例えば`http://[domain]/api/search/code/1000001`にアクセスすると、以下のJSONが返却されます。

```
{
    "status": true,
    "version": "2017-10-31",
    "postal_codes": [
        {
            "postal_code": "1000001",
            "prefecture": "東京都",
            "city": "千代田区",
            "street": "千代田"
        }
    ]
}
```

ライセンス
-----

[](#ライセンス)

Copyright © 2017 Tick Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/afdffccf2ddbc438e673e1defaf4d050a492acc1e65c962ccff6ce8b0fae8113?d=identicon)[ticknical](/maintainers/ticknical)

---

Top Contributors

[![ticknical](https://avatars.githubusercontent.com/u/16036124?v=4)](https://github.com/ticknical "ticknical (1 commits)")

### Embed Badge

![Health badge](/badges/ticknical-postalian/health.svg)

```
[![Health](https://phpackages.com/badges/ticknical-postalian/health.svg)](https://phpackages.com/packages/ticknical-postalian)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)