> ## 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.

# /onthemarket/properties/search

> Search OnTheMarket properties for sale, to rent or new homes within a location. Returns property cards: id, url, address, property title and type, price, bedroom/bathroom counts, listing features, images, coordinates, status labels and the marketing agent. Filter by radius, price range, bedrooms, property types, keywords, how recently the listing was added, tenancy terms and a large set of include/exclude flags.

**Price:** 5 credits per 30 results

**⚠️ Common errors:** 412: Location not found



## OpenAPI

````yaml /openapi/real-estate.json post /api/onthemarket/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/onthemarket/properties/search:
    post:
      tags:
        - /onthemarket
      summary: /onthemarket/properties/search
      description: >-
        Search OnTheMarket properties for sale, to rent or new homes within a
        location. Returns property cards: id, url, address, property title and
        type, price, bedroom/bathroom counts, listing features, images,
        coordinates, status labels and the marketing agent. Filter by radius,
        price range, bedrooms, property types, keywords, how recently the
        listing was added, tenancy terms and a large set of include/exclude
        flags.


        **Price:** 5 credits per 30 results


        **⚠️ Common errors:** 412: Location not found
      operationId: __api_onthemarket_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/OnthemarketPropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OnthemarketPropertyCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OnthemarketPropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location_id:
          type: string
          minLength: 1
        search_type:
          $ref: '#/components/schemas/OnthemarketSearchType'
        count:
          type: integer
          minimum: 1
        radius:
          anyOf:
            - $ref: '#/components/schemas/OnthemarketRadius'
            - type: 'null'
        min_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_frequency:
          anyOf:
            - $ref: '#/components/schemas/OnthemarketPriceFrequency'
            - type: 'null'
        min_bedrooms:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_bedrooms:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        property_type:
          anyOf:
            - items:
                $ref: '#/components/schemas/OnthemarketPropertyType'
              type: array
            - type: 'null'
        keywords:
          anyOf:
            - type: string
            - type: 'null'
        added_since:
          anyOf:
            - $ref: '#/components/schemas/OnthemarketAddedSince'
            - type: 'null'
        sort:
          $ref: '#/components/schemas/OnthemarketSortOrder'
          default: recommended
        include_under_offer:
          anyOf:
            - type: boolean
            - type: 'null'
        include_let_agreed:
          anyOf:
            - type: boolean
            - type: 'null'
        furnished:
          anyOf:
            - $ref: '#/components/schemas/OnthemarketFurnished'
            - type: 'null'
        let_length:
          anyOf:
            - $ref: '#/components/schemas/OnthemarketLetLength'
            - type: 'null'
        auction:
          anyOf:
            - type: boolean
            - type: 'null'
        shared_ownership:
          anyOf:
            - type: boolean
            - type: 'null'
        new_build:
          anyOf:
            - type: boolean
            - type: 'null'
        retirement:
          anyOf:
            - type: boolean
            - type: 'null'
        student:
          anyOf:
            - type: boolean
            - type: 'null'
        shared_accommodation:
          anyOf:
            - type: boolean
            - type: 'null'
        pet_friendly:
          anyOf:
            - type: boolean
            - type: 'null'
        accessible_features:
          anyOf:
            - type: boolean
            - type: 'null'
        greener_choice:
          anyOf:
            - type: boolean
            - type: 'null'
        recently_reduced:
          anyOf:
            - type: boolean
            - type: 'null'
        matterport_tour:
          anyOf:
            - type: boolean
            - type: 'null'
        virtual_tour:
          anyOf:
            - type: boolean
            - type: 'null'
        video:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
      required:
        - location_id
        - search_type
        - count
    OnthemarketPropertyCard:
      properties:
        '@type':
          type: string
          default: OnthemarketPropertyCard
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        property_title:
          anyOf:
            - type: string
            - type: 'null'
        property_type:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: number
            - type: 'null'
        display_price:
          anyOf:
            - type: string
            - type: 'null'
        short_price:
          anyOf:
            - type: string
            - type: 'null'
        price_qualifier:
          anyOf:
            - type: string
            - type: 'null'
        bedroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        bathroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        features:
          items:
            type: string
          type: array
          default: []
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        main_label:
          anyOf:
            - type: string
            - type: 'null'
        added_reduced_label:
          anyOf:
            - type: string
            - type: 'null'
        is_spotlight:
          anyOf:
            - type: boolean
            - type: 'null'
        agent_id:
          anyOf:
            - type: integer
            - type: 'null'
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
        agent_alias:
          anyOf:
            - type: string
            - type: 'null'
        agent_phone:
          anyOf:
            - type: string
            - type: 'null'
        agent_image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    OnthemarketSearchType:
      type: string
      enum:
        - for-sale
        - to-rent
        - new-homes
    OnthemarketRadius:
      type: string
      enum:
        - '0'
        - '0.25'
        - '0.5'
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        - '7.5'
        - '10'
        - '15'
        - '20'
        - '30'
        - '40'
    OnthemarketPriceFrequency:
      type: string
      enum:
        - pcm
        - pw
    OnthemarketPropertyType:
      type: string
      enum:
        - detached
        - semi-detached
        - terraced
        - bungalow
        - flats-apartments
        - farms-land
        - park-homes
    OnthemarketAddedSince:
      type: string
      enum:
        - 24-hours
        - 3-days
        - 7-days
    OnthemarketSortOrder:
      type: string
      enum:
        - recommended
        - price_high
        - price_low
        - recent
    OnthemarketFurnished:
      type: string
      enum:
        - furnished
        - part-furnished
        - unfurnished
    OnthemarketLetLength:
      type: string
      enum:
        - long-term
        - short-term
    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

````