API Data Dictionary

Comprehensive reference guide for Red Bricks API data models, field definitions, and response formats. Complete documentation of all data types and enumeration values.

Red Bricks API Data Dictionary

This comprehensive reference guide defines every data field, type, and value returned by the Red Bricks API. Whether you're integrating with our endpoints or building applications that consume our data, this dictionary serves as your complete source of truth.

Key Features:

• Complete field definitions with data types and descriptions
• Enumeration values with detailed explanations
• Real-world examples to guide implementation
• Consistent JSON formatting across all endpoints

Note: While specific endpoints may return subsets of this data, the definitions below represent the canonical structure for every field in our system.

---

1. Project Core Information

Essential identifiers and metadata for every project in the Red Bricks database.

Field	Type	Description	Example
id	integer	Unique identifier for the project	12345
name	string	Official marketing name of the project	Freed Hotel & Residences
slug	string	URL-friendly version of the project name for web URLs	freed-hotel-residences
description	string	SEO-optimized description of the project
highlights	array or null	Key selling points and project features
special_incentives	array of objects	Current limited-time offers and promotional deals
media	array of strings	Collection of image URLs for project photos and renderings
amenities	array or null	Building amenities and facilities	["pool", "gym", "concierge"]
building_type	string (enum)	Primary building classification. See Building Types	condo
current_sales_status	string (enum)	Current sales phase. See Sales Lifecycle	developer_selling
construction_status	string (enum)	Construction progress. See Construction Progress	under_construction
created_at	datetime	Timestamp when project was added to database
updated_at	datetime	Timestamp of most recent project update

---

2. Location & Geographic Data

Comprehensive location information including coordinates, transit scores, and regional classifications.

Field	Type	Description	Example
address	string	Complete municipal address	240 Adelaide Street West
city_id	integer	Unique identifier for the city	1
city_name	string	Name of the city where project is located	toronto
district_id	integer	Unique identifier for the district	15
district_name	string	Regional district or administrative area	peel-region
location	object	GeoJSON Point object with latitude and longitude	{"type": "Point", "coordinates": [-79.388, 43.648]}
walk_score	integer	WalkScore rating (0-100, higher is more walkable)	99
transit_score	integer	TransitScore rating (0-100, higher is better transit)	100
google_map_link	string (url)	Direct link to Google Maps location pin	https://www.google.ca/maps/...

---

3. Pricing & Financial Information

Current and historical pricing data, deposits, fees, and financial breakdown by unit type.

Field	Type	Description	Example
current_price_from	integer	Lowest price of currently available inventory	599900
current_price_to	integer	Highest price of currently available inventory	13249900
price_per_sqft	integer	Average price per square foot for available units	2306
launch_psf_avg	integer	Average price per square foot at project launch	2097
launch_price	object	Original pricing structure at project launch
↳ min	integer	Lowest starting price at project launch	549900
↳ max	integer	Highest price at project launch	12999900
deposit	string	Simplified deposit percentage or amount summary	15%
deposit_with_time	string	Deposit structure with timeline details	15% (over 1200 days) + 5% on Occupancy
deposit_full	string	Complete detailed deposit structure description	5% on signing, 5% in 30 days...
deposit_data	array	Structured deposit breakdown
↳ label	string	Description of this deposit payment
↳ price	string	Deposit amount or percentage	5
↳ deposit_type	enum	How the amount is calculated. See Deposit Types	percent
↳ deposit_time	string	When this payment is due	30
↳ deposit_due_on	enum	Payment trigger event. See Deposit Timelines	days
↳ deposit_amount	integer	Fixed amount (when applicable)	25000
bedrooms_info	object	Pricing and size data by bedroom count (studio, 1-bed, 2-bed, etc.)
↳ psf	integer	Average price per square foot for this bedroom type	2150
↳ count	integer	Number of unique floor plans for this bedroom type	8
↳ sizes.from	integer	Smallest unit size for this bedroom type (sq ft)	450
↳ sizes.to	integer	Largest unit size for this bedroom type (sq ft)	650
↳ sizes.average	integer	Average unit size for this bedroom type (sq ft)	550
↳ price.from	integer	Lowest price for this bedroom type	649900
↳ price.to	integer	Highest price for this bedroom type	899900
↳ price.average	integer	Average price for this bedroom type	774900
↳ percentage	float	Percentage of total inventory this bedroom type represents	32.5
maintenance_fees	string	Monthly maintenance fee amount or range	$0.82/sq ft
maintenance_fees_details	string	What's included/excluded in maintenance fees	Excludes Hydro
parking_price	string	Cost to purchase parking spot	$65,000
parking_details	string	Parking purchase limitations and notes	Available for 2 beds or larger
locker_price	string	Cost to purchase storage locker	$8,000
locker_details	string	Locker purchase limitations and notes	One per unit maximum
floorplan_premiums	string	Cost increase per floor or premium charges	$2,000 per floor above 10th
development_charges	string	Maximum development charge amount	Capped at $15,000

---

4. Building Specifications & Metrics

Physical characteristics, unit counts, and building dimensions.

Field	Type	Description	Example
storeys	integer	Total number of floors in the building	45
suites	integer	Total number of residential units	387
size	object	Unit size range across all floor plans
↳ min	integer	Smallest unit size in building (sq ft)	425
↳ max	integer	Largest unit size in building (sq ft)	1850
building_height_m	float	Total building height in meters	156.2

---

5. Project Timeline

Key dates in the project lifecycle from launch to occupancy.

Field	Type	Description	Example
launch_date	date	Official project sales launch date
occupancy_date	date	Estimated move-in date for purchasers

---

6. Development Team

Information about the companies and professionals behind the project.

Field	Type	Description	Example
developer	object	Primary development company (may be one of several in joint ventures)
↳ developer_name	string	Public trading name of the development company	Freed Developments
↳ developer_id	integer	Unique database identifier for the developer	42
↳ slug	string	URL-friendly identifier for developer profile page	freed-developments
↳ website	string	Developer's corporate website URL	https://freeddev.com
↳ logo	string	URL to developer's brand logo image	https://cdn.../logo.png
↳ created_at	datetime	When this developer was added to database
↳ updated_at	datetime	Most recent update to developer information
architect	object	Architectural firm responsible for building design
↳ architect_name	string	Name of the architecture firm	architectsAlliance
↳ architect_id	integer	Unique database identifier for the architect	18
interior_designer	object	Firm responsible for interior design and finishes
↳ interior_designer_name	string	Name of interior design company	Cecconi Simone
↳ interior_designer_id	integer	Unique database identifier for interior designer	25
sales_marketing_companies	object	Brokerage or agency managing project sales
↳ sales_marketing_companies_name	string	Name of sales and marketing agency	Baker Real Estate
↳ sales_marketing_companies_id	integer	Unique database identifier for sales company	7

---

7. Planning & Zoning Data

Information from municipal planning applications and city approvals.

Field	Type	Description	Example
units_condo	integer	Total number of condominium suites	350
units_hotel	integer	Total number of hotel suites	120
units_rental	integer	Total number of purpose-built rental units	75
units_market_rate_rental	integer	Number of market-rate rental units	60
units_rental_replacement	integer	Number of rental replacement units	15
units_affordable_rental	integer	Number of affordable/subsidized rental units	10
underground_levels	integer	Number of basement levels for parking	3
total_parking	integer	Total parking spaces in building	420
residential_parking	integer	Parking spaces designated for residents	350
residential_parking_ratio	float	Ratio of residential parking to total residential units	0.85
visitor_parking	integer	Parking spaces for visitors	25
industrial_parking	integer	Parking for industrial use	0
office_parking	integer	Parking for office tenants	20
retail_parking	integer	Parking for retail customers	25
bike_parking	integer	Total bicycle parking spaces	180
gfa	object	Gross Floor Area data from city planning applications
↳ totalgfam	integer	Total building GFA in square meters	45000
↳ residentialgfam	integer	Residential GFA in square meters	35000
↳ retailgfam	integer	Retail/commercial GFA in square meters	2500
↳ commercialgfam	integer	Office/commercial GFA in square meters	5000
↳ industrialgfam	integer	Industrial GFA in square meters	0

---

8. Floor Plan Details

Comprehensive data for individual unit layouts and specifications.

Field	Type	Description	Example
id	integer	Unique floor plan identifier	789
project_id	integer	ID of parent project	123
project_name	string	Name of parent project	Freed Hotel & Residences
name	string	Marketing name for this floor plan	Studio Suite A
bedrooms	float	Number of bedrooms (0.5 indicates den)	1.5
bathrooms	float	Number of bathrooms (0.5 indicates powder room)	1.5
size	integer	Unit size in square feet	650
images	object	Floor plan images in multiple resolutions
↳ full	string	High-resolution image for zoom/download
↳ medium	string	Standard resolution for web display
↳ thumbnail	string	Low-resolution for lists/previews
↳ alt	string	Accessible description text for the image	1.5 bedroom corner suite floor plan
exposure	string	Direction(s) the unit faces	South-West
floor_range	object	Floor and unit number information
↳ range	string	Floor numbers where this plan is available	6-35
↳ unit	string	Unit number pattern on specified floors	06, 16, 26
availability	string	Current availability status	Available
current_price	integer	Current price (typically lowest floor available)	849900
current_psf	integer	Current price per square foot	1307
launch_price	integer	Original price at project launch	799900
search_synonym	array	Additional search terms for unit discovery	["den", "junior one bedroom"]
price_history	array	Historical pricing data points
↳ date	date	Date of price point	2024-06-15
↳ price	integer	Price at specified date	829900
↳ psf	integer	Price per square foot at specified date	1276
low_rise	object	Additional data for low-rise/ground-related homes
↳ status	boolean	Whether this is a low-rise type unit	true
↳ lot_size	integer	Lot frontage in feet	32
↳ number_of_storeys	string	Number of floors in the home	2 storey
↳ low_rise_type	enum	Type of ground-related home	townhouse
↳ garage	string	Garage size and type	double
↳ basement	enum	Basement finish level	finished
↳ ownership_type	enum	Legal ownership structure	freehold
↳ townhouse_type	enum	Detailed townhouse classification. See Townhouse Types	traditional_town
↳ townhouse_location	enum	Position within townhouse block	end

---

9. Project Documents

Access to official project documentation and marketing materials.

Field	Type	Description	Example
google_drive_portal	string	URL to current project documents on Google Drive	https://drive.google.com/...
google_drive_archive_portal	string	URL to historical/archived project documents	https://drive.google.com/archive/...
latest_documents	object	Object containing details for the latest builder documents
↳ id	integer	Unique file identifier	456
↳ project_id	integer	Parent project ID	123
↳ name	string	Original filename	Brochure - 252 Church Condos - Pro.pdf
↳ document_type	string	MIME type of the document	application/pdf
↳ type	enum	Document version status	latest
↳ file_url	string	Direct link to file on Google Drive	https://drive.google.com/file/...
↳ created_at	datetime	When file was first added	2024-03-15T09:30:00Z
↳ updated_at	datetime	When file was last modified	2024-11-28T14:22:00Z
historical_documents	object	Object containing details for the historical builder documents
↳ id	integer	Unique file identifier	456
↳ project_id	integer	Parent project ID	123
↳ name	string	Original filename	Brochure - 252 Church Condos - Pro.pdf
↳ document_type	string	MIME type of the document	application/pdf
↳ type	enum	Document version status	historical
↳ file_url	string	Direct link to file on Google Drive	https://drive.google.com/file/...
↳ created_at	datetime	When file was first added	2024-03-15T09:30:00Z
↳ updated_at	datetime	When file was last modified	2024-11-28T14:22:00Z

---

Status Definitions & Enumerations

Sales Lifecycle

Red Bricks tracks projects through their complete sales lifecycle. Projects may have multiple simultaneous statuses (e.g., both resale and developer_selling).

Status	Definition
planning_phase	Initial planning stage with limited details. Information updated as it becomes available.
launching_soon	Pre-launch phase with confirmed launch date. More comprehensive details and media typically available.
platinum_access	Exclusive early access period before public launch. VIP sales phase with limited availability.
developer_selling	Active sales period with developer inventory available for purchase.
developer_sold_out	All developer inventory sold. No new units available from builder.
resale	Project completed and units trading on secondary market through real estate agents.
rentals	Purpose-built rental building with units available for lease.
on_hold	Sales temporarily suspended pending further announcements or approvals.
cancelled	Project permanently cancelled and removed from market.

Construction Progress

Status	Definition
pre_construction	Planning and pre-development phase before ground breaking.
under_construction	Active construction phase from ground breaking through to substantial completion.
complete	Construction finished and building registered for occupancy.
cancelled	Project cancelled with construction halted permanently.

Building Types

Type	Definition
condo	Condominium ownership with shared amenities and maintenance fees.
townhouse	Multi-level ground-related homes, often in rows or clusters.
single_family_home	Detached houses on individual lots.
rentals	Purpose-built rental apartments or houses.

Deposit Structure Types

Defines how deposit amounts are calculated in the payment schedule.

Type	Definition
balance_to	Payment to reach a cumulative deposit percentage (e.g., "Balance to bring total deposit to 10%").
amount	Fixed dollar amount regardless of purchase price (e.g., $25,000).
percent	Percentage of the total purchase price (e.g., 5%).

Deposit Structure Timelines

Defines when deposit payments are due based on project milestones or calendar dates.

Timeline	Definition
days	Number of days after agreement signing (e.g., "30 days after signing").
date	Specific calendar date for payment.
occupancy	Due on interim occupancy date when buyer takes possession.
days_before_occupancy	Due a specified number of days before the occupancy date.
closing	Due on final closing when legal title transfers to buyer.
days_before_closing	Due a specified number of days before the final closing date.

Townhouse Types

Detailed classifications for ground-related housing types.

Type	Definition
traditional_town	Standard multi-story row houses with front-facing entrances, typically featuring private backyards and front driveways.
freehold_town	Townhouses where owners hold title to both unit and land, with no monthly maintenance fees.
rear_lane_town	Homes with garage access via back laneway, front entrances face street or park areas.
back_to_back_towns	Units sharing rear walls with adjacent buildings, featuring only front exposure and balconies or rooftop terraces instead of backyards.
laneway_towns	Urban townhomes primarily accessed via service laneways rather than main streets.
stacked_towns	Multi-level structures with one townhome built above another, typically featuring "upper" units with rooftop access and "lower" units with ground-level patios.
bungalow_towns	Single-story attached homes, often with basements, designed for convenient single-level living.
other	Townhouse styles that don't fit standard classifications above.

---

This data dictionary is updated regularly to reflect API changes and new features. For the most current field definitions and endpoint documentation, refer to your specific API endpoint references.