Gumtree Locations

curl --request GET \
  --url https://socialquery.dev/v1/gumtree/locations \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://socialquery.dev/v1/gumtree/locations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "data": {
    "source": "scrapebadger",
    "next_cursor": null,
    "total": null,
    "coverage_note": "<string>",
    "query": "<string>",
    "items": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "LOCATION",
        "latitude": 123,
        "longitude": 123
      }
    ],
    "returned_count": 123,
    "source_window_count": 123
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

GET

gumtree

locations

Gumtree Locations

curl --request GET \
  --url https://socialquery.dev/v1/gumtree/locations \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://socialquery.dev/v1/gumtree/locations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "data": {
    "source": "scrapebadger",
    "next_cursor": null,
    "total": null,
    "coverage_note": "<string>",
    "query": "<string>",
    "items": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "LOCATION",
        "latitude": 123,
        "longitude": 123
      }
    ],
    "returned_count": 123,
    "source_window_count": 123
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

{
  "success": false,
  "platform": "<string>",
  "endpoint": "<string>",
  "credits_used": 1,
  "credits_remaining": 123,
  "request_id": "<string>",
  "cached": true,
  "error": {
    "code": "<string>",
    "type": "<string>",
    "message": "<string>",
    "status": 123,
    "doc_url": "<string>"
  }
}

Resolve a town or postcode prefix into a Gumtree UK autocomplete window. Query must contain 2–200 characters. location_type filters that fetched window and does not widen the search. Coordinates are null if unavailable. No pagination. One uncached successful request costs 5 SocialQuery credits. Cache hits and failed requests cost zero. Initial provider verification shares a fixed 200-credit allowance; an exhausted allowance prevents further upstream calls. Unknown values remain null.

Authorizations

x-api-key

string

header

required

Headers

Cache-Control

string

Idempotency-Key

string

X-Max-Credits

integer

Optional nonnegative integer cap on the maximum request hold. A live request whose hold exceeds this cap returns 422 CREDIT_BUDGET_EXCEEDED before spending. Metered holds use the requested limit; cache hits and successful idempotent replays cost zero.

Required range: x >= 0

Query Parameters

query

string

required

Required string length: 2 - 200

location_type

enum<string>

Available options:

LOCATION,

OUTCODE,

POSTCODE

Response

success

boolean

required

platform

string

required

endpoint

string

required

credits_used

integer

required

Required range: x >= 0

credits_remaining

integer | null

required

request_id

string

required

cached

boolean

required

data

object

required

The selected operation determines the resource fields in this object. Source data can omit a metric or report it as null.

Show child attributes