CRE API Admin

Quick Start

To get started with the API, you need to authenticate using your API key and email. All requests must include the following headers:

X-API-Key: your_api_key_here
X-Email: [email protected]

For testing purposes, you can use a test API key that starts with test_.

API Reference

POST /api/analyze

Analyze Property

Submit a property for analysis using AI-powered templates.

Request Body

{
    "tenant": "string",          // Tenant name for template selection
    "address": "string",         // Property street address
    "city": "string",            // Property city
    "state": "string",           // Property state (2-letter code)
    "zip_code": "string",        // Property ZIP code
    "building_square_feet": number,  // Building size in square feet
    "lot_size_acres": number,    // Lot size in acres
    "year_built": number,        // Year the property was built
    "closing_noi": number,       // Net Operating Income at closing
    "remaining_lease_term": number,  // Remaining lease term in years
    "analysis_template": "string",   // Optional: Specific template ID to use
    "ai_processing": {           // Optional: AI processing flags
        "analyze_location": boolean,
        "analyze_market": boolean,
        "generate_summary": boolean
    },
    "benchmark_data": {          // Optional: Benchmark data for validation
        "sold_price": number,
        "closing_cap_rate": number
    },
    "request_type": "test"       // Optional: Set to "test" to trigger test mode
}

Test Mode

To trigger test mode, you can either:

Set the tenant field to TEST_REQUEST.
Include "request_type": "test" in the request body.

In test mode, the API will return a predefined response without performing actual analysis.

Response

{
    "suggested_price": number,   // Suggested property value
    "listcap": number,           // List cap rate
    "cap_rate": number,          // Cap rate
    "confidence_score": number,  // Confidence score (0-1)
    "comparable_properties": [    // List of comparable properties
        {
            "address": "string",
            "city": "string",
            "state": "string",
            "sale_price": number,
            "cap_rate": number,
            "sale_date": "string",
            "similarity_score": number
        }
    ],
    "market_analysis": {         // Market analysis details
        "market_overview": "string",
        "demographic_trends": "string",
        "market_metrics": {
            "population_growth": "string",
            "median_income": "string",
            "unemployment_rate": "string"
        }
    },
    "risk_factors": ["string"],  // List of identified risk factors
    "bov_report": "string",      // Broker Opinion of Value report
    "request_id": "string",      // Unique request identifier
    "request_info": {            // Request processing details
        "tokens_used": number,
        "processing_time": number,
        "status": "string",
        "benchmark_data": "string"
    }
}

Example Requests

Test Request

Send a test request to validate your integration and see example responses:

{
    "tenant": "TEST_REQUEST",
    "address": "123 Test St",
    "city": "Test City",
    "state": "TX",
    "zip_code": "12345",
    "building_square_feet": 9000,
    "lot_size_acres": 1.2,
    "year_built": 2020,
    "closing_noi": 150000,
    "remaining_lease_term": 15,
    "ai_processing": {}
}

Analysis Request

Real analysis request with tenant-based template selection:

{
    "tenant": "Dollar General",
    "address": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip_code": "78701",
    "building_square_feet": 9000,
    "lot_size_acres": 1.2,
    "year_built": 2020,
    "closing_noi": 150000,
    "remaining_lease_term": 15,
    "ai_processing": {
        "analyze_location": true,
        "analyze_market": true,
        "generate_summary": true
    },
    "benchmark_data": {
        "sold_price": 2500000,
        "closing_cap_rate": 6.5
    }
}

API Documentation