Skip to content
Scrappa Get API key
Mudah.my Property API 1 credit/request

Mudah.my Property Reference API Documentation

GET https://scrappa.co/api/mudah-property/v1/reference

Mudah.my Property Reference API lists the filter values of the search endpoint: states, categories, property types, bedrooms, bathrooms, furnishing, sort options and the page size. It needs no input and never contacts Mudah.my. Subareas and buildings come from the autocomplete endpoint.

Mudah.my Property Reference API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/mudah-property/v1/reference
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "sort": [
            {
                "id": "latest",
                "label": "Latest first"
            },
            {
                "id": "price_asc",
                "label": "Price low to high"
            }
        ],
        "regions": [
            {
...

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": {
        "sort": [
            {
                "id": "latest",
                "label": "Latest first"
            },
            {
                "id": "price_asc",
                "label": "Price low to high"
            }
        ],
        "regions": [
            {
                "id": 1,
                "label": "Perlis"
            },
            {
                "id": 2,
                "label": "Kedah"
            }
        ],
        "bedrooms": [
            {
                "id": 1,
                "label": "1"
            },
            {
                "id": 2,
                "label": "2"
            }
        ],
        "max_page": 250,
        "bathrooms": [
            {
                "id": 1,
                "label": "1"
            },
            {
                "id": 2,
                "label": "2"
            }
        ],
        "furnished": [
            {
                "id": 1,
                "label": "Fully furnished"
            },
            {
                "id": 2,
                "label": "Partially furnished"
            }
        ],
        "page_size": 40,
        "categories": [
            {
                "id": 2000,
                "name": "all",
                "rent_only": false
            },
            {
                "id": 2200,
                "name": "residential",
                "rent_only": false
            }
        ],
        "listing_types": [
            {
                "id": "sale",
                "label": "For sale"
            },
            {
                "id": "rent",
                "label": "For rent"
            }
        ],
        "property_types": {
            "land": [
                {
                    "id": 31,
                    "label": "Residential"
                },
                {
                    "id": 32,
                    "label": "Industrial"
                }
            ],
            "apartment": [
                {
                    "id": 4,
                    "label": "Flat"
                },
                {
                    "id": 6,
                    "label": "Studio"
                }
            ]
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "reference"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

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

Upstream Unavailable

Mudah.my could not be reached. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "reference"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Mudah.my could not be reached. Please retry shortly."
    },
    "success": false
}
503

Unexpected Upstream Data

Mudah.my returned data in an unexpected shape. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "reference"
    },
    "error": {
        "code": "INVALID_UPSTREAM_SHAPE",
        "message": "Mudah.my returned data in an unexpected shape. 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.