Skip to content
Scrappa Get API key
CHINTAI API 1 credit/request

CHINTAI Location Autocomplete API Documentation

GET https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF

Scrappa's GET /api/chintai/autocomplete finds the prefectures, municipalities and railway lines that the CHINTAI search accepts.

What you get

Up to 20 results for the text in q, best matches first (names that start with the text come before names that contain it). Search by Japanese name, by prefecture slug (for example tokyo) or by municipality code. Each municipality and line result carries search_params with the prefecture and city or line to send to /api/chintai/search. A prefecture result has search_params set to null and locations_params for the location tree.

Notes

The list is read from CHINTAI's public area and line pages for all 47 prefectures. CHINTAI lists only municipalities that have listings, so a quiet prefecture can have few municipalities. This call needs no lookup on CHINTAI and answers at once.

CHINTAI Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF
Auth header
x-api-key
Cost
1 credit/request
q = 新宿
Response preview
200 OK
{
    "success": true,
    "data": {
        "query": "\u65b0\u5bbf",
        "items": [
            {
                "type": "city",
                "name": "\u65b0\u5bbf\u533a",
                "code": "13104",
                "prefecture": "tokyo",
                "prefecture_name": "\u6771\u4eac\u90fd",
                "search_params": {
                    "prefecture": "tokyo",
                    "city": "13104"
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

q string Required

Start of a place or line name, for example 新宿, 山手 or tokyo.

Example value 新宿

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/chintai/autocomplete?q=%E6%96%B0%E5%AE%BF")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "query": "\u65b0\u5bbf",
        "items": [
            {
                "type": "city",
                "name": "\u65b0\u5bbf\u533a",
                "code": "13104",
                "prefecture": "tokyo",
                "prefecture_name": "\u6771\u4eac\u90fd",
                "search_params": {
                    "prefecture": "tokyo",
                    "city": "13104"
                }
            },
            {
                "type": "line",
                "name": "\u6e58\u5357\u65b0\u5bbf\u30e9\u30a4\u30f3",
                "code": "101038",
                "prefecture": "tokyo",
                "prefecture_name": "\u6771\u4eac\u90fd",
                "search_params": {
                    "prefecture": "tokyo",
                    "line": "101038"
                }
            }
        ]
    },
    "meta": {
        "endpoint_family": "autocomplete",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A query parameter is missing, unknown or unusable. Non-billable.

{
    "errors": {
        "q": [
            "The q field is required."
        ]
    },
    "message": "The q field is required."
}
503

Service Unavailable

The service could not answer (`UPSTREAM_UNAVAILABLE`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "CHINTAI is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.