# Gumtree on Onekey

> 11 endpoints for Gumtree (0 stable, 11 beta), 2 credits each. Category: E-commerce & marketplaces. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 11 of 11 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/gumtree
Reference (Markdown): https://onekey.dev/docs/api/gumtree.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 11 mapped Gumtree endpoints return each:

- `entity.name` (string): 10
- `entity.id` (string): 8
- `entity.url` (URL): 5
- `content.createdAt` (ISO 8601 date): 4
- `entity.description` (string): 4
- `entity.location` (string): 4
- `listing.price` (number): 4
- `media.thumbnailUrl` (URL): 4
- `author.id` (string): 2
- `entity.type` (string): 2
- `place.lat` (number): 2
- `place.lon` (number): 2
- `author.bio` (string): 1
- `author.displayName` (string): 1
- `author.location` (string): 1
- `author.url` (URL): 1
- `entity.slug` (string): 1
- `entity.stats.rank` (integer): 1
- `listing.seller` (string): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### gumtree.categories

The Gumtree category tree.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/categories` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.slug`
- Reference: https://onekey.dev/docs/api/gumtree/categories.md

### gumtree.filters

Filters available for a Gumtree category.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/filters?category_id=cl94` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `category_id` (string, required): Category id or slug, as returned by the categories endpoint
- Fields returned: `entity.id`, `entity.name`, `entity.type`
- Reference: https://onekey.dev/docs/api/gumtree/filters.md

### gumtree.locations

Autocomplete Gumtree locations (place, postcode, outcode).
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/locations?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
- Fields returned: `entity.id`, `entity.name`, `place.lat`, `place.lon`, `ext.postcode`
- Reference: https://onekey.dev/docs/api/gumtree/locations.md

### gumtree.locations_nearest

The nearest Gumtree location to a coordinate.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/gumtree/locations_nearest?latitude=40.7128&longitude=-74.0060` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `latitude` (string, optional): Latitude in decimal degrees
  - `longitude` (string, optional): Longitude in decimal degrees
  - `location_coordinate` (string, optional): Coordinates as 'latitude,longitude' (alternative to latitude + longitude)
- Fields returned: `entity.id`, `entity.name`, `place.lat`, `place.lon`, `ext.postcode`
- Reference: https://onekey.dev/docs/api/gumtree/locations_nearest.md

### gumtree.product

A Gumtree ad by id.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/gumtree/product?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `entity.location`, `media.thumbnailUrl`, `content.createdAt`, `listing.seller`, `author.id`
- Reference: https://onekey.dev/docs/api/gumtree/product.md

### gumtree.product_similar

Ads similar to a Gumtree ad.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/product_similar?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `entity.location`, `media.thumbnailUrl`, `content.createdAt`
- Reference: https://onekey.dev/docs/api/gumtree/product_similar.md

### gumtree.search

Search Gumtree UK listings.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/search?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `entity.location`, `media.thumbnailUrl`, `content.createdAt`
- Reference: https://onekey.dev/docs/api/gumtree/search.md

### gumtree.search_suggestions

Search suggestions for Gumtree.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/search_suggestions?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
- Fields returned: `entity.name`, `entity.type`
- Reference: https://onekey.dev/docs/api/gumtree/search_suggestions.md

### gumtree.seller

A Gumtree seller profile.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/gumtree/seller?seller_id=A1B2C3D4E5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `seller_id` (string, required): Seller id
- Fields returned: `author.id`, `author.displayName`, `author.url`, `author.bio`, `author.location`, `ext.rating`, `ext.reviewCount`
- Reference: https://onekey.dev/docs/api/gumtree/seller.md

### gumtree.seller_listings

Active ads of a Gumtree seller.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/seller_listings?seller_id=A1B2C3D4E5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `seller_id` (string, required): Seller id
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `entity.location`, `media.thumbnailUrl`, `content.createdAt`
- Reference: https://onekey.dev/docs/api/gumtree/seller_listings.md

### gumtree.trending

Trending Gumtree searches.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gumtree/trending` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.name`, `entity.stats.rank`
- Reference: https://onekey.dev/docs/api/gumtree/trending.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/gumtree/locations_nearest?latitude=40.7128&longitude=-74.0060" \
  -H "x-api-key: YOUR_API_KEY"
```