クイックスタート
3ステップでAPIを利用開始できます。
1
APIキーを取得
お問い合わせフォームからAPIキーを申請します。最短1営業日で発行します。
2
リクエストを送信
X-Api-Key ヘッダーにAPIキーを設定してGETリクエストを送信します。
3
データを活用
JSON形式でエリアデータを受け取り、あなたのサービスに統合します。
curl
curl -H "X-Api-Key: your_api_key" \
"https://api.cityscope.jp/api/v1/cityscope/areas/13113/score"
# Response
{
"area": {
"code": "13113",
"name": "渋谷区",
"prefecture": "東京都"
},
"score": {
"total": 82,
"categories": {
"transport": 92,
"convenience": 88,
"childcare": 65,
"safety": 72,
"asset": 90,
"medical": 85,
"environment": 68
}
},
"updated_at": "2027-03-01T00:00:00Z"
}エンドポイント一覧
全13エンドポイント。全てJSON形式でレスポンスします。
GET
/api/v1/cityscope/areasエリア一覧の取得（都道府県フィルタ、ページネーション対応）
GET
/api/v1/cityscope/areas/:code指定エリアの基本情報を取得
GET
/api/v1/cityscope/areas/:code/score住みやすさスコアを取得（7カテゴリ別）
GET
/api/v1/cityscope/areas/:code/population人口の時系列データを取得
GET
/api/v1/cityscope/areas/:code/land_price地価データを取得
GET
/api/v1/cityscope/areas/:code/crime犯罪統計データを取得
GET
/api/v1/cityscope/areas/:code/hazard災害リスクデータを取得
GET
/api/v1/cityscope/areas/:code/reportAIまちレポートを取得
GET
/api/v1/cityscope/compare複数エリアの一括比較（最大10エリア）
GET
/api/v1/cityscope/searchエリア・駅名のフリーワード検索
GET
/api/v1/cityscope/nearby指定座標の周辺エリアを検索（PostGIS）
GET
/api/v1/cityscope/rankingカテゴリ別・都道府県別ランキング
POST
/api/v1/cityscope/areas/:code/analyzeAI分析リクエスト（レート制限あり）
認証
全てのリクエストに X-Api-Key ヘッダーが必要です。
X-Api-Key: cs_live_xxxxxxxxxxxxEnterpriseプランでは HMAC署名認証 にも対応しています。
レート制限
Starter
1,000 req/日
Pro
10,000 req/日
Enterprise
無制限
レスポンスヘッダーに残りリクエスト数が含まれます。