APIGET /v1/suggest

GET /v1/suggest

入力途中の文字列から、前方一致の住所の候補を返す GET /v1/suggest の仕様です。フォームの入力補完に使えます。

更新: 2026年10月12日

入力された文字列を前方一致で検索し、都道府県・市区町村などの候補を返します(内部の辞書は FST で、軽量に引けます)。全プランで使えます。

要確認 クエリのパラメータ名(ここでは q)と応答の正確な形は、公開前に確定します。

curl -s "https://api.zorynto.com/v1/suggest?q=%E6%9D%B1%E4%BA%AC" \
  -H "Authorization: Bearer $KITEN_API_KEY"

応答(例・簡略化)

{
  "query": "東京",
  "candidates": [
    { "text": "東京都", "lat": 35.6895, "lon": 139.6917 }
  ],
  "request_id": "req_…"
}

使い方の目安

  • 入力ごとに呼ぶと、件数が増えます。入力が止まってから呼ぶ(デバウンス)か、2〜3文字以上で呼んでください。
  • 1コールは1件として数えます。月間の上限に含まれます。
  • 確定した住所は、最後に POST /v1/parse で検証してください。

エラー

エラーを参照してください。

この内容に誤りや不足があれば、お知らせください。