OnTheMarket listings API reference

location is turned into OnTheMarket's place slug (St Albans -> st-albans), or pass place. Prices are OnTheMarket's display text; price is its number when the text is one amount (with price_period for rents). An unknown place is a 404.

Request

POSThttps://api.scrapercompany.com/v1/onthemarket/search

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

modestringdefault salepattern ^(sale|rent)$
sale or rent.
min_priceinteger | nullmin 0
Minimum price (GBP; per month for rent).
max_priceinteger | nullmin 0
Maximum price (GBP; per month for rent).
min_bedroomsinteger | nullmin 0, max 10
Minimum bedrooms.
locationstring | nullmax length 120
Place name, turned into OnTheMarket's slug (St Albans -> st-albans). Ignored when place is supplied.
placestring | nullmax length 120, pattern ^[a-z0-9]+(-[a-z0-9]+)*$
OnTheMarket place slug from its URLs, e.g. st-albans.
pageintegerdefault 1min 1, max 50
Result page.

Example request

curl -X POST "https://api.scrapercompany.com/v1/onthemarket/search" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

200 — One page of OnTheMarket listings. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response

{
  "search_parameters": {
    "engine": "onthemarket_search",
    "place": "manchester",
    "mode": "rent",
    "page": 1
  },
  "listings": [
    {
      "listing_id": "5811938",
      "address": "Cedar Grove M14",
      "price": 5612,
      "price_period": "month",
      "price_text": "£5,612 pcm (£1,295 pw)",
      "currency": "GBP",
      "bedrooms": 7,
      "bathrooms": 2,
      "property_type": "Terraced house",
      "title": "7 bedroom terraced house to rent",
      "latitude": 53.438801,
      "longitude": -2.21488,
      "agent": "House Manchester - Manchester",
      "label": "Added < 7 days",
      "image": "https://media.onthemarket.com/properties/5811938/1653537518/image-0-480x320.jpg",
      "url": "https://www.onthemarket.com/details/5811938/"
    }
  ],
  "total": 1,
  "total_results": 2554,
  "meta": {
    "source": "onthemarket",
    "elapsed_s": 0.5
  }
}

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Status	Meaning	Retry?
`401`Unauthorized	Missing or invalid API key. `{"detail":"missing or invalid API key"}`	No, fix the request
`402`Payment Required	Not enough credits for this request: the account's credits mode is `enforce` (`mode` in `GET /v1/billing`) and the request costs more than the available credits. Nothing is run or charged. `{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}`	No, fix the request
`404`Not Found	The property, stay, job or record was not found. `{"detail":"job not found"}`	No, fix the request
`422`Unprocessable Content	Request validation failed. `detail` is a list of problems for schema errors, or a string for semantic checks performed by the endpoint. `{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}`	No, fix the request
`429`Too Many Requests	Too many requests: the key's requests-per-minute limit was exceeded, or (in `enforce` credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry. `{"detail":"rate limit 60/min exceeded"}`	Yes, with backoff
`503`Service Unavailable	Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. `{"detail":"database unavailable: OperationalError"}`	Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
Copy the cURL example above and run it in a terminal.

Credits

2 credits per successful call (2 per page (an empty page and failed requests are free)). Failed, blocked and empty results are free.

Request#

Body#

Example request#

Response#

Errors#

Try it#