Search locations (POST)

post

https://api.repliers.io/locations

Identical to GET /locations and accepts the same query parameters. Use this method when the map boundary is too large to fit in the query string, and send the map data in the request body instead of the map query parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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

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

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

locations

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.

aggregates

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.

Comma-separate multiple fields. Only the following fields may be aggregated; any other value is rejected with a 400 error:

type, subType, classification, source, address.state, address.area, address.city, address.neighborhood, school.districtName, school.schoolType, school.lowGrade, school.highGrade, school.schoolLevel, school.isCharterSchool, school.isMagnetSchool, school.isVirtualSchool, school.isPrivate, school.isJJFacility, school.privateSchoolAffiliation, school.giftedAndTalented, school.dualEnrollment, school.creditRecovery, school.singleSexClasses, school.apCourse, school.internationalBaccalaureate, school.corporalPunishment, school.interscholarAthletics, school.offersKindergarten, school.offersFullDayKindergarten, school.apEnrollment, school.expenditurePerStudent, school.isTitleISchool, school.isTitleISchoolwideSchool, school.privateHours, school.privateDays, school.privateHasLibrary, school.privateCoed, school.isAssigned

resultsPerPage

integer

≥ 1

Defaults to 100

The number of locations to return per page. Values above 300 (or above the limit configured for your account) are not rejected; they are capped to that limit.

pageNum

integer

≥ 1

Defaults to 1

The page number to return. For example, with 100 results per page, specifying pageNum=2 returns results 101–200. Paging is limited to the first 100,000 results, so pageNum multiplied by resultsPerPage must not exceed 100,000. A pageNum more than one page past the last page of results is rejected with a 400 error.

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

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.

pointWithinBoundary

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.

sortBy

string

enum

Sort results by type

Allowed:

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:

name

array of strings

Filters locations by exact name. Repeat the parameter to supply multiple names.

name

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

Body Params

Optional request body for complex geographical filtering using GeoJSON polygons. Use this for large polygon data that exceeds query parameter size limits.

map

object

GeoJSON polygon for geographical filtering. Limits results to buildings within the specified boundaries.
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).

Responses

403

Forbidden

200Successful response

400Bad Request

401Unauthorized

500Internal Server Error