APIドキュメント

クイックスタート

1. アカウント作成してAPIキーを取得

Dashboard →

2. APIを呼び出す

curl "https://yubinapi.mylastwork.com/api/v1/search?postal_code=1060032" \
  -H "Authorization: Bearer yb_your_api_key"

認証

全てのAPIリクエストに Authorization ヘッダーが必要です。

Authorization: Bearer yb_your_api_key
GET /api/v1/reverse

住所テキストから郵便番号を逆引き検索

Query Parameters

address 必須 — 検索クエリ(住所テキスト)

prefecture — 都道府県でフィルタ

limit — 最大件数(デフォルト20、最大100)

Response

{
  "success": true,
  "data": {
    "results": [{
      "postal_code": "1060032",
      "prefecture": "東京都",
      "city": "港区",
      "town": "六本木",
      "prefecture_code": "13"
    }],
    "count": 1
  }
}
POST /api/v1/normalize

住所を構造化データに正規化。表記揺れ統一・郵便番号付与。

Request Body

{
  "address": "東京都港区六本木6丁目10番1号"
}

Response

{
  "success": true,
  "data": {
    "prefecture": "東京都",
    "prefecture_code": "13",
    "city": "港区",
    "town": "六本木",
    "block": "6-10-1",
    "building": null,
    "normalized": "東京都港区六本木6-10-1",
    "postal_code": "1060032"
  }
}
POST /api/v1/validate

住所のバッチバリデーション(最大100件)

Request Body

{
  "addresses": [
    "東京都港区六本木6-10-1",
    "東京都存在しない区1-1-1"
  ]
}

Response

{
  "success": true,
  "data": {
    "results": [
      {
        "input": "東京都港区六本木6-10-1",
        "is_valid": true,
        "normalized": "東京都港区六本木6-10-1",
        "postal_code": "1060032",
        "errors": []
      },
      {
        "input": "東京都存在しない区1-1-1",
        "is_valid": false,
        "normalized": "東京都存在しない区1-1-1",
        "postal_code": null,
        "errors": ["「東京都存在しない区」がデータベースに見つかりません"]
      }
    ],
    "all_valid": false,
    "count": 2
  }
}

エラーコード

Status 説明
400リクエストが不正
401APIキーが無効
429月間上限に達した
500サーバーエラー

レートリミット

プラン 月間上限 レート
Free1,000回10 req/min
Pro50,000回100 req/min
Business500,000回500 req/min