Gumtree API
Gumtree category filters
The filters a category offers, with their kinds, parameters and options.
Endpoint
/v1/gumtree/filterslive · proven2 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
category | yes | Category id | 9311 |
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 "https://www.monocrawl.com/v1/gumtree/filters?category=9311" \ -H "x-api-key: mn_your_key_here"
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/filters?category=9311",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/gumtree/filters?category=9311",
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.
{
"success": true,
"platform": "gumtree",
"endpoint": "/v1/gumtree/filters",
"data": {
"category_id": "example",
"count": 0,
"has_more": false,
"items": [
{
"kind": "example",
"label": "example",
"max_param": "example",
"min_param": "example",
"name": "example",
"options": [
{}
]
}
]
},
"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 |
|---|---|---|
category_id | string | null | Optional category id supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].kind | string | null | Optional kind supplied by this operation. Null means unknown. |
items[].label | string | null | Optional label supplied by this operation. Null means unknown. |
items[].max_param | string | null | Optional max param supplied by this operation. Null means unknown. |
items[].min_param | string | null | Optional min param supplied by this operation. Null means unknown. |
items[].name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].options | array | null | Optional options supplied by this operation. Null means unknown. |
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