API Reference
Compare Markets
Side-by-side market snapshots for up to 5 areas. Returns snapshot data grouped by area ID, with each area containing snapshots broken down by bedroom count.
Tier: Free+
GET
Compare market snapshots across areas
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated area IDs (1-5)
Filter by bedroom count (0=studio, 1-6)
Required range:
0 <= x <= 6Listing type
Available options:
rental, sale Previous
List AreasReturns the area hierarchy: 349 areas across NYC and Northern New Jersey,
of which 316 are NYC neighborhoods and sub-areas and 5 are boroughs.
Optionally filter by level or parent area.
This route is paginated: `perPage` defaults to 10 (and is capped at 10 on
the Free tier), so a single unfiltered call returns 10 of 349 rows. Read
`meta.total` and page through, or raise `perPage` on a paid tier.
**Tier:** Free+
Next
Compare market snapshots across areas