Offices
Search real-estate offices with filters
NOT NMLS mortgage branches — use /branches for those. Returns office name, address, agent count, coordinates, and office-level production for the selected period. Default sort is by agent count descending. If you only need how many offices match and not the records themselves, send the same request body to countOffices.
x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/offices" \ -H "Content-Type: application/json" \ -d '{}'{
"cursor": "string",
"data": [
{
"activeListings": 0,
"agentCount": 0,
"avgListPrice": 0,
"avgSalePrice": 0,
"buyerUnits": 0,
"buyerVolume": 0,
"city": "string",
"company": "string",
"coordinates": {
"lat": 0,
"lon": 0
},
"country": "string",
"dualUnits": 0,
"dualVolume": 0,
"id": "string",
"lastCountedAt": "string",
"locationType": "string",
"sellerUnits": 0,
"sellerVolume": 0,
"state": "string",
"street": "string",
"teamSize": 0,
"units": 0,
"volume": 0,
"zip": "string"
}
],
"total": 0
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"limit": 0,
"size": 0
}