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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

required

length between 3 and 100

Search query string

locationId

array of strings

length ≤ 50

Limits results to the specified locationIds. Repeat the parameter to supply multiple values, up to 50.

locationId

source

array of objects

Filters locations by source:

MLS - 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.
PublicRecord - Locations sourced from Public Records Data.

UserDefined, LiveBy and PublicRecord require the corresponding data to be enabled on your account. Requesting a source that is not enabled for your account returns a 400 error.

source

Allowed:

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.
property - Represents individual properties or land parcels along with publicly available information derived from public records data.

type

fields

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

map

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

resultsPerPage

integer

1 to 10

Defaults to 10

The number of locations to return per page.

radius

float

Accepts a value for radius, expressed in the unit set by radiusUnit (KM by default). Must be used with lat and long parameters to return locations within the specified radius of a given latitude and longitude.

radiusUnit

string

enum

Defaults to km

Sets the unit of measurement for the radius parameter. Can only be used together with radius.

Allowed values:

km — kilometers (default)
m — meters
mi — miles
yd — yards

Allowed:

lat

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.

long

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

boundary

boolean

Defaults to null

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

hasBoundary

boolean

Defaults to null

Only search through locations that have boundary polygons

minSize

float

Filters locations by minimum size (in square kilometers).

maxSize

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. Values are case-insensitive.

Allowed values:

village

subType

Allowed:

Responses

403

Forbidden

200Successful response

400Bad Request

401Unauthorized

500Internal Server Error