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/search 郵便番号から住所を検索。前方一致(3桁〜)・完全一致(7桁)に対応。
Query Parameters
postal_code 必須 — 郵便番号(ハイフンあり/なし)
Response
{
"success": true,
"data": {
"results": [{
"postal_code": "1060032",
"prefecture": "東京都",
"city": "港区",
"town": "六本木",
"prefecture_code": "13",
"prefecture_kana": "トウキョウト",
"city_kana": "ミナトク",
"town_kana": "ロッポンギ"
}],
"count": 1
}
} 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 | リクエストが不正 |
| 401 | APIキーが無効 |
| 429 | 月間上限に達した |
| 500 | サーバーエラー |
レートリミット
| プラン | 月間上限 | レート |
|---|---|---|
| Free | 1,000回 | 10 req/min |
| Pro | 50,000回 | 100 req/min |
| Business | 500,000回 | 500 req/min |