API ドキュメント

郵便番号 API

takaosan.app の開発から派生した、郵便番号から都道府県・市区町村・町名（ふりがな付き）を取得するREST API。認証不要・無料でご利用いただけます。

概要

ベースURL

api.tko3servs.com

認証

不要（無料）

レスポンス形式

JSON

エンドポイント

GET /postcode

https://api.tko3servs.com/postcode?q={郵便番号}

パラメータ

パラメータ	必須	説明
q	必須	郵便番号（7桁、ハイフンあり・なし両対応）

レスポンス例

200 OK

application/json

{
  "query":        "1600022",
  "count":        1,
  "api_key_used": false,
  "results": [{
    "postcode":   "1600022",
    "pref":       "東京都",
    "city":       "新宿区",
    "town":       "新宿",
    "pref_kana":  "トウキョウト",
    "city_kana":  "シンジュクク",
    "town_kana":  "シンジュク"
  }]
}

フィールド	型	説明

エラー

400

Bad Request

qパラメータが不正、または郵便番号の形式が違います。

404

Not Found

該当する郵便番号が見つかりません。resultsは空配列になります。

ライブデモ

Response