# RED Atlas API Documentation Everything you need to build with RED Atlas API English-only full documentation export for LLM ingestion. Docs home: /en/docs Index file: /llms.txt API base URL: https://apiv2.atlas.red/external-api/v1 # Common Filters URL: /en/docs?section=filtering These parameters apply across list endpoints. - page: Page number. Default: 1 - limit: Results per page. Default: 25, max: 100 - sort: Sort by field. Format: field:asc or field:desc. Default: id:desc - fields: Comma-separated list of fields to return. Omit for all fields. - filter exact: Exact match filter on any field - filter gte: Greater than or equal - filter lte: Less than or equal - filter gt: Greater than - filter lt: Less than - filter neq: Not equal - filter like: Case-insensitive substring match (ILIKE) - filter in: IN list. Values comma-separated. E.g. filter[status.in]=active,pending ## Getting Started # Introduction URL: /en/docs?section=introduction RED Atlas API provides programmatic access to the most comprehensive real estate dataset in Latin America and the Caribbean. Our REST API lets you query properties, listings, transactions, permits, and more across 2 active markets (Colombia and Puerto Rico), with consistent schemas and low latency. ## Base URL ## Key Features - feature entities: 10+ entity types (properties, listings, transactions, permits, and more) - feature filters: Consistent filter, sort, and pagination API across all entities - feature fields: Field selection — request only the fields you need - feature premium: Premium fields: AI-generated descriptions, AVM pricing, JSON enrichment - feature reports: White-label report generation with AVM valuation - feature rate limits: Rate limit info included in every response # Quick Start URL: /en/docs?section=quick-start Get up and running in under 2 minutes. ## 1. Get your API Key - step1 description before: Sign in to the dashboard and go to - step1 api keys label: API Keys - step1 description after: → Create Key. Copy the full key — it is shown only once. ## 2. Make your first request ## 3. Read the response # Authentication URL: /en/docs?section=authentication Every request to the Data API and Report API must include your API key as a Bearer token. ## Bearer Token ## Key prefix - key prefix description: Production key. Full access to your plan features and real data. ## Security notes - security note1: Never expose API keys in client-side code or public repositories. - security note2: Rotate keys periodically from the dashboard. Old key is immediately revoked. - security note3: Use separate keys per environment (production vs staging). - security note4 before: Restrict keys to specific markets using - security note4 after: when creating. # Rate Limits & Errors URL: /en/docs?section=rate-limits Limits are applied per API key, per minute. Every response includes rate limit headers. ## Rate Limits by Plan - plan free: 500 calls/month total - plan starter: 10,000 calls/month total - plan growth: 100,000 calls/month total - plan enterprise: Unlimited calls ## Rate Limit Headers - headers note before: These values are also returned in the - headers note after: field of every response body. ## Error Format - error format description: All errors return a consistent JSON shape: ## HTTP Status Codes - status 200: Request successful - status 201: Resource created (reports) - status 400: Invalid filter field, sort, or body parameter - status 401: Missing or invalid API key - status 403: Plan does not include this feature or market - status 404: Resource or entity not found - status 429: Too many requests. Check X-RateLimit-Reset header - status 500: Internal error. Retry with exponential backoff ## Data API # Data API Overview URL: /en/docs?section=overview The Data API gives you direct access to real estate records across all covered markets. Every endpoint follows the same pattern and accepts the same filter, sort, and pagination parameters. ## URL Pattern ## Filter Operators - filter operators description: All list endpoints support the same filter syntax. The field name can be any column name of that entity. ## Response Envelope # Markets & Coverage URL: /en/docs?section=markets Use the market code in the URL path to specify which country's data to query. - pri description: properties, listings, parcels, transactions, permits, tenants, documents, taxes, buildings - col description: properties, listings, parcels, transactions, tenants, documents, buildings - arg type: Argentina — coming soon - arg description: properties, listings, parcels, transactions, permits, tenants - esp type: Spain — coming soon - esp description: properties, listings, transactions - are type: UAE — coming soon - are description: properties, listings, transactions ## Check available entities # Properties URL: /en/docs?section=properties Core property records linked to government cadastral data. Each property has a unique government ID, area, address, and links to parcels, listings, and transactions. - available in: Available in: ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter govtId: Filter by government cadastral ID - filter totalArea gte: Minimum total area in m² - filter totalArea lte: Maximum total area in m² - filter yearBuilt gte: Minimum year built (COL) - filter sectorId: Filter by sector ID - filter subsectorId: Filter by subsector ID - filter uso: Land use classification e.g. RESIDENCIAL (COL) - filter unitType: Property unit type e.g. Particular, Unit - filter cityId: Filter by city - field id: Unique property identifier - field govtId: Official government cadastral ID - field address: Full formatted address string - field addressJSON: Parsed address components (mainStreet, secundaryStreet, unitNumber, unitType, joinedAddress) - field totalArea: Total property area in m² - field sourceId: Internal source data identifier - field sectorId: Sector (neighborhood) identifier - field subsectorId: Subsector identifier - field microsectorId: Microsector identifier - field unitType: Property unit type (e.g. Particular, Apartment, Commercial) - field geometry: Point coordinates of the property - field parcelId: Linked parcel record - field uso: Land use classification (e.g. RESIDENCIAL, COMERCIAL) - field matriculaInmobiliaria: Real estate registry folio number - field yearBuilt: Year of construction - field usoVivienda: Housing use subcategory - field destinoEconomico: Economic destination type - field uniqueListingsCount: Number of unique listings linked to this property - field uniqueTransactionsCount: Number of unique transactions linked to this property - field rooms: Number of rooms - field toilets: Number of bathrooms - field parkingSpaces: Number of parking spaces - field neighborhoodId: Neighborhood reference - field cityId: City reference - field taxesCount: Number of linked tax records - field listings: Nested listing records linked to this property - field parcel: Nested parcel record (with geometry, centroid, neighborhood) - field transactions: Nested transaction records - field taxes: Nested tax records # Parcels URL: /en/docs?section=parcels Land parcel records from cadastral registries. Parcels contain plot-level data including land area, geometry, government IDs, and zoning classifications. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter govtId: Cadastral parcel ID - filter landArea gte: Minimum land area in m² - filter landArea lte: Maximum land area in m² - filter totalArea gte: Minimum total constructed area in m² - filter cityId: Filter by city - filter stratum: Stratum 1–6 (COL) - filter sectorId: Filter by sector - filter neighborhoodId: Filter by neighborhood - filter buildingId: Filter parcels in a building (COL) - field id: Unique parcel identifier - field govtId: Government cadastral parcel ID - field name: Parcel name or reference - field description: Parcel description - field landArea: Land area in m² - field totalArea: Total constructed area in m² - field address: Street address - field photos: Photo URLs - field score: Atlas data quality score 0–100 - field stratum: Socioeconomic stratum 1–6 - field chip: Unique cadastral chip code - field cityId: City reference - field sectorId: Sector reference - field subsectorId: Subsector reference - field microsectorId: Microsector reference - field neighborhoodId: Neighborhood reference - field buildingId: Building reference (if part of a building) - field regionId: Region reference - field uniqueListingsCount: Count of unique listings on this parcel - field uniqueTransactionsCount: Count of unique transactions on this parcel - field permitsCount: Count of linked building permits - field tenantsCount: Count of linked tenant/business records - field propertiesCount: Count of properties on this parcel - field documentsCount: Count of linked documents - field createdAt: Record creation timestamp - field updatedAt: Last update timestamp - field geometry: Polygon boundary of the parcel - field centroid: Centroid point of the parcel - field listings: Nested listing records on this parcel - field properties: Nested property records on this parcel - field tenants: Nested tenant/business records - field documents: Nested document records - field sector: Nested sector info # Listings URL: /en/docs?section=listings Active and historical real estate listings scraped and normalized from portals. Includes price history, property type, rooms, areas, and publisher information. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter status: FOR_SALE | FOR_RENT | SOLD | RENTED | REMOVED_SALE | REMOVED_RENT - filter active: Filter currently active listings - filter price gte: Minimum price (local currency) - filter price lte: Maximum price - filter builtArea gte: Minimum built area in m² - filter builtArea lte: Maximum built area in m² - filter rooms: Exact number of bedrooms - filter rooms gte: Minimum bedrooms - filter toilets gte: Minimum bathrooms - filter propertyType: Property type e.g. APARTMENT, HOUSE, OFFICE (COL, PRI) - filter stratum: Stratum 1–6 (COL) - filter yearBuilt gte: Minimum year built - filter daysOnMarket lte: Max days on market - filter ageStatus: USED | NEW (COL) - filter dataset: Source portal dataset identifier - field genericListingId: Primary key for listings - field uniqueListingId: Deduplicated canonical listing ID - field listingCode: Source portal listing code - field name: Listing title from the source portal - field price: Listing price in local currency (COP for COL, USD for PRI) - field builtArea: Built area in m² - field exteriorBuiltArea: Exterior/balcony built area in m² - field lotArea: Lot area in m² - field pricePerBuiltSqm: Price per built m² - field pricePerLotSqm: Price per lot m² - field daysOnMarket: Days since first listed - field url: Source listing URL - field location: Listing location coordinates - field status: FOR_SALE | FOR_RENT | SOLD | RENTED | REMOVED_SALE | REMOVED_RENT - field active: Currently active on the source portal - field dataset: Source portal identifier (e.g. train, test) - field photos: First 5 photo URLs - field allPhotos: All photo URLs - field rooms: Number of bedrooms - field toilets: Number of bathrooms - field parkingSpaces: Number of parking spaces - field floor: Floor number of the unit - field stratum: Socioeconomic stratum 1–6 - field address: Formatted address - field addressJSON: Parsed address components - field descriptionText: Original listing description from portal - field publisherName: Publisher/agent name - field publisherType: Publisher category (owner, agency, developer) - field yearBuilt: Year of construction - field propertyType: Property type (APARTMENT, HOUSE, OFFICE, etc.) - field score: Atlas data quality score 0–100 - field ageStatus: USED | NEW - field ageGroup: Human-readable age bracket (e.g. Más de 20 años) - field ageMin: Minimum estimated age in years - field ageMax: Maximum estimated age in years - field ageNumeric: Estimated numeric age in years - field administrationFee: Monthly administration fee (COP) - field isDuplex: Whether the unit is a duplex - field isExterior: Whether the unit has exterior exposure - field hasServiceRoom: Whether the unit has a service room - field amenitiesCount: Number of listed amenities - field phones: Contact phone numbers from listing - field hasVisitorParking: Whether the building has visitor parking - field condition: Physical condition of the property - field dealOpportunity: Atlas deal opportunity classification - field estimatedSaleValue: AVM estimated sale value - field estimatedMonthlyRentValue: AVM estimated monthly rent value - field createdAt: Date when listing was first seen - field updatedAt: Last update timestamp - field deactivatedAt: Date listing was removed from portal - field extractedAt: Date when data was last extracted - field parcel: Nested parcel record (id, buildingId, permits, tenants) - field property: Nested property record linked to this listing # Transactions URL: /en/docs?section=transactions Recorded real estate transactions from public registries. Includes deed prices, buyer/seller names, property areas, and transaction dates. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter transactionType: Transaction type as recorded in the notarial registry (COL: e.g. Compraventa, Cancelación De Hipoteca…) - filter transactionPrice gte: Minimum transaction price - filter transactionPrice lte: Maximum transaction price - filter transactionDate gte: Earliest date (ISO 8601: 2024-01-01) - filter transactionDate lte: Latest date (ISO 8601) - filter builtArea gte: Minimum built area in m² - filter sectorId: Filter by sector - filter parcelId: All transactions for a parcel - filter NIR: Notarial instrument reference number (COL) - field id: Unique transaction identifier - field shortId: Short alphanumeric reference ID - field transactionPrice: Recorded deed price in local currency (may be null if not disclosed) - field builtArea: Built area in m² - field pricePerBuiltSqm: Price per built m² - field lotArea: Lot area in m² - field pricePerLotSqm: Price per lot m² - field transactionType: Transaction type as recorded in the notarial registry - field buyerName: Buyer name from public registry - field sellerName: Seller name from public registry - field address: Property address at time of transaction - field dataset: Source completeness tag (complete | incomplete) - field transactionDate: Date and time of transaction - field sourceId: Internal source identifier - field sectorId: Sector reference - field subsectorId: Subsector reference - field microsectorId: Microsector reference - field parcelId: Linked parcel - field genericListingId: Linked listing (if matched) - field masterTransactionId: Master transaction reference for grouped deeds - field NIR: Notarial instrument reference number - field createdAt: Record creation timestamp - field updatedAt: Last update timestamp # Permits URL: /en/docs?section=permits Building and land use permits from municipal registries. Track construction activity, demolitions, and land use changes at the parcel level. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter permitType: Permit classification (new_construction, demolition, renovation, land_use…) - filter date gte: Earliest permit date (ISO 8601) - filter date lte: Latest permit date (ISO 8601) - filter cityId: Filter by city - filter status: approved | pending | rejected | expired (COL) - filter parcelId: All permits for a parcel (COL) - field id: Unique permit identifier - field permitType: Permit classification - field date: Permit issue or registration date - field cityId: City reference - field parcelId: Linked parcel - field status: approved | pending | rejected | expired - field name: Permit name/title - field description: Permit description - field case: Official case/docket number # Documents URL: /en/docs?section=documents Legal and administrative documents linked to transactions, listings, parcels, or permits. Includes downloadable URLs for deeds, contracts, and certificates. - availability note before: ⚠ Available for - availability note and: and - availability note after: only. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter type: Document type (deed, contract, certificate, permit_doc…) - filter transactionId: All documents for a transaction - filter parcelId: All documents for a parcel - filter permitId: All documents for a permit - filter genericListingId: All documents for a listing - field id: Unique document identifier - field name: Document file name or title - field url: Download URL for the document (files.atlas.red) - field type: Document type classification (e.g. TRANSACTION, PERMIT) - field date: Document date (e.g. transaction date) - field unitNumber: Unit number associated with the document - field govtId: Government property ID associated with the document - field sourceId: Internal source identifier - field createdAt: Record creation timestamp - field updatedAt: Last update timestamp - field transactionId: Linked transaction (if type is TRANSACTION) - field genericListingId: Linked listing (if any) - field parcelId: Linked parcel (if any) - field permitId: Linked permit (if any) # Tenants URL: /en/docs?section=tenants Commercial tenants and businesses occupying properties. Includes contact information, location, photos, and links to parcels and properties. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter name like: Search tenant name (case-insensitive) - filter parcelId: All tenants in a parcel - filter propertyId: All tenants in a property - filter sectorId: Filter by sector - filter address like: Search by address substring - field id: Unique tenant/business identifier - field name: Business or tenant name - field url: Source URL (e.g. OpenStreetMap, business portal) - field phones: Contact phone numbers - field pictures: Photo URLs - field emails: Contact email addresses - field websites: Additional website URLs - field address: Street address - field descriptionText: Business description - field sectorId: Sector reference - field subsectorId: Subsector reference - field microsectorId: Microsector reference - field parcelId: Linked parcel - field propertyId: Linked property - field sourceId: Internal source identifier - field createdAt: Record creation timestamp - field updatedAt: Last update timestamp - field extractedAt: Date data was last extracted from source - field parcel: Nested parcel record # Taxes URL: /en/docs?section=taxes - entity name: Taxes - parcels entity name: Parcels - coming soon before: The - coming soon middle: endpoint is not yet available in the current API version. Property tax assessment data is partially available via the - coming soon after: entity (see - coming soon end: field). Full tax history is planned for a future release. ## Available now: Tax data via Parcels # Buildings URL: /en/docs?section=buildings Building records with address information and stratum classification. Buildings group multiple properties and units within the same physical structure. - availability note before: ⚠ Available for - availability note and: and - availability note after: only. ## Query Parameters ## Response Fields ## Example Request ## Example Response - filter type: Building type e.g. Condominium - filter cityId: Filter by city - filter name like: Search by building name substring - field id: Unique building identifier - field name: Building name (e.g. Edificio Uno 83) - field type: Building type classification (e.g. Condominium) - field geometry: Building location coordinates - field cityId: City reference # Filtering & Pagination URL: /en/docs?section=filtering All list endpoints share the same filter, sort, pagination, and field-selection system. ## Filter Operators ## Example: Combined Filters ## Pagination - pagination description before: Use - pagination description and: and - pagination description after: to paginate through results. Maximum limit is - pagination description end: per request. - meta total: Total matching records across all pages - meta page: Current page - meta limit: Records per page - meta totalPages: Total number of pages # Geospatial Queries URL: /en/docs?section=geospatial - description before: Entity records that include geometry fields (properties, parcels, listings, tenants) return GeoJSON geometries. The - description after before point: field contains either a - description or: or - description end: . ## Geometry Fields ## Example: Fetch geometry - field geometry: Point or Polygon — exact parcel/property footprint - field centroid: Centroid point of a polygon (parcels) - field location: Point geometry (listings, tenants) ## Report API # Report API Overview URL: /en/docs?section=report-overview The Report API generates on-demand valuation and comparables reports using RED Atlas's AVM models. Reports are stored server-side and can be retrieved by ID. ## Endpoints - endpoint avm: Generate an AVM valuation report - endpoint comparables: Generate market comparables (listings + transactions) - endpoint list: List all reports generated by your key - endpoint get: Get a single report by ID - endpoint white label get: Get your white-label branding config - endpoint white label put: Update white-label branding ## Report Status - status processing: Report is being generated (rarely seen — generation is synchronous) - status completed: Report generated successfully. Result is in the result field. - status failed: Generation failed. errorMessage contains the reason. # AVM Report URL: /en/docs?section=avm-report Generates an Automated Valuation Model (AVM) estimate for a property based on its location, type, and physical characteristics. Uses RED Atlas's proprietary ML models trained on millions of transactions and listings. ## Request Body ## Example Request ## Example Response - field market: Market code: col | pri | arg | mex | ecu | per | pan - field location lat: Latitude - field location lon: Longitude - field propertyType: apartment | house | office | commercial | land - field listingType: for_sale | for_rent - field builtArea: Built area in m² (optional) - field lotArea: Lot area in m² (optional) - field rooms: Number of bedrooms (optional) - field toilets: Number of bathrooms (optional) - field parkingSpaces: Parking spaces (optional) - field yearBuilt: Year of construction (optional) # Property Profile URL: /en/docs?section=property-profile Property Profile reports are planned for a future release. They will combine Data API property details with AVM valuation and market comparables into a single enriched report. # Market Comparables URL: /en/docs?section=market-comparables Finds the most similar nearby listings and transactions for a given property. Returns a ranked list of comparables with distance, price, and area data. ## Request Body ## Example Request ## Example Response - fetch ids note: Use the returned IDs to fetch full listing/transaction details via the Data API: - field market: Market code - field location lat: Latitude - field location lon: Longitude - field propertyType: apartment | house | office | commercial | land - field listingType: for_sale | for_rent - field builtArea: Built area in m² (optional) - field price: Current asking/reference price (optional) - field pricePerBuiltSqm: Price per m² (optional) - field rooms: Bedrooms (optional) - field toilets: Bathrooms (optional) - field returnSize: Number of comparables to return. Default 10, max 50. - field onlyActiveListings: Restrict listings comparables to active only. Default: true - field includeTransactions: Include transaction comparables. Default: true ## SDKs & Libraries # Python SDK URL: /en/docs?section=python-sdk The official RED Atlas Python SDK provides a simple way to work with the API from Python applications, notebooks, and backend services. ## Install - install description: The package is published on PyPI and can be installed from ## What It Includes - feature 1: A Python-friendly interface for authenticating and calling RED Atlas endpoints. - feature 2: A cleaner developer experience for scripts, notebooks, and data workflows. - feature 3: A single package to standardize how your team integrates with the RED Atlas API. # Documentation URL: /en/docs?section=metadata Complete API reference, guides, and SDKs for integrating the RED Atlas real estate data API. Get started in minutes. # Amenities URL: /en/docs?section=amenities - entity name: Amenities - coming soon before: The - coming soon after: endpoint is not yet available as a standalone entity. Amenity data (pools, gyms, parking, etc.) is embedded within listing and property records as attribute fields. A dedicated amenities endpoint is planned for a future release. ## Amenity fields on listings - field parkingSpaces: Number of parking spaces in the listing - field floor: Floor number of the unit - field floors: Total floors in the building - field rooms: Number of bedrooms - field toilets: Number of bathrooms # Bulk Exports URL: /en/docs?section=bulk-exports - plan note before: Bulk Exports are available on the - plan growth: Growth - plan note and: and - plan enterprise: Enterprise - plan note after: plans. Contact support to enable. - description before: For large dataset needs (1M+ records), use the paginated list endpoints with - description after: and iterate through pages. Each request counts as one API call regardless of the number of records returned. # White-Label Configuration URL: /en/docs?section=white-label Configure your company's branding to be applied to generated reports. ## Config Fields ## Update Config - field companyName: Your company name (shown in report header) - field logoUrl: URL to your logo image (PNG/SVG recommended) - field primaryColor: Hex color for headings and accents (e.g. #E63946) - field secondaryColor: Hex color for backgrounds (e.g. #1D3557) - field website: Your website URL - field contactEmail: Contact email shown in reports # PDF Generation URL: /en/docs?section=pdf-generation PDF generation is planned for a future release. Reports will support downloadable PDFs with your white-label branding applied.