591 Location Suggest API Documentation

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

591 Location Suggest API suggests districts, streets and communities for homes for sale. Each result has a type, an id, a name, region and district ids, the address of a community and the number of homes for sale (sale_count). The suggestions are for the sale side only; for rentals use the keywords filter of rent search and the locations route. 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.

Run this endpoint

591 Location Suggest API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

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

Auth header: x-api-key
Cost: 1 credit/request

q = coffee shops region_id = 1234567890

Response preview

200 OK

{
    "data": {
        "query": "\u5927\u5b89",
        "results": [
            {
                "id": 5,
                "name": "\u5927\u5b89\u5340",
                "type": "section",
                "region": "\u53f0\u5317\u5e02",
                "address": null,
                "section": "\u5927\u5b89\u5340",
                "region_id": 1,
                "sale_count": 3103,
                "section_id": 5,
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

q region_id


                                        string

Required

Search text, 1 to 30 characters. Example: 大安.

Example value


                                        coffee shops

region_id


                                        integer

Required

Only suggestions in this city or county. Required. Get ids from /api/591/locations.

Example value

1234567890

Response Schema

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

Open in Playground

Example response fields

Scan these fields before integrating.

data meta success

JSON Response

200 OK

{
    "data": {
        "query": "\u5927\u5b89",
        "results": [
            {
                "id": 5,
                "name": "\u5927\u5b89\u5340",
                "type": "section",
                "region": "\u53f0\u5317\u5e02",
                "address": null,
                "section": "\u5927\u5b89\u5340",
                "region_id": 1,
                "sale_count": 3103,
                "section_id": 5,
                "nearby_area": null
            },
            {
                "id": 25614,
                "name": "\u5927\u5b89\u8def\u4e00\u6bb5",
                "type": "street",
                "region": "\u53f0\u5317\u5e02",
                "address": null,
                "section": "\u5927\u5b89\u5340",
                "region_id": 1,
                "sale_count": 78,
                "section_id": 5,
                "nearby_area": null
            },
            {
                "id": 25615,
                "name": "\u5927\u5b89\u8def\u4e8c\u6bb5",
                "type": "street",
                "region": "\u53f0\u5317\u5e02",
                "address": null,
                "section": "\u5927\u5b89\u5340",
                "region_id": 1,
                "sale_count": 45,
                "section_id": 5,
                "nearby_area": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "location_suggest"
    },
    "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"
}

503

Upstream Unavailable

591 could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "591 could not be reached. Please retry shortly."
    },
    "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.