Check A Golf

ゴルフ場API使用方法

このページでは Check-A-Golf API（有料プラン）の使い方を説明します。

※ 本APIは有料プランのご契約者様のみご利用いただけます。APIキーの発行はこちらよりお問い合わせください。

https://checkagolf.com/API/api

すべてのリクエストに key パラメータ（発行済みAPIキー）を付与してください。

エンドポイント	説明
GET /api/test	疎通確認。`"ok"` を返します。
GET /api/golf-courses	ゴルフ場の検索・一覧取得
GET /api/golf-courses/{id}	指定IDのゴルフ場を1件取得

2.1 クエリパラメータ（GET /api/golf-courses）

パラメータ	型	説明	備考
key	string	APIキー（必須）	発行されたキーを指定。未指定・不正の場合はエラー
locale	string	言語・ロケールでフィルタ	完全一致。例: `ja` / `en`
state_prefecture	string	都道府県・州でフィルタ	部分一致（LIKE）
indoor	integer	インドア施設でフィルタ	`1`: インドアのみ / `0`: 含まない
outdoor	integer	アウトドア施設でフィルタ	`1`: アウトドアのみ / `0`: 含まない
short_course	integer	ショートコースでフィルタ	`1`: ショートコースのみ / `0`: 含まない
long_course	integer	ロングコースでフィルタ	`1`: ロングコースのみ / `0`: 含まない
keyword	string	コース名・住所のキーワード検索	部分一致（LIKE）
limit	integer	取得件数の上限	未指定の場合は全件取得（ストリーミング応答）
offset	integer	取得開始位置（ページング用）	`limit` と組み合わせて使用

以下はすべて有料プランのAPIキー（YOUR_API_KEY）を使用した例です。

疎通確認

curl -X GET "https://checkagolf.com/API/api/test"

key — APIキー指定（基本形）

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY"

locale — 言語でフィルタ（日本語データのみ）

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&locale=ja"

state_prefecture — 都道府県でフィルタ

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&state_prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD"

※ 東京都 をURLエンコードした値（%E6%9D%B1%E4%BA%AC%E9%83%BD）を指定

indoor — インドア施設のみ取得

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&indoor=1"

outdoor — アウトドア施設のみ取得

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&outdoor=1"

short_course — ショートコースのみ取得

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&short_course=1"

long_course — ロングコースのみ取得

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&long_course=1"

keyword — キーワード検索

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&keyword=%E3%82%B4%E3%83%AB%E3%83%95"

※ ゴルフ をURLエンコードした値（%E3%82%B4%E3%83%AB%E3%83%95）を指定。コース名・住所を部分一致で検索

limit / offset — ページング取得

# 1ページ目：1〜50件目
curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&limit=50&offset=0"

# 2ページ目：51〜100件目
curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&limit=50&offset=50"

全件取得（ストリーミング応答）

curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY"

※ limit を省略した場合、全件をストリーミングで返します。件数が多い場合は limit / offset によるページング取得を推奨します。

複数パラメータの組み合わせ例

# 東京都のアウトドア・ロングコースを50件取得
curl -X GET "https://checkagolf.com/API/api/golf-courses?key=YOUR_API_KEY&locale=ja&state_prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD&outdoor=1&long_course=1&limit=50&offset=0"

個別取得（ID指定）

curl -X GET "https://checkagolf.com/API/api/golf-courses/123?key=YOUR_API_KEY"

JSON 配列で返却されます。各要素のフィールドは以下のとおりです。

フィールド	型	意味
locale	string	ロケールコード（例: ja / en）
country_code	string	国コード（例: JP / US）
state_prefecture	string	都道府県・州
course_name	string	コース名
kinds	integer	種別（1: ゴルフ場 / 2: 練習場 / 4: 両方）
web	string	公式サイト URL
phone	string	電話番号
address	string	住所
indoor	integer	インドアフラグ（0 / 1）
outdoor	integer	アウトドアフラグ（0 / 1）
short_course	integer	ショートコースフラグ（0 / 1）
long_course	integer	ロングコースフラグ（0 / 1）
lat	float	緯度
lng	float	経度
form_email	string	お問い合わせ用メール・フォームURL
reservation	string	予約の要否（必要 / 不要 / HP記載なし）
reservation_method	string	予約方法
remarks	string	備考

レスポンス例

[
  {
    "locale": "ja",
    "country_code": "JP",
    "state_prefecture": "東京都",
    "course_name": "東京ゴルフクラブ",
    "kinds": 1,
    "web": "https://example.com",
    "phone": "03-1234-5678",
    "address": "東京都千代田区1-1",
    "indoor": 0,
    "outdoor": 1,
    "short_course": 0,
    "long_course": 1,
    "lat": 35.6895,
    "lng": 139.6917,
    "form_email": "info@example.com",
    "reservation": "必要",
    "reservation_method": "電話・Web",
    "remarks": ""
  }
]

key パラメータは必須です。未指定またはキーが不正な場合はエラーを返します。
limit を省略した場合、全件をストリーミング応答で返します。データ量が多いため、通常は limit / offset によるページング取得を推奨します。
文字列パラメータ（state_prefecture・keyword 等）は必ずURLエンコードして送信してください。
APIキーは第三者に共有しないでください。不正利用が確認された場合、キーを失効させる場合があります。
商用利用・大量取得に関しては別途ご相談ください。