Rechat SDK
    Preparing search index...

    Interface IListingsFilters

    interface IListingsFilters {
        agents?: string[];
        architectural_styles?: string[];
        boundaries?: string[];
        brand?: string;
        brands?: string[];
        content?: string;
        counties?: string[];
        limit?: number;
        list_agents?: string[];
        list_offices?: string[];
        listing_statuses: string[];
        maximum_bedrooms?: number;
        maximum_lot_square_meters?: number;
        maximum_price?: number;
        maximum_square_meters?: number;
        maximum_year_built?: number;
        minimum_bathrooms?: number;
        minimum_bedrooms?: number;
        minimum_lot_square_meters?: number;
        minimum_parking_spaces?: number;
        minimum_price?: number;
        minimum_sold_date?: number;
        minimum_square_meters?: number;
        minimum_year_built?: number;
        mls_areas?: string[];
        mls_number?: string[];
        mlses?: string[];
        office_exclusive?: boolean;
        offset?: number;
        open_house?: boolean;
        points?: { latitude: number; longitude: number }[];
        pool?: boolean;
        postal_codes?: string[];
        property_subtypes?: string[];
        property_types?: string[];
        school_districts?: string[];
        sort?: IListingSort[];
        subdivisions?: string[];
    }
    Index

    Filters

    agents? architectural_styles? content? list_agents? list_offices? listing_statuses maximum_bedrooms? maximum_lot_square_meters? maximum_price? maximum_square_meters? maximum_year_built? minimum_bathrooms? minimum_bedrooms? minimum_lot_square_meters? minimum_parking_spaces? minimum_price? minimum_sold_date? minimum_square_meters? minimum_year_built? mls_number? mlses? office_exclusive? open_house? pool? property_subtypes? property_types?

    General

    brand? brands? limit? offset?

    Geo

    boundaries? counties? mls_areas? points? postal_codes? school_districts? subdivisions?

    Sorting

    sort?

    Filters

    agents?: string[]
    architectural_styles?: string[]

    Optionalcontent

    content?: string

    Free-text match against listing content rather than the address index. Use it when an address or boundary search returns nothing.

    list_agents?: string[]
    list_offices?: string[]
    listing_statuses: string[]
    maximum_bedrooms?: number
    maximum_lot_square_meters?: number
    maximum_price?: number
    maximum_square_meters?: number
    maximum_year_built?: number
    minimum_bathrooms?: number
    minimum_bedrooms?: number
    minimum_lot_square_meters?: number
    minimum_parking_spaces?: number
    minimum_price?: number
    minimum_sold_date?: number
    minimum_square_meters?: number
    minimum_year_built?: number
    mls_number?: string[]
    mlses?: string[]

    Brokerage-side MLS scope. When set, the API restricts every search to listings whose mls value is in this list, regardless of the user's other filter selections.

    office_exclusive?: boolean
    open_house?: boolean
    pool?: boolean
    property_subtypes?: string[]
    property_types?: string[]

    General

    brand?: string

    Single owning brand. Superseded by brands, which takes any number.

    brands?: string[]

    One or more brands the listing must belong to — it matches when it belongs to any one of them. Accepted on every listing endpoint, portal and direct alike.

    limit?: number
    offset?: number

    Geo

    boundaries?: string[]
    counties?: string[]
    mls_areas?: string[]
    points?: { latitude: number; longitude: number }[]
    postal_codes?: string[]
    school_districts?: string[]
    subdivisions?: string[]

    Sorting

    sort?: IListingSort[]

    Ordering, primary key first. Read by the portal-routed endpoints; the direct /valerts path orders through the order_by[] query parameter instead. Omit to leave results unsorted.

    Settings

    Member Visibility

    On This Page

    Filters
    General
    Geo
    Sorting