API Reference

Search locations

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

Search locations based on the provided filter criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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
state
array of strings

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

state
area
array of strings

Filters locations by area names. Returns locations within the specified area. Areas represent larger geographical divisions that may contain multiple cities and neighborhoods. Examples of Areas are counties, regions etc.

area
city
array of strings

Filters locations by city names. Returns locations within the specified city. Cities can include multiple neighborhoods within their boundaries.

city
neighborhood
array of strings

Filter results by neighborhood names. Returns specified neighborhoods. Neighborhoods represent the smallest geographical division in the hierarchy.

neighborhood
locationId
array of strings

Filters by location IDs. Location IDs can be obtained from response of Locations Autocomplete endpoint

locationId
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
boolean

If false, the locations object will be empty. Useful for speeding up responses when aggregates are requested and locations are not needed. Default is true.

string

Aggregates values and counts for specified fields. Aggregates have many use cases, they're particularly useful for grouping and displaying acceptable values for fields that are used in filters. For more information refer to Using Aggregates To Determine Acceptable Values For Filters.

integer
1 to 300
Defaults to 100

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

integer
≥ 1
Defaults to 1

If specified indexes a specific page in the results set. For example, if there are 1000 locations and 100 locations per page, if you'd like to view locations 101-200 you'd specify pageNum=2

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

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.

boolean
Defaults to false

When set to true, returns only locations whose boundaries contain the point specified by lat and long parameters. Must be used together with lat and long.

string
enum

Sort results by type

Allowed:
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
string
length ≤ 100

Filters locations by exact name (case-insensitive).

schoolType
array of strings

Filters locations by school type. Applies to locations with type=school.

schoolType
schoolLevel
array of strings

Filters locations by school level. Applies to locations with type=school.

schoolLevel
privateSchoolAffiliation
array of strings

Filters locations by private school affiliation. Applies to locations with type=school.

privateSchoolAffiliation
schoolDistrictName
array of strings

Filters locations by school district name. Applies to locations with type=school.

schoolDistrictName
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