RED Atlas API

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_pivot

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_stats

THE tool for "what did comparable properties actually sell for". Returns RECORDED SALES (registry transactions — real closed prices, not asking prices) near a coordinate, each with its distance from the subject and price per m², plus the median sale price and median price per m² already computed. Optionally returns comparable active listings alongside them, clearly separated — those are ASKS and are not sale evidence. Use this for any valuation, offer-price, underwriting or "is this priced fairly" question. A near/bbox query on transactions is refused (that index has no coordinates), so this is the ONLY way to reach sales by location — never conclude comparable sales are unavailable in Atlas without calling it. PASS THE SUBJECT'S builtArea, lotArea, rooms and toilets whenever you know them: the matching is a similarity search, and comps chosen without them are merely nearby rather than comparable. Runs the comparables report and waits for it (usually seconds); if generation is still running when the wait budget ends you get status "processing" and a reportId to poll with atlas_get_report. Charges the report cost once, reported in meta.creditCost.

atlas_comparable_sales

Starts a market-comparables report around a subject property: similar LISTINGS and — unless you turn it off — the RECORDED SALES near it, each with its distance from the subject. This is the Atlas source for "what did comparable properties actually sell for"; recorded sales are registry transactions, not asking prices. Async like AVM — poll atlas_get_report for the result, or call atlas_comparable_sales to do the create and the polling in one step. Charges credits per report (see meta.creditCost).

atlas_create_comparables_report

Starts an automated valuation (AVM) for a property — the Atlas-native answer to "what is this property worth", computed from Atlas listings and recorded transactions. USE THIS instead of quoting a valuation from any outside source. Returns a report id with status "processing" — poll atlas_get_report until it completes (usually under a minute). Charges credits per report; the exact cost is reported in meta.creditCost. Pass `listingType: "rent"` to value the property AS A RENTAL — that is how you get an Atlas rent estimate rather than guessing one.

atlas_create_avm_report

Fetches one report, including its result once status is "completed" and a shareable publicUrl. Free. Use to poll after creating a report.

atlas_get_report

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_record

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_list_entities

Lists the account’s generated reports (all plans). Free.

atlas_list_reports

Full market profile for ONE location (city, neighborhood or sub-neighborhood): sale and lease medians with monthly series, inventory, days on market, yield, demographics, quality-of-life scores, nearby POIs and local news — in a single call. Resolve the locationId with atlas_lookup_location first. EVERY metric is an envelope: { value, unit, yoy, vsParent, series, availability, caveats }. Read `availability` before quoting a number — "unavailable" means we genuinely cannot compute it (listed with the reason in meta.notAvailable), and "partial" means the value is real but the caveats change how it should be read (e.g. deed_lag_truncated_12mo, mixed_census_vintages, current_value_only). Never present a metric without its caveats, and never fill an unavailable metric from another source.

atlas_market_profile