RED Atlas API

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_market_report

Contacts Atlas ALREADY HOLDS for a parcel, harvested from listings, permits and other internal sources — no external vendor is called and nothing new is looked up. Each row carries its provenance (source, typePerson, permitId, genericListingId): a broker, a contractor or a permit applicant is an ASSOCIATION with the parcel, NOT the owner and NOT a party to any sale — never present one as buyer, seller or owner. For who OWNS it (Puerto Rico) query the `owners` entity; for a fresh skip-trace of the owner/occupant use atlas_enrich_contacts; for who bought or sold, read the deed parties in transactions.scripturesJson. Premium: charges credits per call (meta.creditCost); an empty result costs nothing.

atlas_get_parcel_contacts

The published plan ladder plus the credit price of every billable thing. FREE. Plans are the RED Atlas platform tiers with their monthly price, included tokens (1 token = 1 report or document) and included seats. Credit costs are per record by entity, per aggregation, per add-on field, per contacts call, per enrichment and per report — that half is what a data call actually spends. Use it to price a piece of work before running it, to explain a bill, and to compare plans. This is the CATALOG, not the caller: for what THIS account is on and how much of it is left, read atlas_my_plan — an account's API call allowance comes from its API package and is reported there, not here.

atlas_pricing

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_query_data

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_top_by

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.

atlas_read_docs

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_lookup_location

The CALLING account's own plan and BOTH of its monthly ceilings, because both gate every data call: `calls` (1 per request, from the account's API package) and `credits` (per record/aggregation, from the organization pool or the account's own allowance). Also the credits burned per calendar month over the last 6. FREE — costs nothing. Use it for "how much have I got left", "what am I paying for", "is this on my plan", and — with atlas_pricing — for "should I move plan", where the monthly burn is the number to size against, not the current period, which is a partial month. QUOTE THE CEILING THAT BINDS: an account can be far from its call limit and out of credits, or the reverse, so name which one is close before advising anything. `unlimited: true` on either means there is no allowance to spend down — `remaining` is then null because there is no ceiling, NOT because the balance is zero. It cannot change the plan or buy credits — follow `manageBillingUrl` for that.

atlas_my_plan