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

# /trademe/properties/search

> Search TradeMe property listings within a New Zealand location. Choose a channel (for sale, for rent, commercial, rural, retirement). Returns listing cards: id, url, address, price and sale method, rent per week, bedrooms/bathrooms/parking, floor area, property type, coordinates, images, open-home times, listing date and the marketing agency. Filter by price, bedrooms, bathrooms, parking, land/floor area, property type, sale method, property features, keywords and sort order.

**Price:** 10 credits per 50 results

**⚠️ Common errors:** 412: Location not found or no listings matched



## OpenAPI

````yaml /openapi/real-estate.json post /api/trademe/properties/search
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/trademe/properties/search:
    post:
      tags:
        - /trademe
      summary: /trademe/properties/search
      description: >-
        Search TradeMe property listings within a New Zealand location. Choose a
        channel (for sale, for rent, commercial, rural, retirement). Returns
        listing cards: id, url, address, price and sale method, rent per week,
        bedrooms/bathrooms/parking, floor area, property type, coordinates,
        images, open-home times, listing date and the marketing agency. Filter
        by price, bedrooms, bathrooms, parking, land/floor area, property type,
        sale method, property features, keywords and sort order.


        **Price:** 10 credits per 50 results


        **⚠️ Common errors:** 412: Location not found or no listings matched
      operationId: __api_trademe_properties_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrademePropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TrademeSearchListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TrademePropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location:
          type: string
          minLength: 1
        channel:
          $ref: '#/components/schemas/TrademeChannel'
          default: sale
        count:
          type: integer
          minimum: 1
        price_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        bedrooms_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        bedrooms_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        bathrooms_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        parking_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        living_areas_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        land_area_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        land_area_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        floor_area_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        floor_area_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        property_types:
          anyOf:
            - items:
                $ref: '#/components/schemas/TrademePropertyType'
              type: array
            - type: 'null'
        sales_methods:
          anyOf:
            - items:
                $ref: '#/components/schemas/TrademeSalesMethod'
              type: array
            - type: 'null'
        property_features:
          anyOf:
            - items:
                $ref: '#/components/schemas/TrademePropertyFeature'
              type: array
            - type: 'null'
        keywords:
          anyOf:
            - type: string
            - type: 'null'
        open_homes_only:
          anyOf:
            - type: boolean
            - type: 'null'
        new_homes_only:
          anyOf:
            - type: boolean
            - type: 'null'
        home_income_only:
          anyOf:
            - type: boolean
            - type: 'null'
        pets_ok:
          anyOf:
            - type: boolean
            - type: 'null'
        available_now:
          anyOf:
            - type: boolean
            - type: 'null'
        sort:
          $ref: '#/components/schemas/TrademeSortOrder'
          default: Default
      type: object
      required:
        - location
        - count
    TrademeSearchListing:
      properties:
        '@type':
          type: string
          default: TrademeSearchListing
        id:
          type: integer
        url:
          anyOf:
            - type: string
            - type: 'null'
        region:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        suburb:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        price_display:
          anyOf:
            - type: string
            - type: 'null'
        sale_method:
          anyOf:
            - type: string
            - type: 'null'
        sale_date:
          anyOf:
            - type: string
            - type: 'null'
        rent_per_week:
          anyOf:
            - type: integer
            - type: 'null'
        available_date:
          anyOf:
            - type: string
            - type: 'null'
        property_type:
          anyOf:
            - type: string
            - type: 'null'
        bedrooms:
          anyOf:
            - type: integer
            - type: 'null'
        bathrooms:
          anyOf:
            - type: integer
            - type: 'null'
        parking:
          anyOf:
            - type: integer
            - type: 'null'
        floor_area:
          anyOf:
            - type: integer
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        has_video:
          anyOf:
            - type: boolean
            - type: 'null'
        is_featured:
          anyOf:
            - type: boolean
            - type: 'null'
        listed_at:
          anyOf:
            - type: string
            - type: 'null'
        member_id:
          anyOf:
            - type: integer
            - type: 'null'
        open_homes:
          items:
            $ref: '#/components/schemas/TrademeOpenHome'
          type: array
          default: []
        agency:
          anyOf:
            - $ref: '#/components/schemas/TrademeSearchAgency'
            - type: 'null'
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    TrademeChannel:
      type: string
      enum:
        - sale
        - rent
        - commercial-sale
        - commercial-lease
        - rural
        - retirement
    TrademePropertyType:
      type: string
      enum:
        - Apartment
        - House
        - Townhouse
        - Unit
        - Section
        - BareLand
        - Dwelling
        - CarPark
    TrademeSalesMethod:
      type: string
      enum:
        - PriceDisplayed
        - Negotiation
        - Auction
        - Tender
        - DeadlineSale
    TrademePropertyFeature:
      type: string
      enum:
        - garage
        - ensuite
        - study
        - toilet
    TrademeSortOrder:
      type: string
      enum:
        - Default
        - PriceAsc
        - PriceDesc
        - ExpiryDesc
        - EarliestOpenHome
    TrademeOpenHome:
      properties:
        '@type':
          type: string
          default: TrademeOpenHome
        start_at:
          anyOf:
            - type: string
            - type: 'null'
        end_at:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    TrademeSearchAgency:
      properties:
        '@type':
          type: string
          default: TrademeSearchAgency
        id:
          type: integer
        name:
          anyOf:
            - type: string
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        website:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````