# Gumtree Search API (https://www.socialcrawl.dev/platforms/gumtree/search)

> Returns Gumtree UK classifieds matching a keyword, about 22 per page, each with ad id, title, price in GBP, location, category, seller type (private or trade), image, and listing URL. Pass a gumtree.com/search URL as url to replay an existing web search (location slugs default to a 15-mile radius unless the URL carries a distance). Price, seller_type, and attributes filters only apply when category_id is also set. Paginate with page or the universal cursor until hasNextPage is false. Feed a returned ad id into GET /v1/gumtree/product for the full listing.

TL;DR: `GET /v1/gumtree/search` costs 5 credits per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `query` | no | Free-text listing search, for example iphone or golf mk7 diesel. |
| `url` | no | A Gumtree web search URL, for example https://www.gumtree.com/search?q=iphone&search_location=london. Keyword, category, location, and price filters on the URL are parsed server-side. |
| `page` | no | Page number, starting at 1. Prefer the universal cursor parameter. |
| `sort_by` | no | Result ordering: relevance (default), newest, price_low, or price_high. (relevance \| newest \| price_low \| price_high) |
| `category_id` | no | Gumtree category id or SEO slug from GET /v1/gumtree/categories or search/suggestions. Required for price, seller_type, and attributes filters to take effect. |
| `location_id` | no | Gumtree location id from GET /v1/gumtree/locations or locations/nearest. |
| `distance` | no | Search radius in miles around location_id. Ignored without a location_id. nationwide searches the whole UK. (0 \| 1 \| 3 \| 5 \| 10 \| 15 \| 30 \| 50 \| 75 \| 100 \| 150 \| 250 \| 500 \| nationwide) |
| `min_price` | no | Lowest asking price in GBP. Requires category_id. Filter on product.price.current if you need a hard bound. |
| `max_price` | no | Highest asking price in GBP. Requires category_id. |
| `seller_type` | no | Restrict to private (individual) or trade (dealer) sellers. Requires category_id. (private \| trade) |
| `attributes` | no | Category-specific filters as comma-separated name:value pairs from GET /v1/gumtree/filters, for example common_for_sale_condition:new,vehicle_make:audi. Requires category_id. |
| `max_pages` | no | 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped. |
| `max_items` | no | 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue. |
| `max_credits` | no | 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price. |

## Code example

```bash
curl -G "https://www.socialcrawl.dev/v1/gumtree/search" \
  --data-urlencode "query=iphone" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does the Gumtree Search API return?

Returns Gumtree UK classifieds matching a keyword or a gumtree.com/search URL, about 22 per page, each with ad id, title, GBP price, location, category, seller type, and listing URL. The response uses the same JSON envelope as every SocialCrawl endpoint, with the data, credits_used and request_id fields.

### When should I use the Gumtree Search endpoint?

Use it to find UK second-hand, vehicle, or property ads by keyword. Feed a returned ad id into product for the full listing.

### How much does the Gumtree Search API cost?

Each call costs 5 credits, so the 100 free credits every new account gets cover 20 calls. Credits for failed or empty calls are refunded automatically, and there is no subscription.

### What parameters does the Gumtree Search API need?

Identify the target with one of query, url. It also accepts 14 optional parameters, all listed on this page.

### How do I call the Gumtree Search API?

Send a GET request to https://www.socialcrawl.dev/v1/gumtree/search?query=iphone with your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Gumtree API: https://www.socialcrawl.dev/platforms/gumtree

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- What does the SocialCrawl Gumtree Search API return?
- How do I get Gumtree Search data with the SocialCrawl API?