at home Autocomplete API Documentation Find cities or stations by a part of their Japanese name. Each suggestion has the name, the site code and the roman value. Use the roman value as the city parameter of the search routes.
Run this endpoint
Endpoint
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.
2 optional filters available.
string
Required
Part of a city or station name in Japanese, for example 新宿.
running shoes
string
Optional
city (default) or station.
example
string
Optional
Limit the suggestions to one prefecture, for example tokyo.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"suggestions": [
{
"code": "13104",
"name": "\u65b0\u5bbf\u533a",
"type": "city",
"roman": "shinjuku",
"prefecture": "\u6771\u4eac\u90fd",
"prefecture_roman": "tokyo",
"is_designated_city": false
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query parameter is missing or invalid, or the site does not know the city. No upstream request is made for a missing parameter. This response is not billable.
{
"errors": {
"rent_min": [
"The rent min must be one of: 20000, 25000, 30000."
]
},
"message": "The rent min must be one of: 20000, 25000, 30000."
}Not Found
The listing or agency does not exist or is no longer online. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "rent_detail"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested at home record was not found."
},
"success": false
}Bad Gateway
The site answered with a shape this API does not know. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "rent_search"
},
"error": {
"code": "PARSER_DRIFT",
"message": "at home returned an unexpected response."
},
"success": false
}Service Unavailable
at home could not be reached or blocked the request, also after one retry. Retry later. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "rent_search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The at home service 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.