Skip to content
Scrappa Get API key
Propiedades.com API 1 credit/request

Propiedades.com Autocomplete API Documentation

GET https://scrappa.co/api/propiedades-com/autocomplete

Propiedades.com Autocomplete API finds locations by name. Every result has an id you can pass as location_id to the search route. is_state marks a state or region rather than a neighbourhood. A query with no match returns an empty list. Failed requests are not billed.

Propiedades.com Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/propiedades-com/autocomplete
Auth header
x-api-key
Cost
1 credit/request
q = coffee shops
Response preview
200 OK
{
    "data": {
        "items": [
            {
                "id": 150028,
                "path": "/polanco/departamentos-renta",
                "label": "Zona Polanco, Ciudad De M\u00e9xico",
                "is_state": false,
                "latitude": 19.433333,
                "longitude": -99.2
            }
        ]
    },
    "meta": {
...

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.

3 optional filters available.

q string Required

Search text, 2 to 100 characters. Example: polanco.

Example value coffee shops
purpose string Optional

sale (default), rent or both.

Example value example
type string Optional

residential (default), commercial or industrial.

Example value example
subtype string Optional

A subtype of the type, as in the search route. Omit for all.

Example value example

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": {
        "items": [
            {
                "id": 150028,
                "path": "/polanco/departamentos-renta",
                "label": "Zona Polanco, Ciudad De M\u00e9xico",
                "is_state": false,
                "latitude": 19.433333,
                "longitude": -99.2
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

A parameter is missing or invalid. This response is not billable.

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

Upstream Unavailable

Propiedades.com 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": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Propiedades.com 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.