---
title: "GET /onthemarket/search"
method: GET
path: "/onthemarket/search"
tags: ["OnTheMarket"]
---

# GET /onthemarket/search

`GET /onthemarket/search`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/onthemarket/search`
- Auth: API key in header `X-API-KEY`

## Query parameters

- `search_type` 'for-sale' | 'to-rent', required
- `location_id` string, required
- `page` integer
- `sort_field` 'recommended' | 'price' | 'update_date'
- `direction` 'asc' | 'desc'
- `prop_types` string, nullable
- `min_price` integer, nullable
- `max_price` integer, nullable
- `min_bedrooms` integer, nullable
- `max_bedrooms` integer, nullable
- `radius` number, nullable
- `under_offer` boolean, nullable
- `let_agreed` boolean, nullable
- `exclusive_first` boolean, nullable
- `new_home_flag` boolean, nullable

## Response `200`

- string

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `422`: A public parameter is missing or invalid. This response is not billable.
- `503`: The upstream source is temporarily unavailable. This response is not billable and can be retried.

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/31329f110e7c?raw)