ApiSearchParams

Partner Id

Market id

State abbreviation

State name

Market name

Search location

Number of images

Origin Latitude

Origin Longitude

Radius

Min Latitude

Min Longitude

Max Latitude

Max Longitude

Markets ids list splited by ','

Community City

Cities splited by ','

County name

Counties list splited by ','

Postal Code

Postal Codes list splited by ','

Builder id

Builder ids list, splited by ','

Brand id

Brand ids list, splited by ','

Parent Community Id

Filter by Community Id

Filter by Community Name

Comma-separated Community ids

Single Plan id

Plan name

Comma-separated plan ids

Single spec id

Comma-separated specs ids

Single Lot id

Listings ids splited by ','

Page Size (Default = 10)

Page Index

Sort by

Use Sort order

Sort first by

Sort second by

Sort Second By Order (doesn't apply for Distance or Random)

List communities ids, used only when result type is Community or brands and sort by is set as AppendToList

List plans ids, used when sort by value is AppendToList, could be sent with the SpecIdsSort

List specs ids, used when sort by value is AppendToList, could be sent with the PlanIdsSort

Get Gated

Get Communities that have pool

Get Communities that have golf courses

Get communitites that have green programs

Get communitites that have nature areas

Get communitites that have parks

Get communitites that have views

Get communities that have Waterfront

Get communities that sports areas

Is adult community

Is age restricted

Single Family

Multi Family

Condominium

Town Home

Get Communities that has agent or consumer promo

Consumer Promos

Agent Promos

Is Hot Deal

Get the communities that have events

Community Status (Comma Separated List):

• N - Active
• C - Coming Soon
• G - Grand Opening
• X - Close Out
• CG - ComingSoonGrandOpening

Comma separated list of Home Statuses

• A - Available Now
• M - Model
• R - Ready To Build
• UC - Under Construction
• H - Hot Deal

Comma separated list of Home Statuses, this will be an OR

• A - Available Now
• M - Model
• R - Ready To Build
• UC - Under Construction

Bedrooms

Bathrooms

Garages

Living Areas

Stories

Story Number

Master Bed Location

• 0 or Not Present - Doesn't apply any filter and return all values, the same as if the filter is not provided
• 1 - Only Upstair results. MasterBedLoc field in the result, will always return 1 (Upstairs)
• 2 - Only Downstair results. MasterBedLoc field in the result, will always return 0 (Downstairs)

Price Low

Price Low

Square Feet Low

Square Feet High

Include Image info in response regardless any other image parameter is passed or not

List of Image Categories

List of Image Color Types

List of Image Types
360: Image360
AGT: AgentPhoto
ASL: AccreditationSeal
BAA: BrandAwards
BKL: BrokerLogo
BRD: BrandImage
BVT: BuilderVideoTestimonial
CBR: CommunityBanner
CML: CommunityLogo
CMP: CommunityMap
CMT: ComMapThumbnail
COM: Community
CVT: ComVideoTestimonial
EBR: Ebrochure
EDC: PlanEDCLink
EDS: SpecEDCLink
EDX: CommunityEDCLink
ELE: Elevation
EVW: EView
FCI: FeaturedCommunity
FLP: FloorPlan
GEC: EnergyConservation
GHH: HealthyHome
GOG: GreenPractices
GPR: GreenProgram
GSM: SustainableMaterialsAndResources
GWC: WaterConservation
INT: Interior
LOT: LotMap
LST: ListingImage
LTI: LotImage
MAP: DrivingDirectionMap
MED: BrandMediumLogo
PBD: PlanBrandLogo
SML: BrandSmallLogo
SVT: CommunityVideoTour
VIR: VirtualTour

Min Image Width

Min Image Height

Filter by a List of Image Ids

Include 360 images

Set the 360 images at the end

Include MPC Communities

Filter only Comms with Luxury Homes, or Luxury Homes Listings

Quick Move-in

Used in conjunction with IncludeMpc paramater, to determine if it should match communities that are both Basic and MPC

Get only the counts

Used to know if is a hot home

Apply custom types to project types ("SBC", "MPC", "ADU", "THM", "CON")

Display plans and specs for Custom, Boyl or Mfr comms, that have an Address (alpha change)

Get all which are no build own your lot

Exclude regular Communities

Get all which are build own your Lot

Get all Custom

Manufactured

Gets all new custom brands

Is partner site (Ignored if is null)

Get the last cached

Save into cache

Extend Community Detail information. Applied to result type Comm (Ignored if is null)

Extend Home Detail information. Applied to result type Home (Ignored if is null)

Extend Map Points information. Applied when result fomart is LatLong (Ignored if is null)

Number of max row to return

School District Ids

Remove Quick Moves In From Adds (Ignored if is null)

Save Search Id

Randomize the Results at the end, just before sending to the caller

Used for the order by methods only when the result type are Homes

Used to add additional options to the Api Home object

Back Fill Images

Include Bookmarks (requires User Id)

User Id to Retrieve Bookmarks

Include Interactive Media in Search Results

Include Images in Search Results

Include Videos in Search Results

Include the floor plan url image as part of the SummaryInfo Endpoints

Includes final Video Urls when videos come from Brightcove, by using Brightcove API

Calculates Home Counts from Results and not from Community Ranges

Filter by a Draw in the Map

This will return the Builder Id list in Facet area. Since there are a lot of builderIds this facet will be only populate when countsonly is present for now.

This will return the Market list in Facet area

This will return the minimum results for communities

This will remove brand information from results with the idea to remove unnecesary information from the JSON Result

Get only homes with plan options

Get Homes with open amenities

Client Name

Session Token

Include Brand Showcase for search/brands

Get the portfolio homes (Spec type G).

Exclude Basic Listings

Exclude Basic Communities

Exclude Facets in the result set

Exclude Counts and facets

Exclude Summary

Exclude Custom Amenities

Exclude description

Exclude Interactive media

Exclude Images

Exclude Floor Plans

Exclude Videos

Exclude School Districts

Exclude Floor Plan Viewer URL

Exclude Envision URL

Exclude Toll Free Number

Exclude Home Options

Exclude Builder Map

Exclude Video Tour

Exclude Amenities

Exclude Promotions

Exclude Events

Exclude Agents

Exclude Non PDF Brochure

Exclude Utilities

Exclude Community Map

Exclude Fees and Taxes

When using BuilderId parameter, this returns Communities with a distinct (and not equal) Builder Id.

Exclude home info from HomeLocations