Booli Search Filters API

GET https://scrappa.co/api/booli/filters

List the sort options and filters Booli currently publishes for the for-sale or the sold search from `GET /api/booli/filters`, including choice values and the min and max keys of range filters.

Run this endpoint

Booli Search Filters API 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/booli/filters

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

Response preview

200 OK

{
    "data": {
        "sorts": [],
        "filters": [],
        "search_type": "sale"
    },
    "success": true
}

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.

1 optional filter available.

type


                                        string

Optional

sale (default) or sold

Example value


                                        example

Response Schema

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

Open in Playground

Example response fields

Scan these fields before integrating.

data success

JSON Response

200 OK

{
    "data": {
        "sorts": [],
        "filters": [],
        "search_type": "sale"
    },
    "success": true
}

Errors

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

404

HTTP 404

The id, area or home does not exist. This response is not billable.

422

HTTP 422

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

503

HTTP 503

Booli is temporarily unavailable. Retry the request. This response is not billable.

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.