Research Documentation
Comprehensive technical documentation providing detailed specifications for data structures, analytical procedures, and research protocols used across our international real estate and urban development research platform.
Documentation Categories
Our documentation is organized into key areas covering all aspects of the research platform.
Data Specifications
Detailed documentation of all data fields, measurement units, temporal coverage, geographic scope, and update frequencies. Includes data dictionary defining each variable, acceptable value ranges, and handling of missing or anomalous data.
API Reference
Complete technical reference for programmatic access to research data and analytical tools. Covers authentication, request formatting, response structures, rate limits, error handling, and code examples in multiple programming languages.
Research Guides
Step-by-step instructions for conducting specific types of analysis using platform tools and data. Includes worked examples, interpretation guidance, common pitfalls to avoid, and recommendations for presenting findings.
Quality Standards
Documentation of quality control procedures, data verification protocols, accuracy metrics, and revision policies. Explains how we maintain data integrity and what users can expect regarding reliability and completeness.
Data Structure Documentation
Understanding how data is organized and what each element represents.
Market Indicators
Market indicator datasets include price indices, transaction volumes, inventory levels, absorption rates, and yield metrics. Each indicator is documented with precise definitions explaining what is measured and how. Price indices specify the methodology used for construction, whether repeat-sales, hedonic, or median-based. Transaction volume data distinguishes between different property types and transaction categories. Temporal frequency is specified along with any seasonal adjustment procedures. Geographic granularity varies by market and indicator, ranging from national to neighborhood level. All monetary values are documented with their reference currency and base period for inflation adjustment.
Property Characteristics
Property-level data captures physical attributes, location characteristics, and transaction details. Physical attributes include size measurements with units clearly specified, age or construction date, quality ratings, and amenity presence. Location data provides geographic coordinates, administrative boundaries, and distance measures to key features. Transaction information includes sale price, date, buyer and seller characteristics where available, and financing terms. Property type classifications follow standardized taxonomies to enable cross-market comparison. Missing data is coded consistently and documentation explains patterns of missingness across markets and time periods.
Demographic and Economic Variables
Contextual variables from official statistical sources are integrated with property market data. Population figures specify whether they represent total, working-age, or household counts. Age distribution data follows standard cohort definitions. Income and wealth measures clarify whether they represent median, mean, or distribution percentiles, and whether they are pre-tax or post-tax. Employment statistics distinguish between jobs located in an area versus residents employed. All demographic and economic data include metadata specifying the source agency, collection methodology, and any known limitations or discontinuities in the time series.
Planning and Regulatory Data
Information about land use regulations, zoning designations, development approvals, and infrastructure plans is systematically coded and documented. Zoning categories are mapped to standardized classifications while preserving local terminology. Development pipeline data tracks projects from initial proposal through completion, with status updates and timeline revisions documented. Infrastructure investment schedules specify project types, locations, budgets, and implementation phases. Regulatory changes are logged with effective dates and descriptions of their provisions. This documentation enables analysis of how planning policies and infrastructure decisions affect property markets over time.
Analytical Tools Documentation
Guidance for using platform analytical capabilities effectively.
Visualization Tools
Documentation covers chart types, customization options, data filtering, and export formats. Explains how to create time series plots, geographic maps, scatter plots, and distribution charts. Includes guidance on choosing appropriate visualizations for different data types and analytical questions.
Statistical Functions
Reference documentation for built-in statistical analysis functions. Covers descriptive statistics, correlation analysis, regression modeling, and time series decomposition. Each function is documented with parameter specifications, mathematical formulation, and interpretation guidance.
Data Filtering and Aggregation
Instructions for selecting subsets of data based on various criteria, aggregating across time periods or geographic areas, and creating custom groupings. Explains how to handle edge cases and maintain data integrity during transformation operations.
Export and Integration
Documentation for exporting data and analysis results in various formats. Covers CSV, Excel, JSON, and API integration options. Explains data structure in each format and provides examples for importing into common analysis tools and programming environments.
Usage Guidelines
Important information about appropriate use of research data and tools.
Citation Requirements
When using data or analysis from our platform in research, publications, or presentations, proper attribution is required. We provide standard citation formats for different contexts and explain how to reference specific datasets, indicators, or analytical outputs appropriately.
Limitations and Caveats
All data and analytical tools have limitations. Documentation clearly states known data quality issues, coverage gaps, methodological constraints, and appropriate use cases. Understanding these limitations is essential for producing valid research conclusions.
Update Schedules
Different datasets update on different schedules based on source availability. Documentation specifies update frequency for each dataset, typical lag between reference period and publication, and any seasonal patterns in data releases. This helps users understand data currency.
Support Resources
Beyond written documentation, we provide additional support through worked examples, video tutorials, and direct assistance channels. Documentation includes links to these resources and explains how to access help for specific questions or technical issues.
Need Additional Information?
Contact our research team for detailed technical assistance or specific documentation requests.
Contact Us