Skip to main content
GET
Location Autocomplete
Resolve a place name or postcode prefix to the locations Gumtree knows. Pass a result to /search as location: its name (a town) or a postcode on uk, its numeric id on au, its ref id on za. UK and South African results carry coordinates. Credits: 1

Authorization

string
required
Your ScrapeBadger API key.

Query Parameters

string
default:"uk"
uk (gumtree.com), au (gumtree.com.au) or za (gumtree.co.za).
string
required
Town, area or postcode prefix — at least 2 characters, e.g. manch, leed or SW1A (uk), sydney (au), pret (za).

Response

string
uk, au or za.
string
Echo of the requested prefix.
integer
Number of locations.
LocationSuggestion[]
Matching locations.

Example

Response

South Africa

Response (abridged)
Pass the id (pfw8k) to /search?market=za as location. gumtree.co.za matches on the first 12 characters of the query.

Australia

On au, query=sydney returns Sydney Region, NSW (3003435), Inner Sydney, NSW (3003771), postcodes such as North Sydney 2060, NSW and more. Pass the id to /search as location.
On uk, /search also takes a full UK postcode directly as location (location=SW1A 1AA&distance=2), so you only need this endpoint to resolve partial input or to show the user a choice.

Errors