red-atlas-api
Puerto Rico & Colombia real estate: listings, sales, parcels, permits, analytics, AVM reports.
Community: Submitted by a user or imported; check the owner before granting accessOnlineNo sign-inGlobalFreeRead-only
What it can do
- Atlas List Entities: Lists the entity types (properties, listings, parcels, …) available in a market and their endpoints. Free. Start here when unsure what data a market has.
- Atlas Query Data: Lists records of an entity type in a market with pagination, filters, sorting and field projection. Costs credits per record returned — keep `limit` small and use `fields` to request
- Atlas Get Record: Fetches one record by id for an entity type in a market. Costs credits for the fields returned; use `fields` to limit them. Includes the canonical `atlasUrl` app link for listings/pa
What data it sees
Do you need an account
No: the server works without sign-in
Puerto Rico & Colombia real estate: listings, sales, parcels, permits, analytics, AVM reports.
Server tool list (16)
Raw names from tools/list. Only developers need these.
| atlas_list_entities | Lists the entity types (properties, listings, parcels, …) available in a market and their endpoints. Free. Start here when unsure what data a market has. |
| atlas_query_data | Lists records of an entity type in a market with pagination, filters, sorting and field projection. Costs credits per record returned — keep `limit` small and use `fields` to request only what you need. Each record includes a server-built `atlasUrl` (canonical app link) for listings/parcels/properties — link to that, never to a record's source `url`. Response envelope: { data, meta (creditCost), rateLimit (limit/remaining/reset) }. |
| atlas_get_record | Fetches one record by id for an entity type in a market. Costs credits for the fields returned; use `fields` to limit them. Includes the canonical `atlasUrl` app link for listings/parcels/properties. |
| atlas_get_stats | Aggregated statistics for a (market, entity) pair — counts, price/area aggregates, percentiles, distributions and derived metrics (e.g. `derived.pricePerBuiltAreaMedian`). Optionally add an ad-hoc `groupBy` breakdown, custom `percentiles`, or an outlier-robust `trimmed` mean. On listings and transactions the response also carries `excludingOutliers` — the same price aggregates computed without the documents ingest flagged as `isOutlier` (scraped placeholder prices such as a $99,900,000 "call for price" listing). QUOTE `excludingOutliers` FOR ANY MONEY TOTAL OR AVERAGE; the top-level `priceStats` is the unfiltered figure and can be inflated by a handful of placeholders. Charges a fixed credit cost (reported in meta.creditCost). Supports the same filters as atlas_query_data. |
| atlas_get_parcel_contacts | Returns enriched contact information for a parcel. Premium feature: requires a plan with contact enrichment and charges extra credits per call (meta.creditCost). Only call when the user explicitly needs owner/contact data. |
| atlas_search | Free-text search across entity types in a market (addresses, names, places). Charges credits per call. Returns grouped hits per entity bucket; follow up with atlas_get_record for full details. On a lower plan, find records with atlas_query_data + an `address.like` filter instead. |
| atlas_top_by | Terms aggregation: the top values of `groupBy` (e.g. propertyType, status, cityId) with their record counts and an optional sub-metric. One call replaces paging + manual counting. Charges a fixed credit cost (meta.creditCost). |
| atlas_velocity | How fast a market is moving: the count of new records in the current period vs the previous equal-length period, with the absolute and percent change. E.g. new listings or permits this month vs last month. Charges a fixed credit cost (meta.creditCost). Entities without a usable date field return an error — pass `dateField` to override the default. |
| atlas_market_report | Profiles a market in a single call: the aggregated stats block (counts, price/area aggregates, percentiles and derived metrics like median price per m²), a count-per-month trend for the last year, and — when `groupBy` is set — a ranked breakdown by that dimension. Use this instead of chaining atlas_get_stats + atlas_top_by when you want an overview. Billed as one aggregator call (meta.creditCost), the trend/breakdown add no extra cost. |
| atlas_pivot | Cross-tabulates two fields (x by y) with per-cell counts and an optional metric — heatmap/matrix data (e.g. propertyType by city). EITHER AXIS MAY BE A DATE FIELD (createdAt, transactionDate, date): it is then bucketed as a calendar period via `interval`, which is how you get a per-group TIME SERIES — e.g. xField=propertyType + yField=transactionDate + interval=quarter returns quarterly counts per property type in ONE call instead of one query per period. Charges a fixed credit cost (meta.creditCost). |
| atlas_lookup_location | Translates human location names into the stable ids (regionId, cityId, neighborhoodId, …) that atlas_query_data filters expect, and returns boundary polygons. Free (0 credits). kind-specific parameters: cities accepts regionId; neighborhoods accepts cityId; sub-neighborhoods requires neighborhoodIds; zip-codes requires zipCode; buildings requires name and accepts cityId/neighborhoodId. Set includeGeometry to get GeoJSON boundary polygons for markets, regions, cities, neighborhoods, sub-neighborhoods and zip-codes — polygons are large, so keep `size` small and raise `simplify` (degrees; higher = coarser) if the result is truncated. sectors/sub-sectors/micro-sectors are a shared property-USE classification (e.g. "Office"), NOT geographic areas — name lookups with no polygon; sub-sectors accepts sectorId and micro-sectors accepts subsectorId to scope to a parent. |
| atlas_create_avm_report | Starts an automated valuation (AVM) for a property. Charges credits (10 for JSON, 15 credits. Returns a report id with status "pending"/"processing" — poll atlas_get_report until it completes (usually under a minute). |
| atlas_create_comparables_report | Starts a market-comparables report around a subject property. Charges 6 higher; charges credits. Async like AVM — poll atlas_get_report for the result. |
| atlas_list_reports | Lists the account’s generated reports (all plans). Free. |
| atlas_get_report | Fetches one report, including its result once status is "completed" and a shareable publicUrl. Free. Use to poll after creating a report. |
| atlas_read_docs | Reads the official RED Atlas API docs. Without a topic it returns the section index; with a topic (e.g. "filtering", "credits", "rate limits", "avm") it returns the matching sections. Free. Prefer this over guessing parameters. |