> ## Documentation Index
> Fetch the complete documentation index at: https://socialquery.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gumtree Search

> Search public Gumtree UK listing cards, 22 per page, up to three pages. Use query with optional UK place name in location_id and a supported section slug in category_id, or a Gumtree category/search URL by itself. Supports relevance and newest sorting. Numeric category/location IDs, distance/price/seller/attribute filters and price sorting are unavailable. GBP prices and source age labels are retained. Full descriptions require product lookup. Returned cursors exclude previously returned IDs when live rankings shift; direct page requests have no history.

Search public Gumtree UK listing cards, 22 per page, up to three pages. Use query with optional UK place name in location\_id and a supported section slug in category\_id, or a Gumtree category/search URL by itself. Supports relevance and newest sorting. Numeric category/location IDs, distance/price/seller/attribute filters and price sorting are unavailable. GBP prices and source age labels are retained. Full descriptions require product lookup.

A successful uncached call costs **5 credits**. Failed requests and cache hits cost zero. Failed or empty source output is not counted as successful data retrieval.

Pagination re-fetches a bounded source prefix, so new reviews or listings can shift rows. Only observed look-ahead rows produce a next cursor. A null cursor does not prove the complete archive was retrieved. Unknown fields remain null. Source runs use a pinned Actor build, limited permissions and a hard cost ceiling.

Returned cursors retain the listing IDs already sent and exclude repeats when ranking changes. Direct numeric page requests do not have that history. Inserts/removals can still change the window, so continuation is not a frozen catalog snapshot.


## OpenAPI

````yaml GET /gumtree/search
openapi: 3.1.0
info:
  title: SocialQuery API
  version: '2026-10-09'
  description: >-
    Documented requests for public-source records. Inspect accepted inputs and
    credit amounts, then verify the selected operation before integrating
    preview coverage.
servers:
  - url: https://socialquery.dev/v1
security:
  - apiKey: []
paths:
  /gumtree/search:
    get:
      tags:
        - Gumtree
      summary: Gumtree Search
      description: >-
        Search public Gumtree UK listing cards, 22 per page, up to three pages.
        Use query with optional UK place name in location_id and a supported
        section slug in category_id, or a Gumtree category/search URL by itself.
        Supports relevance and newest sorting. Numeric category/location IDs,
        distance/price/seller/attribute filters and price sorting are
        unavailable. GBP prices and source age labels are retained. Full
        descriptions require product lookup. Returned cursors exclude previously
        returned IDs when live rankings shift; direct page requests have no
        history.
      operationId: get_gumtree_search
      parameters:
        - name: query
          in: query
          required: false
          example: iphone
          schema:
            type: string
        - name: url
          in: query
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 3
          description: Bounded source window, page 1–3; do not combine with cursor.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - relevance
              - newest
              - price_low
              - price_high
          description: relevance or newest. price_low/price_high return 422.
        - name: category_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Section slug: for-sale, cars, vans, motorbikes, property-for-sale,
            property-to-rent or jobs. Numeric IDs return 422.
        - name: location_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            UK place name, for example london or manchester. Numeric IDs return
            422.
        - name: distance
          in: query
          required: false
          schema:
            type: string
            enum:
              - '0'
              - '1'
              - '3'
              - '5'
              - '10'
              - '15'
              - '30'
              - '50'
              - '75'
              - '100'
              - '150'
              - '250'
              - '500'
              - nationwide
          description: Unavailable with this public listing source; returns 422.
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          description: Unavailable with this public listing source; returns 422.
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          description: Unavailable with this public listing source; returns 422.
        - name: seller_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - private
              - trade
          description: Unavailable with this public listing source; returns 422.
        - name: attributes
          in: query
          required: false
          schema:
            type: string
          description: Unavailable with this public listing source; returns 422.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Opaque agt1_ cursor bound to identical filters and previously
            returned listing IDs. Excludes repeats. Do not combine with page.
        - name: Cache-Control
          in: header
          required: false
          example: no-cache
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          required: false
          example: 7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c
          schema:
            type: string
        - name: X-Max-Credits
          in: header
          required: false
          description: >-
            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.
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: >-
            Search public Gumtree UK listing cards, 22 per page, up to three
            pages. Use query with optional UK place name in location_id and a
            supported section slug in category_id, or a Gumtree category/search
            URL by itself. Supports relevance and newest sorting. Numeric
            category/location IDs, distance/price/seller/attribute filters and
            price sorting are unavailable. GBP prices and source age labels are
            retained. Full descriptions require product lookup.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SocialQueryResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                product:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    url:
                                      type: string
                                    title:
                                      type: string
                                    description:
                                      type:
                                        - string
                                        - 'null'
                                    seller:
                                      type:
                                        - object
                                        - 'null'
                                      properties:
                                        name:
                                          type:
                                            - string
                                            - 'null'
                                        id:
                                          type: 'null'
                                        url:
                                          type: 'null'
                                    brand:
                                      type: 'null'
                                    price:
                                      type: object
                                      properties:
                                        current:
                                          type:
                                            - number
                                            - 'null'
                                          minimum: 0
                                        original:
                                          type: 'null'
                                        currency:
                                          type: string
                                          const: GBP
                                    rating:
                                      type: object
                                      properties:
                                        average:
                                          type: 'null'
                                        count:
                                          type: 'null'
                                    image_urls:
                                      type: array
                                      items:
                                        type: string
                                    availability:
                                      type: 'null'
                                    reviews_count:
                                      type: 'null'
                                    features:
                                      type: 'null'
                                    specifications:
                                      type: 'null'
                                    variations:
                                      type: 'null'
                                    ext:
                                      type: object
                                      properties:
                                        location:
                                          type:
                                            - string
                                            - 'null'
                                        condition:
                                          type:
                                            - string
                                            - 'null'
                                        category:
                                          type:
                                            - string
                                            - 'null'
                                        seller_type:
                                          type:
                                            - string
                                            - 'null'
                                        posted_age:
                                          type:
                                            - string
                                            - 'null'
                                        source_posted_at:
                                          type:
                                            - string
                                            - 'null'
                                        delivery_available:
                                          type:
                                            - boolean
                                            - 'null'
                                        promotions:
                                          type:
                                            - array
                                            - 'null'
                                          items:
                                            type: string
                          returned_count:
                            type: integer
                          total:
                            type: 'null'
                          next_cursor:
                            type:
                              - string
                              - 'null'
                          window_truncated:
                            type: boolean
                          dropped:
                            type: integer
                            const: 0
                          coverage_note:
                            type: string
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '405':
          $ref: '#/components/responses/Error405'
        '409':
          $ref: '#/components/responses/Error409'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
        '502':
          $ref: '#/components/responses/Error502'
        '503':
          $ref: '#/components/responses/Error503'
        '504':
          $ref: '#/components/responses/Error504'
components:
  schemas:
    SocialQueryResponse:
      type: object
      required:
        - success
        - platform
        - endpoint
        - credits_used
        - credits_remaining
        - request_id
        - cached
        - data
      properties:
        success:
          type: boolean
          const: true
        platform:
          type: string
        endpoint:
          type: string
        credits_used:
          type: integer
          minimum: 0
        credits_remaining:
          type:
            - integer
            - 'null'
        request_id:
          type: string
        cached:
          type: boolean
        data:
          type: object
          additionalProperties: true
          description: >-
            The selected operation determines the resource fields in this
            object. Source data can omit a metric or report it as null.
    SocialQueryError:
      type: object
      required:
        - success
        - platform
        - endpoint
        - credits_used
        - credits_remaining
        - request_id
        - cached
        - error
      properties:
        success:
          type: boolean
          const: false
        platform:
          type: string
        endpoint:
          type: string
        credits_used:
          type: integer
          minimum: 0
        credits_remaining:
          type:
            - integer
            - 'null'
        request_id:
          type: string
        cached:
          type: boolean
        error:
          type: object
          required:
            - code
            - type
            - message
            - status
            - doc_url
          properties:
            code:
              type: string
            type:
              type: string
            message:
              type: string
            status:
              type: integer
            doc_url:
              type: string
              format: uri
  responses:
    Error400:
      description: Upstream rejected the request.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error401:
      description: Missing, expired, invalid, or revoked API key.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error402:
      description: Insufficient SocialQuery credits.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error403:
      description: Key scope or provider policy denied access.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error404:
      description: Endpoint or upstream resource not found.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error405:
      description: HTTP method is not supported.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error409:
      description: Idempotency conflict or request in progress.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error422:
      description: Invalid parameters.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error429:
      description: Request limit reached.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error500:
      description: Request processing failed.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error502:
      description: Upstream service failed.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error503:
      description: Provider or required service is unavailable.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
    Error504:
      description: Upstream service timed out.
      headers:
        X-Request-Id:
          schema:
            type: string
        X-Credits-Used:
          schema:
            type: integer
        X-Credits-Remaining:
          schema:
            type: string
        X-Cache:
          schema:
            type: string
            enum:
              - HIT
              - MISS
              - BYPASS
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SocialQueryError'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.