Skip to content
Scrappa Get API key
Dot Property API 1 credit/request

Dot Property Filter Options API Documentation

GET https://scrappa.co/api/dotproperty/v1/filter-options

Dot Property Filter Options API returns the values the Search route accepts as value and label lists: property types, transaction types, bedrooms, bathrooms, views, features, pets, listed by, sort names and the price range. info_only holds further site lists (amenities, transit, land title deeds, ownership, completion status, days on market) that the Search route does not filter by. The answer changes rarely.

Dot Property Filter Options API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/dotproperty/v1/filter-options
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "pets": [
            {
                "label": "Dogs Allowed",
                "value": "dog"
            },
            {
                "label": "Cats Allowed",
                "value": "cat"
            }
        ],
        "sort": [
            "rank",
...

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": {
        "pets": [
            {
                "label": "Dogs Allowed",
                "value": "dog"
            },
            {
                "label": "Cats Allowed",
                "value": "cat"
            }
        ],
        "sort": [
            "rank",
            "verification_at",
            "price",
            "living_area"
        ],
        "views": [
            {
                "label": "Sea View",
                "value": "sea"
            },
            {
                "label": "Golf or Park View",
                "value": "golf_park"
            },
            {
                "label": "Lake or River View",
                "value": "lake_river"
            },
            {
                "label": "Mountain View",
                "value": "mountain"
            }
        ],
        "bedrooms": [
            {
                "label": "Studio",
                "value": 0
            },
            {
                "label": "1",
                "value": 1
            },
            {
                "label": "2",
                "value": 2
            },
            {
                "label": "3",
                "value": 3
            },
            {
                "label": "4",
                "value": 4
            },
            {
                "label": "5+",
                "value": 5
            }
        ],
        "features": [
            {
                "label": "Private Pool",
                "value": "private_pool"
            },
            {
                "label": "Pool Access",
                "value": "pool_access"
            },
            {
                "label": "Jacuzzi",
                "value": "jacuzzi"
            },
            {
                "label": "Sauna",
                "value": "sauna"
            }
        ],
        "bathrooms": [
            {
                "label": "1",
                "value": 1
            },
            {
                "label": "2",
                "value": 2
            },
            {
                "label": "3",
                "value": 3
            },
            {
                "label": "4",
                "value": 4
            },
            {
                "label": "5+",
                "value": 5
            }
        ],
        "info_only": {
            "amenities": [
                {
                    "label": "Communal Pool",
                    "value": "5532"
                },
                {
                    "label": "Communal Gym",
                    "value": "5534"
                }
            ],
            "ownership": [
                {
                    "label": "Foreign Quota",
                    "value": 5614
                },
                {
                    "label": "Thai Quota",
                    "value": 5608
                }
            ],
            "near_transit": [],
            "days_on_market": [
                {
                    "label": "New Listings",
                    "value": "new_listings"
                },
                {
                    "label": "Less than 3 days",
                    "value": "less_than_3_days"
                }
            ],
            "land_title_deeds": [
                {
                    "label": "Chanote",
                    "value": "0"
                },
                {
                    "label": "Sor Kor 1",
                    "value": "1"
                }
            ],
            "completion_status": [
                {
                    "label": "Off Plan",
                    "value": 1
                },
                {
                    "label": "Completed",
                    "value": 2
                }
            ]
        },
        "listed_by": [
            {
                "label": "Owner",
                "value": "owner"
            },
            {
                "label": "Agent",
                "value": "agent"
            },
            {
                "label": "Developer",
                "value": "developer"
            }
        ],
        "price_range": {
            "rent": {
                "max": 1000000,
                "min": 5000
            },
            "sale": {
                "max": 500000000,
                "min": 1000000
            },
            "currency": "THB"
        },
        "property_types": [
            {
                "label": "Condo",
                "value": "condos"
            },
            {
                "label": "Apartment",
                "value": "apartments"
            },
            {
                "label": "Penthouse",
                "value": "penthouses"
            },
            {
                "label": "House",
                "value": "houses"
            }
        ],
        "transaction_types": [
            {
                "label": "Sale",
                "value": "sale"
            },
            {
                "label": "Rent",
                "value": "rent"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "filter-options"
    },
    "success": true
}

Errors

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

503

Upstream Unavailable

Dot Property 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": "filter-options"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Dot Property 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.