API Reference

Locations autocomplete

get
https://api.repliers.io/locations/autocomplete

Autocomplete for Locations search. As your user types, you simply pass their input into search param and get locations which match their input. You can use other params to fine-tune the locations which will be returned for a given search.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length between 3 and 100

Search query string

source
array of objects

Filters locations by source:

  • MSL - Locations sourced from MLS (Multiple Listing Service) data.
  • UserDefined - Custom locations created and defined by users.
  • LiveBy - Locations sourced from LiveBy, a third-party neighborhood and community data provider.
source
type
array of objects

Limits results to specified location types:

  • area - Represents larger geographical divisions that may contain multiple cities and neighborhoods. Examples of Areas are counties, regions etc.
  • city - Municipal division that can include multiple neighborhoods within its boundaries.
  • city-alternate - Alternate representation of a city, used for specific data sources or contexts.
  • neighborhood - Smallest geographical unit within a city.
  • neighborhood-alternate - Alternate representation of a neighborhood, used for specific data sources or contexts.
  • postalCode - Represents postal code areas, which may span multiple neighborhoods or cities.
  • district - Represents administrative or political districts, which may span multiple neighborhoods or cities.
  • schoolDistrict - Represents school district areas, which may span multiple neighborhoods or cities.
  • school - Represents specific school locations and catchment areas.
type
string
length ≤ 500

Comma-separated list of fields to include in the response. This allows clients to request only the specific data they need, reducing payload size. Examples:

  • name,type - Returns only location names and types
  • name,address.city,address.state - Returns location names and specific address components
  • map.boundary - Returns only geographical boundary data
json

GeoJSON polygon or multi-polygon boundary for geographical filtering. Limits results to locations within the specified boundaries. For complex polygons or multipolygons that exceed query parameter size limits, use the POST method and include the map data in the request body.

Format: Array of coordinate arrays, where each coordinate is [longitude, latitude] in WGS 84 format. The polygon must be closed (first and last points must be identical).

For more information refer to the implementation guide Filtering Listings Geo-Spatially Using the "map" Parameter

integer
1 to 10
Defaults to 10

The amount of locations to return in each page of the results set.

float

Accepts a value for radius in KM. Must be used with lat and long parameters to return locations within the specified radius of a given latitude and longitude.

float
-90 to 90

Accepts a value for latitude. Must be used with long parameter. When used with radius, returns locations within the specified radius of these coordinates.

float
-180 to 180

Accepts a value for longitude. Must be used with lat parameter. When used with radius, returns locations within the specified radius of these coordinates.

state
array of strings

Filters locations by 2-letter State/Province/Territory codes. Returns locations within the specified states.

state
area
array of strings

Searches for locations only inside specified areas. Areas represent larger geographical divisions that may contain multiple cities and neighborhoods. Examples of Areas are counties, regions etc.

area
city
array of strings

Searches for locations only inside specified cities. Cities can include multiple neighborhoods within their boundaries.

city
boolean
Defaults to null

Fetches locations with boundary polygons for a small performance penalty of 10-20ms

boolean
Defaults to null

Only search through locations that have boundary polygons

float

Filters locations by minimum size (in square kilometers).

float

Filters locations by maximum size (in square kilometers).

classification
array of strings

Filters locations by classification.

classification
subType
array of strings

Filters locations by sub-type.

subType
Responses

403

Forbidden

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago