# Mudah.my Property Reference API Documentation

<p><strong>Mudah.my Property Reference API</strong> 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.</p>

- **Documentation:** [https://scrappa.co/docs/mudah-property-api/mudah_property_reference](https://scrappa.co/docs/mudah-property-api/mudah_property_reference)
- **API group:** Mudah.my Property API
- **Endpoint:** `GET https://scrappa.co/api/mudah-property/v1/reference`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | Mudah.my could not be reached. This response is not billable and is retryable. |
| 503 | Unexpected Upstream Data | Mudah.my returned data in an unexpected shape. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)