Skip to content
Scrappa Get API key
591 House API 1 credit/request

591 Locations API Documentation

GET https://scrappa.co/api/591/locations

591 Locations API lists the cities and counties of 591 (22) with their 370 districts. Use the ids as region_id and section_ids in the search routes. Each place has an id, a name and a map position. The tables are static, so this route answers at once and always succeeds for a valid request. Unofficial: Scrappa is not affiliated with 591. Chinese text stays as 591 returns it; numeric fields are parsed next to it, and a value 591 does not give is null, never 0. Failed requests are not billable.

591 Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/591/locations
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "regions": [
            {
                "id": 1,
                "lat": 25.0329694,
                "lng": 121.5654177,
                "area": "\u5317\u90e8",
                "name": "\u53f0\u5317\u5e02",
                "sections": [
                    {
                        "id": 5,
                        "lat": 25.0249441,
                        "lng": 121.5433783,
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

2 optional filters available.

region_id integer Optional

Only this city or county. Optional.

Example value 1234567890
q string Optional

Text that a city or district name must contain. Optional.

Example value coffee shops

Response Schema

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

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "regions": [
            {
                "id": 1,
                "lat": 25.0329694,
                "lng": 121.5654177,
                "area": "\u5317\u90e8",
                "name": "\u53f0\u5317\u5e02",
                "sections": [
                    {
                        "id": 5,
                        "lat": 25.0249441,
                        "lng": 121.5433783,
                        "name": "\u5927\u5b89\u5340"
                    },
                    {
                        "id": 10,
                        "lat": 25.0935968,
                        "lng": 121.5940773,
                        "name": "\u5167\u6e56\u5340"
                    }
                ]
            }
        ],
        "total_regions": 1
    },
    "meta": {
        "billable": true,
        "endpoint_family": "locations"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter is missing or a value or combination is not allowed. This response is not billable.

{
    "errors": {
        "region_id": [
            "The region id field is required."
        ]
    },
    "message": "The request validation failed"
}

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.