What you get#
Onekey exposes Gumtree as 11 endpoints behind one API key: 3 endpoints return one record (data is an object) and 8 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Gumtree also works for the rest of the e-commerce & marketplaces category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
categories | The Gumtree category tree. | - | 2 | beta needs a pack |
filters | Filters available for a Gumtree category. | category_id* | 2 | beta needs a pack |
locations | Autocomplete Gumtree locations (place, postcode, outcode). | query* | 2 | beta needs a pack |
locations_nearest | The nearest Gumtree location to a coordinate. | latitude, longitude, location_coordinate | 2 | beta needs a pack |
product | A Gumtree ad by id. | product_id, url | 2 | beta needs a pack |
product_similar | Ads similar to a Gumtree ad. | product_id, url | 2 | beta needs a pack |
search | Search Gumtree UK listings. | query*, cursor | 2 | beta needs a pack |
search_suggestions | Search suggestions for Gumtree. | query* | 2 | beta needs a pack |
seller | A Gumtree seller profile. | seller_id* | 2 | beta needs a pack |
seller_listings | Active ads of a Gumtree seller. | seller_id*, cursor | 2 | beta needs a pack |
trending | Trending Gumtree searches. | - | 2 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls gumtree.locations_nearest (2 credits, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/gumtree/locations_nearest?latitude=40.7128&longitude=-74.0060" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Gumtree, with the same names as on every other platform. The count is how many of its 11 mapped endpoints return the field; a field the source lacks is null, never missing. 3 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Every Gumtree endpoint costs 2 credits per call. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.