Mubawab Filters API Documentation

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

Mubawab Filters API lists every value the search route accepts: countries, languages, transactions, property types, sort options and amenities. Use the value in requests and the label in your interface. The answer is fixed and costs no upstream request. Failed requests are not billed.

Run this endpoint

Mubawab Filters API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

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

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

Response preview

200 OK

{
    "data": {
        "sorts": [
            {
                "label": "Recommended",
                "value": "default"
            },
            {
                "label": "Newest first",
                "value": "newest"
            },
            {
                "label": "Price, low to high",
                "value": "price_asc"
...

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": {
        "sorts": [
            {
                "label": "Recommended",
                "value": "default"
            },
            {
                "label": "Newest first",
                "value": "newest"
            },
            {
                "label": "Price, low to high",
                "value": "price_asc"
            },
            {
                "label": "Price, high to low",
                "value": "price_desc"
            }
        ],
        "amenities": [
            {
                "label": "Swimming pool",
                "value": "pool"
            },
            {
                "label": "Elevator",
                "value": "elevator"
            },
            {
                "label": "Garden",
                "value": "garden"
            }
        ],
        "countries": [
            {
                "label": "Morocco",
                "value": "ma"
            },
            {
                "label": "Tunisia",
                "value": "tn"
            }
        ],
        "languages": [
            {
                "label": "French",
                "value": "fr"
            },
            {
                "label": "English",
                "value": "en"
            }
        ],
        "transactions": [
            {
                "label": "For sale",
                "value": "sale"
            },
            {
                "label": "For rent",
                "value": "rent"
            }
        ],
        "property_types": [
            {
                "label": "Apartments",
                "value": "apartments"
            },
            {
                "label": "Villas and luxury homes",
                "value": "villas"
            },
            {
                "label": "Houses",
                "value": "houses"
            },
            {
                "label": "Land",
                "value": "land"
            },
            {
                "label": "Offices and shops",
                "value": "offices"
            },
            {
                "label": "Commercial premises",
                "value": "premises"
            },
            {
                "label": "Riads",
                "value": "riads"
            },
            {
                "label": "All property types (needs a location)",
                "value": "all"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "filters"
    },
    "success": true
}

Errors

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

503

Upstream Unavailable

Mubawab 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": "filters"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Mubawab 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.