PropertyOS - Data Infrastructure for European Property Markets

API Documentation

Complete reference for PropertyOS & FairRent APIs

Base URL

https://yourapp.com

All endpoints are relative to this base URL. Read endpoints and the calculator demo are public. Monitoring and admin operations use Clerk authentication and role checks.

GET/api/analytics/datasets

Get analytics datasets with metadata

Example Request

curl https://yourapp.com/api/analytics/datasets

Example Response

{
  "success": true,
  "datasets": [
    {
      "datasetId": "tourism_nights_spent",
      "name": "Tourism Nights Spent",
      "category": "tourism",
      "qualityGrade": "A",
      "healthScore": 95.5,
      "updateFrequency": "monthly",
      "lastUpdated": "2024-11-01T00:00:00.000Z",
      "description": "Tourist accommodation nights",
      "source": "Eurostat"
    }
  ],
  "timestamp": "2026-04-03T00:00:00.000Z",
  "total": 1
}

GET/api/analytics/timeseries/{dataset_id}

Get time series data for a specific dataset

Parameters

countrystringrequiredISO 2-letter country code (e.g., GR, DE, FR)

start_datestringFilter from date (YYYY-MM-DD)

end_datestringFilter to date (YYYY-MM-DD)

frequencymonthly | quarterly | yearlyOptional resampling frequency. Returns the latest point per month, quarter, or year.

Example Request

curl 'https://yourapp.com/api/analytics/timeseries/gdp_growth?country=GR&start_date=2020-01-01'

Example Response

{
  "success": true,
  "dataset": {
    "id": "gdp_growth",
    "name": "GDP Growth Rate",
    "unit": "percentage"
  },
  "data": [
    {
      "date": "2023-12-01",
      "value": 2.5,
      "confidence_score": 95,
      "is_estimated": false
    }
  ]
}

GET/api/analytics/compare

Compare multiple datasets with correlation analysis

Parameters

datasetsstringrequiredComma-separated dataset IDs (max 10)

countrystringrequiredISO 2-letter country code

Example Request

curl 'https://yourapp.com/api/analytics/compare?datasets=gdp_growth,unemployment_rate,tourism_nights_spent&country=GR'

Example Response

{
  "success": true,
  "datasets": [
    {
      "id": "gdp_growth",
      "name": "GDP Growth",
      "data": [...]
    }
  ],
  "correlations": {
    "gdp_growth_vs_unemployment_rate": -0.75,
    "gdp_growth_vs_tourism_nights_spent": 0.63
  }
}

GET/api/analytics/cross-country/{dataset_id}

Compare same dataset across multiple countries

Parameters

countriesstringrequiredComma-separated ISO 2-letter country codes

datestringSpecific date for comparison

Example Request

curl 'https://yourapp.com/api/analytics/cross-country/gdp_growth?countries=GR,DE,FR,ES'

Example Response

{
  "success": true,
  "dataset": {
    "id": "gdp_growth",
    "name": "GDP Growth Rate",
    "category": "economy",
    "unit": "%"
  },
  "comparison": [
    {
      "country": "DE",
      "date": "2026-03-01",
      "value": 3.2,
      "rank": 1
    }
  ],
  "statistics": {
    "mean": 2.5,
    "median": 2.3,
    "std_dev": 0.8
  }
}

GET/api/analytics/category/{category}

Get all datasets in a category with latest values and trends

Parameters

countrystringFilter to specific country

Example Request

curl 'https://yourapp.com/api/analytics/category/tourism?country=GR'

Example Response

{
  "success": true,
  "category": "tourism",
  "datasets": [
    {
      "id": "tourism_nights_spent",
      "latest_value": 25000000,
      "trend": "increasing",
      "trend_percentage": 5.2
    }
  ]
}

GET/api/analytics/dashboard/{country}

Unified dashboard - all key metrics for a country in one call

Example Request

curl https://yourapp.com/api/analytics/dashboard/GR

Example Response

{
  "success": true,
  "country": "GR",
  "sections": {
    "economy": {
      "gdp_growth": 2.5,
      "unemployment_rate": 11.2,
      "inflation_rate": 3.8,
      "status": "moderate"
    },
    "housing": {
      "rental_price_index": 112.5,
      "status": "hot"
    },
    "demographics": {...},
    "market_health": {...}
  }
}

API Documentation

Complete reference for PropertyOS & FairRent APIs

View on GitHub

Base URL

https://yourapp.com

All endpoints are relative to this base URL. Read endpoints and the calculator demo are public. Monitoring and admin operations use Clerk authentication and role checks.

GET/api/analytics/datasets

Get analytics datasets with metadata

Example Request

curl https://yourapp.com/api/analytics/datasets

Example Response

{
  "success": true,
  "datasets": [
    {
      "datasetId": "tourism_nights_spent",
      "name": "Tourism Nights Spent",
      "category": "tourism",
      "qualityGrade": "A",
      "healthScore": 95.5,
      "updateFrequency": "monthly",
      "lastUpdated": "2024-11-01T00:00:00.000Z",
      "description": "Tourist accommodation nights",
      "source": "Eurostat"
    }
  ],
  "timestamp": "2026-04-03T00:00:00.000Z",
  "total": 1
}

GET/api/analytics/timeseries/{dataset_id}

Get time series data for a specific dataset

Parameters

countrystringrequiredISO 2-letter country code (e.g., GR, DE, FR)

start_datestringFilter from date (YYYY-MM-DD)

end_datestringFilter to date (YYYY-MM-DD)

frequencymonthly | quarterly | yearlyOptional resampling frequency. Returns the latest point per month, quarter, or year.

Example Request

curl 'https://yourapp.com/api/analytics/timeseries/gdp_growth?country=GR&start_date=2020-01-01'

Example Response

{
  "success": true,
  "dataset": {
    "id": "gdp_growth",
    "name": "GDP Growth Rate",
    "unit": "percentage"
  },
  "data": [
    {
      "date": "2023-12-01",
      "value": 2.5,
      "confidence_score": 95,
      "is_estimated": false
    }
  ]
}

GET/api/analytics/compare

Compare multiple datasets with correlation analysis

Parameters

datasetsstringrequiredComma-separated dataset IDs (max 10)

countrystringrequiredISO 2-letter country code

Example Request

curl 'https://yourapp.com/api/analytics/compare?datasets=gdp_growth,unemployment_rate,tourism_nights_spent&country=GR'

Example Response

{
  "success": true,
  "datasets": [
    {
      "id": "gdp_growth",
      "name": "GDP Growth",
      "data": [...]
    }
  ],
  "correlations": {
    "gdp_growth_vs_unemployment_rate": -0.75,
    "gdp_growth_vs_tourism_nights_spent": 0.63
  }
}

GET/api/analytics/cross-country/{dataset_id}

Compare same dataset across multiple countries

Parameters

countriesstringrequiredComma-separated ISO 2-letter country codes

datestringSpecific date for comparison

Example Request

curl 'https://yourapp.com/api/analytics/cross-country/gdp_growth?countries=GR,DE,FR,ES'

Example Response

{
  "success": true,
  "dataset": {
    "id": "gdp_growth",
    "name": "GDP Growth Rate",
    "category": "economy",
    "unit": "%"
  },
  "comparison": [
    {
      "country": "DE",
      "date": "2026-03-01",
      "value": 3.2,
      "rank": 1
    }
  ],
  "statistics": {
    "mean": 2.5,
    "median": 2.3,
    "std_dev": 0.8
  }
}

GET/api/analytics/category/{category}

Get all datasets in a category with latest values and trends

Parameters

countrystringFilter to specific country

Example Request

curl 'https://yourapp.com/api/analytics/category/tourism?country=GR'

Example Response

{
  "success": true,
  "category": "tourism",
  "datasets": [
    {
      "id": "tourism_nights_spent",
      "latest_value": 25000000,
      "trend": "increasing",
      "trend_percentage": 5.2
    }
  ]
}

GET/api/analytics/dashboard/{country}

Unified dashboard - all key metrics for a country in one call

Example Request

curl https://yourapp.com/api/analytics/dashboard/GR

Example Response

{
  "success": true,
  "country": "GR",
  "sections": {
    "economy": {
      "gdp_growth": 2.5,
      "unemployment_rate": 11.2,
      "inflation_rate": 3.8,
      "status": "moderate"
    },
    "housing": {
      "rental_price_index": 112.5,
      "status": "hot"
    },
    "demographics": {...},
    "market_health": {...}
  }
}