API ドキュメント

住所から郵便番号変換

takaosan.app の開発から派生した、住所キーワードから郵便番号を検索するREST API。認証不要・無料でご利用いただけます。

概要

ベースURL

api.tko3servs.com

認証

不要（無料）

レスポンス形式

JSON

エンドポイント

GET /postcode

https://api.tko3servs.com/postcode?q={住所キーワード}

パラメータ

パラメータ	必須	説明
q	必須	住所キーワード（都道府県・市区町村・町名など）

レスポンス例

200 OK

application/json

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

フィールド	型	説明

ライブデモ

Response