# Trade Me Property Rental Search API Documentation

Search rental property on Trade Me (New Zealand). Same filters, sorting and paging as the sale search, with prices in NZD per week and an optional pets_ok filter. Each listing returns id, url, title, weekly price (price_per_week) and price text, available_from as YYYY-MM-DD, dates in ISO 8601 UTC, location, bedrooms, bathrooms, parking, photos, agency and open homes when present. A valid search with no hits returns an empty listings list and is a successful, billable response.

- **Documentation:** [https://scrappa.co/docs/trademe-property-api/trademe_property_search_rent](https://scrappa.co/docs/trademe-property-api/trademe_property_search_rent)
- **API group:** Trade Me Property API
- **Endpoint:** `GET https://scrappa.co/api/trademe_property/search_rent`

## 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.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `page` | integer | No | Page number, 1-based. Defaults to 1. |
| `rows` | integer | No | Listings per page, 1 to 100. Defaults to 22. |
| `price_min` | integer | No | Minimum price in NZD per week. |
| `price_max` | integer | No | Maximum price in NZD per week. |
| `bedrooms_min` | integer | No | Minimum number of bedrooms. |
| `bedrooms_max` | integer | No | Maximum number of bedrooms. |
| `bathrooms_min` | integer | No | Minimum number of bathrooms. |
| `property_type` | string | No | Property type slug, for example house, apartment, unit or townhouse. Unknown values are ignored by Trade Me. |
| `region` | integer | No | Region id from the localities endpoint, e.g. 15 for Wellington. |
| `district` | integer | No | District id from the localities endpoint, e.g. 47 for Wellington city. |
| `suburb` | string | No | One or more suburb ids from the localities endpoint, separated by commas, e.g. 53,57. |
| `search_string` | string | No | Free-text keyword search, up to 100 characters, e.g. beach. |
| `sort_order` | string | No | Default, PriceAsc, PriceDesc, ExpiryDesc or EarliestOpenHome. Defaults to Default. |
| `pets_ok` | boolean | No | Set to true to return only rentals that allow pets. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1"
```

## Example response

```json
{
    "success": true,
    "data": {
        "total_count": 11881,
        "page": 1,
        "page_size": 2,
        "has_more": true,
        "listings": [
            {
                "id": 6176096818,
                "url": "https://www.trademe.co.nz/a/listing/6176096818",
                "title": "Milford, 4 bedrooms, $2500 pw",
                "category": "To Rent",
                "property_type": "House",
                "price_text": "$2,500 per week",
                "price_per_week": 2500,
                "currency": "NZD",
                "start_date": "2026-10-12T11:26:55Z",
                "end_date": "2026-11-02T11:26:55Z",
                "available_from": "2026-11-10",
                "region": "Auckland",
                "district": "North Shore City",
                "suburb": "Milford",
                "address": "43 East Coast Road",
                "location": {
                    "latitude": -36.76861,
                    "longitude": 174.7598075
                },
                "bedrooms": 4,
                "bathrooms": 3,
                "parking_spaces": 2,
                "image_url": "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741472.jpg",
                "photo_urls": [
                    "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741473.jpg",
                    "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741474.jpg"
                ],
                "agency": "Harcourts Cooper & Co Property Management, (Licensed: REAA 2008)",
                "is_featured": true
            }
        ]
    },
    "meta": {
        "endpoint_family": "search_rent",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | The listing was not found or has expired. Not billed. |
|  | Error | Trade Me could not be reached. Not billed. |
|  | Error | Trade Me rejected the request. Not billed. |
|  | Error | The upstream service is temporarily unavailable. Please retry shortly. |
|  | Error | Trade Me returned an unexpected payload shape. Not billed. |
|  | Error | Trade Me rejected the request parameters. Not billed. |

## 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)