API reference
Gumtree Listing API
One listing's page: description, price, category path, location, attributes, images, the seller's profile and the seller ids the seller routes take.
Endpoint
GET/v1/gumtree/productlive · proven2 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Ad id (or pass url, the listing's page) | 1513645531 |
url | no | The listing's page URL instead of an id | |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl
curl "https://www.monocrawl.com/v1/gumtree/product?id=1513645531" \ -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/gumtree/product?id=1513645531",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/gumtree/product?id=1513645531",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
200 · application/json
{
"success": true,
"platform": "gumtree",
"endpoint": "/v1/gumtree/product",
"data": {
"age_days": 0,
"attributes": [
{
"label": "example",
"value": "example"
}
],
"category": "example",
"category_id": "example",
"category_path": [
"example"
],
"contact": {
"has_email": false,
"has_phone": false,
"has_website": false
},
"currency": "example",
"description": "example",
"id": "example",
"images": [
"example"
],
"images_count": 0,
"location": {
"approximate": false,
"id": "example",
"latitude": 0,
"longitude": 0,
"name": "example"
},
"map_image_url": "https://example.com/example",
"platform": "example",
"posted": "example",
"price": 0,
"price_label": "example",
"price_pence": 0,
"seller": {
"active_status": "example",
"identity_verified": false,
"platform": "example",
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"type": "example",
"user_id": "example"
},
"title": "example",
"trade_seller": false,
"type": "example",
"url": "https://example.com/example"
},
"credits_used": 2,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
age_days | number | null | Optional age days supplied by this operation. Null means unknown. |
attributes | array | null | Optional attributes supplied by this operation. Null means unknown. |
attributes[].label | string | null | Optional label supplied by this operation. Null means unknown. |
attributes[].value | string | null | Optional value supplied by this operation. Null means unknown. |
category | string | null | Optional category supplied by this operation. Null means unknown. |
category_id | string | null | Optional category id supplied by this operation. Null means unknown. |
category_path | array | null | Optional category path supplied by this operation. Null means unknown. |
contact | object | null | Optional contact supplied by this operation. Null means unknown. |
contact.has_email | boolean | null | Optional has email supplied by this operation. Null means unknown. |
contact.has_phone | boolean | null | Optional has phone supplied by this operation. Null means unknown. |
contact.has_website | boolean | null | Optional has website supplied by this operation. Null means unknown. |
currency | string | null | Optional currency supplied by this operation. Null means unknown. |
description | string | null | Source description; null or absent means not supplied. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
images | array | null | Optional images supplied by this operation. Null means unknown. |
images_count | number | null | Optional images count supplied by this operation. Null means unknown. |
location | object | null | Optional location supplied by this operation. Null means unknown. |
location.approximate | boolean | null | Optional approximate supplied by this operation. Null means unknown. |
location.id | string | null | Source identifier. Preserve the supplied type and exact value. |
location.latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
location.longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
location.name | string | null | Optional name supplied by this operation. Null means unknown. |
map_image_url | string | null | Optional map image url supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
posted | string | null | Optional posted supplied by this operation. Null means unknown. |
price | number | null | Source price. Currency, taxes and availability depend on the listing. |
price_label | string | null | Optional price label supplied by this operation. Null means unknown. |
price_pence | number | null | Optional price pence supplied by this operation. Null means unknown. |
seller | object | null | Optional seller supplied by this operation. Null means unknown. |
seller.active_status | string | null | Optional active status supplied by this operation. Null means unknown. |
seller.identity_verified | boolean | null | Optional identity verified supplied by this operation. Null means unknown. |
seller.platform | string | null | Optional platform supplied by this operation. Null means unknown. |
seller.rating | object | null | Source rating; read its accompanying scale and vote count. |
seller.rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
seller.rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
seller.rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
seller.type | string | null | Optional type supplied by this operation. Null means unknown. |
seller.user_id | string | null | Optional user id supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
trade_seller | boolean | null | Optional trade seller supplied by this operation. Null means unknown. |
type | string | null | Optional type supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference