Solar Lake Enterprise API¶

The Solar Lake Enterprise API provides programmatic access to Urban Analytica’s Solar Lake dataset.

It enables clients to retrieve detailed residential building-level data, photovoltaic (PV) suitability metrics, aggregated spatial indicators, and regional market analytics.

The API is designed for:

Interactive map applications
Analytics workflows
Data enrichment
Lead generation
Campaign extraction
Geospatial analysis

Documentation is available at:

https://docs.sle.urbananalytica.de

What Are You Trying To Do?¶

Goal	Recommended Endpoint Family
Load map viewport data	`/bbox/*`
Retrieve known entities	Lookup endpoints
Extract analytical datasets	`/query/buildings`
Enrich coordinates with building data	`/buildings-coordinates`
Analyze regions and markets	H3, postcode, municipality endpoints
Enrich existing building IDs	Batch lookup endpoints

How To Think About The API¶

Solar Lake exposes the same underlying building data at multiple geographic aggregation levels.

Buildings
   ↓
H3 cells
   ↓
Postcodes
   ↓
Municipalities

Buildings¶

Buildings are the most granular entities in the API.

Building records contain address information, geometry, roof-level data, photovoltaic indicators, technical metrics, and economic metrics.

Buildings are the foundation for all aggregated datasets.

H3 Cells¶

H3 provides a uniform hexagonal spatial grid.

Use H3 when you want:

Spatial analytics
Heatmaps
Geographically neutral comparisons
Region-independent aggregation

H3 is especially useful for analytics and visualization workflows.

Postcodes and Municipalities¶

Postcodes and municipalities are administrative and business regions.

Use them when you want:

Market analysis
Regional comparisons
Campaign planning
Reporting aligned to real-world regions

These aggregates summarize the underlying building-level data.

Core Usage Patterns¶

The API is structured around three primary access patterns.

Map Viewport Loading¶

For interactive maps and spatial browsing.

Recommended endpoints:

GET /bbox/...
- Simple and fast viewport loading
POST /bbox/...
- Advanced viewport loading with filtering, field projection, pagination, and incremental loading

Targeted Lookups¶

For retrieving known entities.

Examples:

Building by ID
Building by coordinate
H3 cell by ID
Postcode by ID
Municipality by AGS
Batch lookups by IDs or coordinates

These endpoints are useful for detail views, drill-down workflows, and enrichment workflows.

Bulk Extraction¶

For analytics, lead generation, exports, and campaign workflows.

Recommended endpoint:

POST /query/buildings

Capabilities:

Region-based extraction
Filtering
Field projection
Cursor pagination
Large-scale data retrieval

This is the recommended workflow for analytical data extraction.

Typical Workflows¶

Coordinate Enrichment¶

CRM coordinates
    ↓
/buildings-coordinates
    ↓
Building enrichment
    ↓
PV analytics or lead scoring

Campaign Lead Generation¶

Select regions
    ↓
/query/buildings
    ↓
Filter high-opportunity buildings
    ↓
Export leads

Regional Market Analysis¶

Query postcodes, municipalities, or H3 cells
    ↓
Compare opportunity metrics
    ↓
Identify attractive regions

Roof-Level Analytics¶

Extract buildings
    ↓
Enrich detailed roof information
    ↓
Analyze orientations, pitches, and PV potential

What You Can Access¶

The API provides two main categories of data.

Building-Level Data¶

Detailed records for individual residential buildings, including:

Address information
Building characteristics
Roof characteristics
Photovoltaic indicators
Technical metrics
Economic metrics
Roof-part-level information
GeoJSON geometry

Example metrics include:

PV installed
Expected kWh production
kWp capacity
Panel count
Earnings
Costs

Aggregated Data¶

Aggregated metrics at different geographic levels:

H3 cells
Postcode areas
Municipalities

Aggregates include:

Building counts
PV installation counts
Opportunity scores
Roof statistics
Building construction period shares
Socio-demographic indicators
GeoJSON geometry for mapping

API Base URL¶

https://api.sle.urbananalytica.de

Filtering and Query Capabilities¶

Advanced POST endpoints support a Mongo-like filter syntax.

Supported operators:

Equality: $eq, $ne
Comparisons: $gt, $gte, $lt, $lte
Set membership: $in, $nin

Example:

{
  "pv": false,
  "roof_area": { "$gte": 80 },
  "building_type": {
    "$in": ["single-family house", "terraced house"]
  }
}

For best performance, request only required fields:

{
  "options": {
    "select": [
      "roof_area",
      "pv",
      "sales_opportunity_score"
    ]
  }
}

Authentication¶

All endpoints require a subscription_key query parameter.

Example:

GET /building?building_id=01c02e568d94065d29c7fd9e&subscription_key=YOUR_KEY

Authentication details and examples are documented in the Getting Started section.

Data Format and Conventions¶

Coordinates use WGS84 longitude and latitude.
Geometry fields are returned as GeoJSON.
ID fields are always included in projected responses.
Pagination defaults apply if limit is omitted.
Validation errors return HTTP 422.

More details are available in the Conventions section.

API Reference¶

A complete machine-readable specification is available in the Reference section.

Swagger UI provides the authoritative definition of:

Endpoints
Request schemas
Response schemas
Validation constraints

Swagger UI:

https://api.sle.urbananalytica.de

Version¶

Current API version: 0.6.4