> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/gumtree/search/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/gumtree/search/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Search Gumtree listings (https://www.socialfetch.dev/docs/api/v1/gumtree/search/get)

## Summary

Search Gumtree UK listings by keyword, category, place, radius and price, with paging.

**Tags:** `Gumtree`

## HTTP

- **Method:** GET
- **Path:** `/v1/gumtree/search`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.gumtree.searchListings({ query: "road bike", category: "bicycles", location: "london", distance: 10, minPrice: 100, maxPrice: 500, sort: "date" })`
- **Accepted identifiers:** `query` (query)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 1 credit
- Failed requests are free
- Found, empty and not-found answers are all charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `query` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 100
- **Description:** Search text, e.g. `road bike`. Leave it out to browse a whole category.

### `category` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 80; pattern: `^[a-z0-9]+(?:-[a-z0-9]+)*$`
- **Description:** Category slug, e.g. `cars`, `bicycles` or `property-to-rent` (the `slug` from the categories endpoint). Default: all categories.

### `location` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 60; pattern: `^[A-Za-z0-9][A-Za-z0-9 '&.,-]*$`
- **Description:** Where to search: a place slug such as `london` or `manchester`, a postcode district such as `M1`, or a full postcode. Default: the whole UK.

### `distance` (query)

- **Required:** no
- **Constraints:** type `integer`
- **Description:** Radius in miles around `location`: 1, 3, 5, 10, 15, 30, 50, 75, 100 or 1000 (nationwide).

### `minPrice` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 0; maximum: 100000000
- **Description:** Lowest price in whole pounds, e.g. `100`.

### `maxPrice` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 0; maximum: 100000000
- **Description:** Highest price in whole pounds, e.g. `500`.

### `sort` (query)

- **Required:** no
- **Constraints:** type `string`; enum: relevance, date, price_lowest_first, price_highest_first, distance
- **Description:** `relevance`, `date` (newest first), `price_lowest_first`, `price_highest_first` or `distance` (nearest first). Default: `relevance`.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 8192
- **Description:** Pass `page.nextCursor` from the previous response to get the next page. It only works with the same filters.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: Gumtree search results.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Gumtree search results.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. `not_found` when the category or location does not exist on Gumtree.
  - **query** (required) — type `string`; nullable. Search text, as searched.
  - **category** (required) — type `string`; nullable. Category slug searched; null for all categories.
  - **location** (required) — type `string`; nullable. Location the site searched, as it names it.
  - **totalResults** (required) — type `integer`; nullable. Number of matching listings the site reports.
  - **listings** (required) — type `array`. A page of listings, up to about 33. The site's pages overlap: a listing an earlier page returned is not returned again, so a page can hold fewer rows than the site shows.
    - _items:_
      - **id** (required) — type `string`. Listing id.
      - **title** (required) — type `string`. Listing title.
      - **url** (required) — type `string`. Listing URL on gumtree.com.
      - **price** (required) — type `object`; nullable. Asking price; null when not shown.
      - **description** (required) — type `string`; nullable. Start of the description, as the result card shows it.
      - **postedAt** (required) — type `string`; nullable. When the listing was posted or last bumped up, ISO 8601 UTC.
      - **postedAgo** (required) — type `string`; nullable. Age as shown, e.g. `1 day ago`.
      - **location** (required) — type `string`; nullable. Town and area as shown, e.g. `Keith, Moray`.
      - **postcodeDistrict** (required) — type `string`; nullable. Postcode district (the first half of the postcode), e.g. `AB55`.
      - **locationId** (required) — type `string`; nullable. Gumtree location id of the listing's area.
      - **coordinates** (required) — type `object`; nullable. Approximate map position; only when the seller lets the listing show a map.
      - **distance** (required) — type `string`; nullable. Distance from the searched location as shown, e.g. `2 miles`.
      - **imageUrl** (required) — type `string`; nullable. Main photo URL.
      - **imageUrls** (required) — type `array`. Every photo URL the card carries.
        - _items:_
          - type `string`
      - **imageCount** (required) — type `integer`; nullable. Number of photos on the listing.
      - **hasVideo** (required) — type `boolean`; nullable. Whether the listing has a video.
      - **categoryId** (required) — type `string`; nullable. Leaf category id.
      - **categoryIds** (required) — type `array`. Category ids from the top level down to the leaf.
        - _items:_
          - type `string`
      - **attributes** (required) — type `array`. Attributes the listing shows (condition, brand, mileage and so on).
        - _items:_
      - **sellerId** (required) — type `string`; nullable. The 32-character seller id the seller endpoints take. Seller listings carry it; search and similar results are null, because their cards don't: get it from the listing endpoint's `seller.sellerId`.
      - **sellerUserId** (required) — type `string`; nullable. Seller's numeric user id, as the listing's own 'other ads' link carries it. The seller endpoints don't take it: pass `sellerId`.
      - **isTrade** (required) — type `boolean`; nullable. Whether the seller is a business (trade) account.
      - **featured** (required) — type `boolean`; nullable. Paid featured placement.
      - **urgent** (required) — type `boolean`; nullable. Marked urgent.
      - **standout** (required) — type `boolean`; nullable. Paid highlighted card.
      - **bumpedUp** (required) — type `boolean`; nullable. Recently bumped to the top.
      - **favouriteCount** (required) — type `integer`; nullable. Number of people who saved the listing.
      - **shippingAvailable** (required) — type `boolean`; nullable. Whether the seller offers delivery.
      - **status** (required) — type `string`; nullable. Listing status, e.g. `LIVE`.
  - **relatedSearches** (required) — type `array`. Related searches the site suggests on the page.
    - _items:_
      - type `string`
  - **categories** (required) — type `array`. Narrower categories with their match counts.
    - _items:_
      - **slug** (required) — type `string`. Category slug.
      - **name** (required) — type `string`. Category name.
      - **count** (required) — type `integer`; nullable. Matching listings in that category.
  - **page** (required) — type `object`. Pagination state for the current page.
    - **hasMore** (required) — type `boolean`. Whether another page is available.
    - **nextCursor** (required) — type `string`; nullable. Cursor for the next page; null on the last page.
    - **page** (required) — type `integer`. Page number of this response.
    - **lastPage** (required) — type `integer`; nullable. Last page the site serves; null when unknown.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "query": "bike",
    "category": null,
    "location": "United Kingdom",
    "totalResults": 54068,
    "listings": [
      {
        "id": "1804519831",
        "title": "Voodoo Braag 29\" Mountain Bike – Hydraulic Brakes",
        "url": "https://www.gumtree.com/p/mountain-bikes/voodoo-braag-29-mountain-bike-hydraulic-brakes/1804519831",
        "price": {
          "amount": 260,
          "currency": "GBP",
          "text": "£260.00"
        },
        "description": "Voodoo Braag 29\" Mountain Bike – Hydraulic Brakes \n\nVoodoo Braag hardtail mountain bike with a lightweight aluminium frame.\n\nFeatures:\n\n- 29-inch wheels with Ma",
        "postedAt": "2026-11-15T16:46:59.327Z",
        "postedAgo": "18 hours ago",
        "location": "Archway, London",
        "postcodeDistrict": "N19",
        "locationId": "190",
        "coordinates": null,
        "distance": "89 miles",
        "imageUrl": "https://img.gumtree.com/ePR8PyKf84wPHx7_RYmEag/0605e0c5de914f2eb9_61b751e3feb3/86",
        "imageUrls": [
          "https://img.gumtree.com/ePR8PyKf84wPHx7_RYmEag/0605e0c5de914f2eb9_61b751e3feb3/86"
        ],
        "imageCount": 9,
        "hasVideo": false,
        "categoryId": "12751",
        "categoryIds": [
          "2549"
        ],
        "attributes": [
          {
            "key": "common_for_sale_condition",
            "name": "Condition",
            "value": "Good condition",
            "unit": null
          }
        ],
        "sellerId": null,
        "sellerUserId": "84117787",
        "isTrade": false,
        "featured": true,
        "urgent": false,
        "standout": false,
        "bumpedUp": false,
        "favouriteCount": 0,
        "shippingAvailable": false,
        "status": "LIVE"
      }
    ],
    "relatedSearches": [
      "bike rack"
    ],
    "categories": [
      {
        "slug": "for-sale",
        "name": "For Sale",
        "count": 49639
      }
    ],
    "page": {
      "hasMore": true,
      "nextCursor": "eyJ2IjoxLCJrIjoic2VhcmNoIiwicCI6MiwiZiI6IjU1M2JmNiJ9",
      "page": 1,
      "lastPage": 50
    }
  },
  "meta": {
    "requestId": "req_01example_gumtree_search",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.gumtree.searchListings({
  query: "road bike",
  category: "bicycles",
  location: "london",
  distance: 10,
  minPrice: 100,
  maxPrice: 500,
  sort: "date",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/gumtree/search?query=road%20bike&category=bicycles&location=london&distance=10&minPrice=100&maxPrice=500&sort=date",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/gumtree/search?query=road%20bike&category=bicycles&location=london&distance=10&minPrice=100&maxPrice=500&sort=date" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/gumtree/search?query=road%20bike&category=bicycles&location=london&distance=10&minPrice=100&maxPrice=500&sort=date",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/gumtree/search");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```