{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/gwr-datahub.test" } ], "info": { "name": "gwr-datahub API Documentation", "_postman_id": "1409c79b-43e3-432d-9da1-11669c8795a4", "description": "API for accessing Swiss building registry (GWR) data, electricity tariffs from grid operators (VNB), and related infrastructure information.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Buildings", "description": "", "item": [ { "name": "List buildings by municipality (BFS)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings", "query": [ { "key": "municipality", "value": "261", "description": "integer BFS municipality number.", "disabled": false }, { "key": "per_page", "value": "200", "description": "Number of items per page. Min: 1, Max: 1000. Default: 200.", "disabled": false }, { "key": "lang", "value": "de", "description": "Language for code labels when resolve_codes=1. Options: de, fr, it. Default: de.", "disabled": false }, { "key": "resolve_codes", "value": "1", "description": "Whether to resolve code labels. Default: 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/buildings?municipality=261&per_page=200&lang=de&resolve_codes=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"per_page\":17,\"lang\":\"fr\",\"resolve_codes\":false}" }, "description": "Returns a paginated list of GWR buildings for a given municipality (BFS number).\nCode label resolution is disabled by default for performance; enable with resolve_codes=1." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get lightweight map data for buildings by municipality", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/map-data", "query": [ { "key": "municipality", "value": "261", "description": "integer BFS municipality number.", "disabled": false }, { "key": "per_page", "value": "200", "description": "Number of items per page. Min: 1, Max: 1000. Default: 200.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number. Min: 1. Default: 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/buildings\/map-data?municipality=261&per_page=200&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"per_page\":17,\"page\":35}" }, "description": "Returns minimal building data optimized for map visualizations.\nOnly includes buildings with valid coordinates (latitude\/longitude)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get building information by EGID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid", "query": [ { "key": "lang", "value": "de", "description": "The language for code labels. Options: `de` (German), `fr` (French), `it` (Italian). Default: `de`.", "disabled": false }, { "key": "sync", "value": "", "description": "Whether to sync missing address\/solar data from external APIs (OSB, GeoAdmin). Default: `0` (disabled). Set to `1` to enable on-demand sync. When disabled, returns only locally stored data.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/buildings\/:egid?lang=de&sync=", "variable": [ { "id": "egid", "key": "egid", "value": "1234567890", "description": "string The building EGID (Eidgen\u00f6ssische Geb\u00e4udeidentifikator)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a building from the GWR (Geb\u00e4ude- und Wohnungsregister) database.\nAll code fields are automatically resolved to their human-readable labels in the specified language.\n\nIf address or solar potential data is missing, it will be automatically synchronized before returning the response." }, "response": [ { "header": [], "code": 200, "body": "{\n \"egid\": \"1234567890\",\n \"gdekt\": \"ZH\",\n \"ggdenr\": \"261\",\n \"ggdename\": \"Z\u00fcrich\",\n \"egrid\": \"2680000.0,1240000.0\",\n \"gbez\": \"Wohnhaus\",\n \"gkode\": \"01\",\n \"gkode_label\": \"Wohngeb\u00e4ude\",\n \"gstat\": \"01\",\n \"gstat_label\": \"Bestehend\",\n \"gkat\": \"01\",\n \"gkat_label\": \"Einfamilienhaus\",\n \"gbauj\": 1990,\n \"garea\": 150.5,\n \"gvol\": 450.0,\n \"address\": {\n \"street\": \"Hauptstrasse 45\",\n \"postal_code\": \"6260\",\n \"city\": \"Reiden\"\n },\n \"solar_roofs\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"high\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"solar_facades\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"medium\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"created_at\": \"2025-01-01T00:00:00+00:00\",\n \"updated_at\": \"2025-01-01T00:00:00+00:00\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Building not found\"\n}", "name": "" } ] } ] }, { "name": "EVU Tariffs", "description": "", "item": [ { "name": "List all grid operators", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/evu-tariffs\/operators", "query": [ { "key": "per_page", "value": "50", "description": "Number of items per page. Min: 1, Max: 100. Default: 50.", "disabled": false }, { "key": "status", "value": "found", "description": "Filter by tariff URL status. Options: pending, found, not_found, manual, invalid.", "disabled": false }, { "key": "search", "value": "EKZ", "description": "Search by operator name or CH UID.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/evu-tariffs\/operators?per_page=50&status=found&search=EKZ" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of all active grid operators (Verteilnetzbetreiber) with their tariff URL status\nand information about the latest successful tariff submission." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"ch_uid\": \"CHE-108.954.688\",\n \"name\": \"Elektrizit\u00e4tswerke des Kantons Z\u00fcrich (EKZ)\",\n \"website_url\": \"www.ekz.ch\",\n \"tariff_url\": \"https:\/\/ekz.ch\/api\/tariffs.json\",\n \"tariff_url_status\": \"found\",\n \"tariff_url_verified_at\": \"2026-01-15T10:00:00+00:00\",\n \"is_active\": true,\n \"latest_submission\": {\n \"fetched_at\": \"2026-01-15T10:00:00+00:00\",\n \"tariff_year\": 2026,\n \"tariff_count\": 12\n },\n \"elcom_synced_at\": \"2026-01-01T00:00:00+00:00\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/evu-tariffs\/operators?page=1\",\n \"last\": \"https:\/\/example.com\/api\/evu-tariffs\/operators?page=10\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/evu-tariffs\/operators?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 10,\n \"per_page\": 50,\n \"to\": 50,\n \"total\": 500\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "Get a single grid operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/evu-tariffs\/operators\/:chUid", "query": [], "raw": "{{baseUrl}}\/api\/evu-tariffs\/operators\/:chUid", "variable": [ { "id": "chUid", "key": "chUid", "value": "CHE-108.954.688", "description": "string The CH UID (Unternehmens-Identifikationsnummer) of the grid operator." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific grid operator (Verteilnetzbetreiber) by its CH UID,\nincluding the latest submission status and tariff URL information." }, "response": [ { "header": [], "code": 200, "body": "{\n \"ch_uid\": \"CHE-108.954.688\",\n \"name\": \"Elektrizit\u00e4tswerke des Kantons Z\u00fcrich (EKZ)\",\n \"website_url\": \"www.ekz.ch\",\n \"tariff_url\": \"https:\/\/ekz.ch\/api\/tariffs.json\",\n \"tariff_url_status\": \"found\",\n \"tariff_url_verified_at\": \"2026-01-15T10:00:00+00:00\",\n \"is_active\": true,\n \"latest_submission\": {\n \"fetched_at\": \"2026-01-15T10:00:00+00:00\",\n \"tariff_year\": 2026,\n \"tariff_count\": 12\n },\n \"elcom_synced_at\": \"2026-01-01T00:00:00+00:00\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Grid operator not found\",\n \"code\": \"operator_not_found\"\n}", "name": "" } ] }, { "name": "Get tariffs for a grid operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/evu-tariffs\/operators\/:chUid\/tariffs", "query": [ { "key": "year", "value": "2026", "description": "Filter by tariff year. Default: current year.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/evu-tariffs\/operators\/:chUid\/tariffs?year=2026", "variable": [ { "id": "chUid", "key": "chUid", "value": "CHE-108.954.688", "description": "string The CH UID of the grid operator." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the cached tariffs for a specific grid operator in the standard format\naccording to StromVV Art. 7b. The response includes all tariff types:\n- `electricity`: Elektrizit\u00e4tstarif (energy costs)\n- `grid`: Netznutzungstarif (grid usage fees)\n- `metering`: Messtarif (metering costs)\n- `regional_fees`: Abgaben an Gemeinwesen (taxes and levies)\n\nTariff forms can be:\n- `constant`: Single price (Einheitstarif)\n- `multilevel`: Time-of-use pricing with HT\/NT (Mehrstufentarif)\n- `dynamic`: Real-time pricing (Dynamischer Tarif) - use the dynamic endpoint for current prices" }, "response": [ { "header": [], "code": 200, "body": "{\n \"dsoName\": \"Elektrizit\u00e4tswerke des Kantons Z\u00fcrich (EKZ)\",\n \"dsoNumber\": 10895468800,\n \"tariffs\": [\n {\n \"customerVoltageLevel\": 7,\n \"tariffName\": \"Haushalt Standard\",\n \"tariffType\": \"electricity\",\n \"tariffForm\": \"multilevel\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"comment\": null,\n \"customerType\": \"household\",\n \"prices\": {\n \"multilevel\": {\n \"levels\": [\n {\"name\": \"HT\", \"price\": 0.22, \"unit\": \"CHF\/kWh\"},\n {\"name\": \"NT\", \"price\": 0.18, \"unit\": \"CHF\/kWh\"}\n ]\n }\n }\n },\n {\n \"customerVoltageLevel\": 7,\n \"tariffName\": \"Netznutzung Haushalt\",\n \"tariffType\": \"grid\",\n \"tariffForm\": \"constant\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"comment\": null,\n \"customerType\": \"household\",\n \"prices\": {\n \"constant\": {\n \"price\": 0.08,\n \"unit\": \"CHF\/kWh\"\n }\n }\n }\n ],\n \"_meta\": {\n \"ch_uid\": \"CHE-108.954.688\",\n \"fetched_at\": \"2026-01-15T10:00:00+00:00\",\n \"tariff_year\": 2026,\n \"source_url\": \"https:\/\/ekz.ch\/api\/tariffs.json\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Grid operator not found\",\n \"code\": \"operator_not_found\"\n}", "name": "Operator not found" }, { "header": [], "code": 404, "body": "{\n \"error\": \"No tariffs found for this operator\",\n \"code\": \"tariffs_not_found\",\n \"operator\": \"CHE-108.954.688\",\n \"year\": 2026\n}", "name": "No tariffs available" } ] }, { "name": "Proxy dynamic tariff data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/evu-tariffs\/operators\/:chUid\/dynamic", "query": [], "raw": "{{baseUrl}}\/api\/evu-tariffs\/operators\/:chUid\/dynamic", "variable": [ { "id": "chUid", "key": "chUid", "value": "CHE-108.954.688", "description": "string The CH UID of the grid operator." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Proxies requests to the dynamic tariff URL of a grid operator to retrieve real-time pricing data.\nThis endpoint is only available for operators that offer dynamic tariffs (tariffForm: \"dynamic\").\n\nThe response format depends on the grid operator's implementation but typically includes\ncurrent and\/or upcoming electricity prices with timestamps." }, "response": [ { "header": [], "code": 200, "body": "{\n \"timestamp\": \"2026-01-15T14:00:00+01:00\",\n \"prices\": [\n {\n \"start\": \"2026-01-15T14:00:00+01:00\",\n \"end\": \"2026-01-15T15:00:00+01:00\",\n \"price\": 0.1850,\n \"unit\": \"CHF\/kWh\"\n },\n {\n \"start\": \"2026-01-15T15:00:00+01:00\",\n \"end\": \"2026-01-15T16:00:00+01:00\",\n \"price\": 0.2150,\n \"unit\": \"CHF\/kWh\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": \"Operator does not have a dynamic tariff URL configured\",\n \"code\": \"proxy_error\"\n}", "name": "No dynamic tariff available" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Grid operator not found\",\n \"code\": \"operator_not_found\"\n}", "name": "" }, { "header": [], "code": 502, "body": "{\n \"error\": \"Failed to fetch dynamic tariff data from operator\",\n \"code\": \"proxy_error\"\n}", "name": "Upstream error" } ] } ] }, { "name": "BDEW Profiles", "description": "", "item": [ { "name": "List all BDEW profile codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bdew-profiles", "query": [], "raw": "{{baseUrl}}\/api\/bdew-profiles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all available BDEW standard load profile codes (e.g., H0, G0-G6, L0-L2).\nEach profile code represents a category of electricity consumption patterns." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"code\": \"H0\",\n \"name\": \"Household\",\n \"category\": \"household\",\n \"description\": \"Standard household profile\",\n \"metadata\": {}\n },\n {\n \"code\": \"G25\",\n \"name\": \"Commercial\",\n \"category\": \"commercial\",\n \"description\": \"Commercial profile\",\n \"metadata\": {}\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "Get all variations for a BDEW profile code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bdew-profiles\/:code", "query": [], "raw": "{{baseUrl}}\/api\/bdew-profiles\/:code", "variable": [ { "id": "code", "key": "code", "value": "H0", "description": "string The BDEW profile code (e.g., H0, G25, L25)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all 9 variations (3 seasons \u00d7 3 day types) for a specific BDEW profile code.\nEach variation contains 96 normalized values representing 15-minute intervals for a day." }, "response": [ { "header": [], "code": 200, "body": "{\n \"code\": \"H0\",\n \"name\": \"Household\",\n \"category\": \"household\",\n \"variations\": [\n {\n \"profile_code\": \"H0\",\n \"season\": \"winter\",\n \"day_type\": \"weekday\",\n \"values\": [0.0104, 0.0099, ...],\n \"is_dynamized\": true,\n \"description\": null,\n \"metadata\": {}\n },\n {\n \"profile_code\": \"H0\",\n \"season\": \"winter\",\n \"day_type\": \"saturday\",\n \"values\": [0.0104, 0.0099, ...],\n \"is_dynamized\": true,\n \"description\": null,\n \"metadata\": {}\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Profile code not found\"\n}", "name": "" } ] }, { "name": "Get daily template for a BDEW profile code by date", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bdew-profiles\/:code\/daily", "query": [ { "key": "date", "value": "2025-01-15", "description": "string The date in YYYY-MM-DD format.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/bdew-profiles\/:code\/daily?date=2025-01-15", "variable": [ { "id": "code", "key": "code", "value": "H0", "description": "string The BDEW profile code (e.g., H0, G25, L25)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-02-10\"}" }, "description": "Returns the correct BDEW load profile template for a specific date.\nThe season (winter\/summer\/transition) and day type (weekday\/saturday\/sunday) are automatically determined from the date." }, "response": [ { "header": [], "code": 200, "body": "{\n \"code\": \"H0\",\n \"date\": \"2025-01-15\",\n \"season\": \"winter\",\n \"day_type\": \"wednesday\",\n \"values\": [0.0104, 0.0099, ...],\n \"is_dynamized\": true,\n \"description\": null,\n \"metadata\": {}\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Profile code not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"date\": [\n \"The date field is required.\"\n ]\n }\n}", "name": "" } ] }, { "name": "Get yearly profile for a BDEW profile code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bdew-profiles\/:code\/year", "query": [ { "key": "year", "value": "2025", "description": "integer The year for the profile (2020-2035).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/bdew-profiles\/:code\/year?year=2025", "variable": [ { "id": "code", "key": "code", "value": "H25", "description": "string The BDEW profile code (e.g., H25, G25, L25)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Returns a complete year's worth of BDEW load profile data with all 365\/366 days.\nEach day includes 96 quarter-hour values, with dynamization applied where applicable.\nHolidays are treated as Sundays, and Dec 24\/31 use Saturday templates." }, "response": [ { "header": [], "code": 200, "body": "{\n \"code\": \"H25\",\n \"year\": 2025,\n \"is_dynamized\": true,\n \"total_kwh\": 1000000.00,\n \"days\": [\n {\n \"date\": \"2025-01-01\",\n \"day_of_year\": 1,\n \"month\": 1,\n \"day_type\": \"sunday\",\n \"is_holiday\": true,\n \"holiday_name\": \"Neujahr\",\n \"dynamization_factor\": 1.2421,\n \"values\": [22.15, 20.81, 19.76, ...]\n }\n ],\n \"meta\": {\n \"total_days\": 365,\n \"is_leap_year\": false,\n \"generated_at\": \"2025-01-15T10:30:00Z\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Profile code not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"year\": [\n \"The year field is required.\"\n ]\n }\n}", "name": "" } ] }, { "name": "List available years for a profile code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bdew-profiles\/:code\/years", "query": [], "raw": "{{baseUrl}}\/api\/bdew-profiles\/:code\/years", "variable": [ { "id": "code", "key": "code", "value": "H25", "description": "string The BDEW profile code (e.g., H25, G25)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the years that have pre-generated yearly profiles available." }, "response": [ { "header": [], "code": 200, "body": "{\n \"code\": \"H25\",\n \"available_years\": [2024, 2025, 2026],\n \"supported_range\": {\n \"min\": 2020,\n \"max\": 2035\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Profile code not found\"\n}", "name": "" } ] } ] }, { "name": "Reference Market Prices", "description": "", "item": [ { "name": "List reference market prices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-prices", "query": [ { "key": "technology", "value": "photovoltaic", "description": "Filter by technology. Options: photovoltaic, hydropower, biomass, wind, geothermal.", "disabled": false }, { "key": "period_type", "value": "monthly", "description": "Filter by period type. Options: monthly, quarterly.", "disabled": false }, { "key": "year", "value": "2025", "description": "Filter by year.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Number of items per page. Min: 1, Max: 1000. Default: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reference-market-prices?technology=photovoltaic&period_type=monthly&year=2025&per_page=100" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"technology\":\"wind\",\"period_type\":\"monthly\",\"year\":1,\"per_page\":22}" }, "description": "Returns a paginated list of BFE reference market prices (Art. 15 EnFV).\nPrices are available for different technologies (photovoltaic, hydropower, biomass, wind, geothermal)\nand different period types (monthly, quarterly)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"technology\": \"photovoltaic\",\n \"technology_label\": \"Photovoltaik\",\n \"period_type\": \"monthly\",\n \"period_type_label\": \"Monatlich\",\n \"year\": 2025,\n \"period\": 1,\n \"period_label\": \"Januar 2025\",\n \"price\": 85.50,\n \"price_unit\": \"CHF\/MWh\",\n \"volume\": 125000.00,\n \"volume_unit\": \"MWh\",\n \"created_at\": \"2025-01-15T12:00:00+00:00\",\n \"updated_at\": \"2025-01-15T12:00:00+00:00\"\n }\n ],\n \"links\": {\n \"first\": \"...\",\n \"last\": \"...\",\n \"prev\": null,\n \"next\": \"...\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 5,\n \"per_page\": 100,\n \"to\": 100,\n \"total\": 450\n }\n}", "name": "" } ] }, { "name": "Get latest prices per technology", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-prices\/latest", "query": [], "raw": "{{baseUrl}}\/api\/reference-market-prices\/latest" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recent reference market price for each technology,\ngrouped by period type (monthly and quarterly)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"monthly\": {\n \"photovoltaic\": {\n \"id\": 1,\n \"technology\": \"photovoltaic\",\n \"technology_label\": \"Photovoltaik\",\n \"period_type\": \"monthly\",\n \"period_type_label\": \"Monatlich\",\n \"year\": 2025,\n \"period\": 12,\n \"period_label\": \"Dezember 2025\",\n \"price\": 85.50,\n \"price_unit\": \"CHF\/MWh\",\n \"volume\": 125000.00,\n \"volume_unit\": \"MWh\",\n \"created_at\": \"2025-01-15T12:00:00+00:00\",\n \"updated_at\": \"2025-01-15T12:00:00+00:00\"\n }\n },\n \"quarterly\": {\n \"photovoltaic\": {\n \"id\": 2,\n \"technology\": \"photovoltaic\",\n \"period_type\": \"quarterly\",\n \"year\": 2025,\n \"period\": 4,\n \"period_label\": \"Q4 2025\",\n \"price\": 82.30\n }\n }\n}", "name": "" } ] }, { "name": "List available technologies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-prices\/technologies", "query": [], "raw": "{{baseUrl}}\/api\/reference-market-prices\/technologies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all available technologies with their labels." }, "response": [ { "header": [], "code": 200, "body": "{\n \"technologies\": [\n {\"value\": \"photovoltaic\", \"label\": \"Photovoltaik\"},\n {\"value\": \"hydropower\", \"label\": \"Wasserkraft\"},\n {\"value\": \"biomass\", \"label\": \"Biomasse\"},\n {\"value\": \"wind\", \"label\": \"Windenergie\"},\n {\"value\": \"geothermal\", \"label\": \"Geothermie\"}\n ],\n \"period_types\": [\n {\"value\": \"monthly\", \"label\": \"Monatlich\"},\n {\"value\": \"quarterly\", \"label\": \"Quartal\"}\n ]\n}", "name": "" } ] } ] }, { "name": "Reference Market Price Predictions", "description": "", "item": [ { "name": "List reference market price predictions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-price-predictions", "query": [ { "key": "technology", "value": "photovoltaic", "description": "Filter by technology. Options: photovoltaic, hydropower, biomass, wind, geothermal.", "disabled": false }, { "key": "period_type", "value": "monthly", "description": "Filter by period type. Options: monthly, quarterly.", "disabled": false }, { "key": "year", "value": "2026", "description": "Filter by year.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Number of items per page. Min: 1, Max: 1000. Default: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reference-market-price-predictions?technology=photovoltaic&period_type=monthly&year=2026&per_page=100" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"technology\":\"biomass\",\"period_type\":\"monthly\",\"year\":1,\"per_page\":22}" }, "description": "Returns a paginated list of predicted reference market prices based on EPEX spot prices\nand ENTSO-E generation profiles (BFE Art. 15 EnFV methodology)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"technology\": \"photovoltaic\",\n \"technology_label\": \"Photovoltaik\",\n \"period_type\": \"monthly\",\n \"period_type_label\": \"Monatlich\",\n \"year\": 2026,\n \"period\": 1,\n \"period_label\": \"Januar 2026\",\n \"price\": 72.35,\n \"price_unit\": \"EUR\/MWh\",\n \"volume\": 125000.00,\n \"volume_unit\": \"MWh\",\n \"calculated_at\": \"2026-02-10T07:30:00+00:00\",\n \"data_completeness\": 98.50,\n \"is_partial\": false,\n \"created_at\": \"2026-01-15T12:00:00+00:00\",\n \"updated_at\": \"2026-02-10T07:30:00+00:00\"\n }\n ],\n \"links\": {},\n \"meta\": {}\n}", "name": "" } ] }, { "name": "Get latest predictions per technology", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-price-predictions\/latest", "query": [], "raw": "{{baseUrl}}\/api\/reference-market-price-predictions\/latest" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recent prediction for each technology,\ngrouped by period type (monthly and quarterly)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"monthly\": {\n \"photovoltaic\": {}\n },\n \"quarterly\": {\n \"photovoltaic\": {}\n }\n}", "name": "" } ] }, { "name": "Get current month prediction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-price-predictions\/current-month", "query": [], "raw": "{{baseUrl}}\/api\/reference-market-price-predictions\/current-month" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the prediction for the current (in-progress) month,\nincluding data completeness and partial status." }, "response": [ { "header": [], "code": 200, "body": "{\n \"year\": 2026,\n \"month\": 2,\n \"predictions\": {}\n}", "name": "" } ] }, { "name": "Compare predictions with official BFE values", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reference-market-price-predictions\/compare", "query": [ { "key": "technology", "value": "photovoltaic", "description": "Filter by technology.", "disabled": false }, { "key": "year", "value": "2026", "description": "Filter by year.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reference-market-price-predictions\/compare?technology=photovoltaic&year=2026" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a side-by-side comparison of predicted values against\nthe official BFE reference market prices where both are available." }, "response": [ { "header": [], "code": 200, "body": "{\n \"comparisons\": [\n {\n \"technology\": \"photovoltaic\",\n \"period_type\": \"monthly\",\n \"year\": 2026,\n \"period\": 1,\n \"period_label\": \"Januar 2026\",\n \"predicted_price\": 72.35,\n \"official_price\": 73.10,\n \"deviation\": -0.75,\n \"deviation_percent\": -1.03,\n \"data_completeness\": 98.50\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Transformer Stations", "description": "", "item": [ { "name": "List transformer stations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transformer-stations", "query": [ { "key": "municipality", "value": "261", "description": "Filter by municipality BFS number (Gemeindenummer).", "disabled": false }, { "key": "postal_code", "value": "8001", "description": "Filter by postal code (PLZ).", "disabled": false }, { "key": "status", "value": "confirmed", "description": "Filter by status. Options: `candidate`, `confirmed`.", "disabled": false }, { "key": "lat", "value": "47.3769", "description": "Latitude (WGS84) for radius search. Required together with `lng` and `radius`.", "disabled": false }, { "key": "lng", "value": "8.5417", "description": "Longitude (WGS84) for radius search. Required together with `lat` and `radius`.", "disabled": false }, { "key": "radius", "value": "1000", "description": "Search radius in meters (WGS84). Required together with `lat` and `lng`. Min: 1, Max: 50000.", "disabled": false }, { "key": "east", "value": "2680000", "description": "Easting (CH1903+) for radius search. Required together with `north` and `radius`.", "disabled": false }, { "key": "north", "value": "1240000", "description": "Northing (CH1903+) for radius search. Required together with `east` and `radius`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/transformer-stations?municipality=261&postal_code=8001&status=confirmed&lat=47.3769&lng=8.5417&radius=1000&east=2680000&north=1240000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"postal_code\":4326.41688,\"lat\":-90,\"lng\":-180,\"east\":4326.41688,\"north\":4326.41688,\"radius\":17,\"status\":\"candidate\"}" }, "description": "Returns a list of transformer stations (Trafostationen) with various filtering options.\nYou can filter by municipality (BFS number), postal code, status, or search within a radius using coordinates.\nCoordinates are taken directly from `gwr_buildings.GKODE` (Easting) and `gwr_buildings.GKODN` (Northing).\nThe `egrid` field contains the raw EGRID value from `gwr_buildings.EGRID`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"egid\": \"1234567890\",\n \"status\": \"confirmed\",\n \"building\": {\n \"egid\": \"1234567890\",\n \"gbez\": \"Trafo Station 1\",\n \"ggdenr\": \"261\",\n \"ggdename\": \"Z\u00fcrich\",\n \"egrid\": \"2680000.0,1240000.0\"\n },\n \"address\": {\n \"street\": \"Hauptstrasse 45\",\n \"postal_code\": \"6260\",\n \"city\": \"Reiden\"\n },\n \"solar_roofs\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"high\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"solar_facades\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"medium\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"coordinates\": {\n \"east\": 2680000.0,\n \"north\": 1240000.0\n },\n \"coordinates_wgs84\": {\n \"lat\": 47.3769,\n \"lng\": 8.5417\n },\n \"created_at\": \"2025-01-01T00:00:00+00:00\",\n \"updated_at\": \"2025-01-01T00:00:00+00:00\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"lat\": [\"The lat field is required when lng is present.\"]\n }\n}", "name": "" } ] } ] }, { "name": "Educational Institutions", "description": "", "item": [ { "name": "List educational institutions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/educational-institutions", "query": [ { "key": "municipality", "value": "261", "description": "Filter by municipality BFS number (Gemeindenummer).", "disabled": false }, { "key": "postal_code", "value": "8001", "description": "Filter by postal code (PLZ).", "disabled": false }, { "key": "status", "value": "confirmed", "description": "Filter by status. Options: `candidate`, `confirmed`.", "disabled": false }, { "key": "lat", "value": "47.3769", "description": "Latitude (WGS84) for radius search. Required together with `lng` and `radius`.", "disabled": false }, { "key": "lng", "value": "8.5417", "description": "Longitude (WGS84) for radius search. Required together with `lat` and `radius`.", "disabled": false }, { "key": "radius", "value": "1000", "description": "Search radius in meters (WGS84). Required together with `lat` and `lng`. Min: 1, Max: 50000.", "disabled": false }, { "key": "east", "value": "2680000", "description": "Easting (CH1903+) for radius search. Required together with `north` and `radius`.", "disabled": false }, { "key": "north", "value": "1240000", "description": "Northing (CH1903+) for radius search. Required together with `east` and `radius`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/educational-institutions?municipality=261&postal_code=8001&status=confirmed&lat=47.3769&lng=8.5417&radius=1000&east=2680000&north=1240000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"postal_code\":4326.41688,\"lat\":-90,\"lng\":-180,\"east\":4326.41688,\"north\":4326.41688,\"radius\":17,\"status\":\"candidate\"}" }, "description": "Returns a list of educational institutions (Schulh\u00e4user, Kinderg\u00e4rten, etc.) with various filtering options.\nYou can filter by municipality (BFS number), postal code, status, or search within a radius using coordinates.\nCoordinates are taken directly from `gwr_buildings.GKODE` (Easting) and `gwr_buildings.GKODN` (Northing)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"egid\": \"1234567890\",\n \"status\": \"confirmed\",\n \"building\": {\n \"egid\": \"1234567890\",\n \"gbez\": \"Schulhaus Muster\",\n \"ggdenr\": \"261\",\n \"ggdename\": \"Z\u00fcrich\",\n \"egrid\": \"2680000.0,1240000.0\"\n },\n \"address\": {\n \"street\": \"Hauptstrasse 45\",\n \"postal_code\": \"6260\",\n \"city\": \"Reiden\"\n },\n \"solar_roofs\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"high\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"solar_facades\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"medium\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"coordinates\": {\n \"east\": 2680000.0,\n \"north\": 1240000.0\n },\n \"coordinates_wgs84\": {\n \"lat\": 47.3769,\n \"lng\": 8.5417\n },\n \"created_at\": \"2025-01-01T00:00:00+00:00\",\n \"updated_at\": \"2025-01-01T00:00:00+00:00\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Municipal Properties", "description": "", "item": [ { "name": "List municipal properties", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/municipal-properties", "query": [ { "key": "municipality", "value": "261", "description": "Filter by municipality BFS number (Gemeindenummer).", "disabled": false }, { "key": "postal_code", "value": "8001", "description": "Filter by postal code (PLZ).", "disabled": false }, { "key": "status", "value": "confirmed", "description": "Filter by status. Options: `candidate`, `confirmed`.", "disabled": false }, { "key": "lat", "value": "47.3769", "description": "Latitude (WGS84) for radius search. Required together with `lng` and `radius`.", "disabled": false }, { "key": "lng", "value": "8.5417", "description": "Longitude (WGS84) for radius search. Required together with `lat` and `radius`.", "disabled": false }, { "key": "radius", "value": "1000", "description": "Search radius in meters (WGS84). Required together with `lat` and `lng`. Min: 1, Max: 50000.", "disabled": false }, { "key": "east", "value": "2680000", "description": "Easting (CH1903+) for radius search. Required together with `north` and `radius`.", "disabled": false }, { "key": "north", "value": "1240000", "description": "Northing (CH1903+) for radius search. Required together with `east` and `radius`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/municipal-properties?municipality=261&postal_code=8001&status=confirmed&lat=47.3769&lng=8.5417&radius=1000&east=2680000&north=1240000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"postal_code\":4326.41688,\"lat\":-90,\"lng\":-180,\"east\":4326.41688,\"north\":4326.41688,\"radius\":17,\"status\":\"confirmed\"}" }, "description": "Returns a list of municipal properties (Werkh\u00f6fe, Gemeindeverwaltung, Gemeindehaus, Feuerwehrmagazin, etc.) with various filtering options.\nYou can filter by municipality (BFS number), postal code, status, or search within a radius using coordinates.\nCoordinates are taken directly from `gwr_buildings.GKODE` (Easting) and `gwr_buildings.GKODN` (Northing)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"egid\": \"1234567890\",\n \"status\": \"confirmed\",\n \"building\": {\n \"egid\": \"1234567890\",\n \"gbez\": \"Gemeindehaus\",\n \"ggdenr\": \"261\",\n \"ggdename\": \"Z\u00fcrich\",\n \"egrid\": \"2680000.0,1240000.0\"\n },\n \"address\": {\n \"street\": \"Hauptstrasse 45\",\n \"postal_code\": \"6260\",\n \"city\": \"Reiden\"\n },\n \"solar_roofs\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"high\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"solar_facades\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"medium\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"coordinates\": {\n \"east\": 2680000.0,\n \"north\": 1240000.0\n },\n \"coordinates_wgs84\": {\n \"lat\": 47.3769,\n \"lng\": 8.5417\n },\n \"created_at\": \"2025-01-01T00:00:00+00:00\",\n \"updated_at\": \"2025-01-01T00:00:00+00:00\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Water Supply Buildings", "description": "", "item": [ { "name": "List water supply buildings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/water-supply-buildings", "query": [ { "key": "municipality", "value": "261", "description": "Filter by municipality BFS number (Gemeindenummer).", "disabled": false }, { "key": "postal_code", "value": "8001", "description": "Filter by postal code (PLZ).", "disabled": false }, { "key": "status", "value": "confirmed", "description": "Filter by status. Options: `candidate`, `confirmed`.", "disabled": false }, { "key": "lat", "value": "47.3769", "description": "Latitude (WGS84) for radius search. Required together with `lng` and `radius`.", "disabled": false }, { "key": "lng", "value": "8.5417", "description": "Longitude (WGS84) for radius search. Required together with `lat` and `radius`.", "disabled": false }, { "key": "radius", "value": "1000", "description": "Search radius in meters (WGS84). Required together with `lat` and `lng`. Min: 1, Max: 50000.", "disabled": false }, { "key": "east", "value": "2680000", "description": "Easting (CH1903+) for radius search. Required together with `north` and `radius`.", "disabled": false }, { "key": "north", "value": "1240000", "description": "Northing (CH1903+) for radius search. Required together with `east` and `radius`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/water-supply-buildings?municipality=261&postal_code=8001&status=confirmed&lat=47.3769&lng=8.5417&radius=1000&east=2680000&north=1240000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":4326.41688,\"postal_code\":4326.41688,\"lat\":-90,\"lng\":-180,\"east\":4326.41688,\"north\":4326.41688,\"radius\":17,\"status\":\"candidate\"}" }, "description": "Returns a list of water supply buildings (Wasserversorgung) with various filtering options.\nYou can filter by municipality (BFS number), postal code, status, or search within a radius using coordinates.\nCoordinates are taken directly from `gwr_buildings.GKODE` (Easting) and `gwr_buildings.GKODN` (Northing)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"egid\": \"1234567890\",\n \"status\": \"confirmed\",\n \"building\": {\n \"egid\": \"1234567890\",\n \"gbez\": \"Wasserwerk\",\n \"ggdenr\": \"261\",\n \"ggdename\": \"Z\u00fcrich\",\n \"egrid\": \"2680000.0,1240000.0\"\n },\n \"address\": {\n \"street\": \"Hauptstrasse 45\",\n \"postal_code\": \"6260\",\n \"city\": \"Reiden\"\n },\n \"solar_roofs\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"high\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"solar_facades\": [\n {\n \"attributes\": {\n \"building_id\": \"229760\",\n \"suitability\": \"medium\"\n },\n \"geometry\": {\n \"rings\": [[[2640325.75, 1232914.625]]]\n }\n }\n ],\n \"coordinates\": {\n \"east\": 2680000.0,\n \"north\": 1240000.0\n },\n \"coordinates_wgs84\": {\n \"lat\": 47.3769,\n \"lng\": 8.5417\n },\n \"created_at\": \"2025-01-01T00:00:00+00:00\",\n \"updated_at\": \"2025-01-01T00:00:00+00:00\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "GET api\/health", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health", "query": [], "raw": "{{baseUrl}}\/api\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "600" }, { "key": "x-ratelimit-remaining", "value": "599" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 200, "body": "{\"status\":\"ok\",\"time\":\"2026-02-10T16:25:53+00:00\"}", "name": "" } ] }, { "name": "Proxy all requests to OSB API.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/osb\/:path", "query": [], "raw": "{{baseUrl}}\/api\/osb\/:path", "variable": [ { "id": "path", "key": "path", "value": "%7C%7B%2B-0p", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Proxy all requests to OSB API.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/osb-v2\/:path", "query": [], "raw": "{{baseUrl}}\/api\/osb-v2\/:path", "variable": [ { "id": "path", "key": "path", "value": "%7C%7B%2B-0p", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] } ] }, { "name": "Electricity Production Plants", "description": "", "item": [ { "name": "Get combined building and electricity production plants data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/electricity-plants", "query": [ { "key": "plant_type", "value": "photovoltaic", "description": "Optional filter by plant type (photovoltaic, hydro, wind, biomass, etc.).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/electricity-plants?plant_type=photovoltaic", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get electricity production plants for a building by EGID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/electricity-plants", "query": [ { "key": "egid", "value": "123456", "description": "Building EGID.", "disabled": false }, { "key": "plant_type", "value": "photovoltaic", "description": "Optional filter by plant type (photovoltaic, hydro, wind, biomass, etc.).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/electricity-plants?egid=123456&plant_type=photovoltaic" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Search electricity production plants by location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/electricity-plants\/search", "query": [ { "key": "municipality", "value": "Z%C3%BCrich", "description": "Municipality name.", "disabled": false }, { "key": "post_code", "value": "8001", "description": "Postal code.", "disabled": false }, { "key": "bfs_number", "value": "261", "description": "BFS municipality number.", "disabled": false }, { "key": "plant_type", "value": "photovoltaic", "description": "Optional filter by plant type (photovoltaic, hydro, wind, biomass, etc.).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/electricity-plants\/search?municipality=Z%C3%BCrich&post_code=8001&bfs_number=261&plant_type=photovoltaic" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get specific electricity production plant by XTF-ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/electricity-plants\/:xtf_id", "query": [], "raw": "{{baseUrl}}\/api\/electricity-plants\/:xtf_id", "variable": [ { "id": "xtf_id", "key": "xtf_id", "value": "ch.bfe.epa.123456", "description": "XTF-ID of the plant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get electricity production plant statistics for a municipality", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/municipalities\/:bfs_number\/electricity-plant-statistics", "query": [ { "key": "plant_type", "value": "photovoltaic", "description": "Optional filter by plant type (photovoltaic, hydro, wind, biomass, etc.).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/municipalities\/:bfs_number\/electricity-plant-statistics?plant_type=photovoltaic", "variable": [ { "id": "bfs_number", "key": "bfs_number", "value": "261", "description": "BFS municipality number." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] } ] }, { "name": "Municipality Enrichment", "description": "", "item": [ { "name": "Enrich all buildings in a municipality.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/municipalities\/:bfs_number\/enrich", "query": [], "raw": "{{baseUrl}}\/api\/municipalities\/:bfs_number\/enrich", "variable": [ { "id": "bfs_number", "key": "bfs_number", "value": "261", "description": "Municipality BFS number." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"force\":false}" }, "description": "Triggers a background job that enriches building data including:\n- WGS84 coordinates (converted from CH1903+)\n- BDEW consumption profiles\n- Municipality names\n- Address data (via OSB API)" }, "response": [] }, { "name": "Get the status of a municipality enrichment batch.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/municipalities\/:bfs_number\/enrichment-status\/:batch_id", "query": [], "raw": "{{baseUrl}}\/api\/municipalities\/:bfs_number\/enrichment-status\/:batch_id", "variable": [ { "id": "bfs_number", "key": "bfs_number", "value": "261", "description": "Municipality BFS number." }, { "id": "batch_id", "key": "batch_id", "value": "9d4f8a3c-1b2e-4f5a-8c3d-9a7b6e4f2c1d", "description": "Batch ID from enrich response." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] } ] }, { "name": "PV Multi-Roof Configuration", "description": "", "item": [ { "name": "List available PV roof and facade surfaces for a building", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/pv-roofs", "query": [], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/pv-roofs", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "List all PV multi-roof configurations for a building", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/pv-multi-roof-configurations", "query": [ { "key": "status", "value": "architecto", "description": "Filter by status (draft, calculating, completed, failed)", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/pv-multi-roof-configurations?status=architecto&per_page=20", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Create or update a PV multi-roof configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/pv-multi-roof-configurations", "query": [], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/pv-multi-roof-configurations", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"name\":\"Main PV System\",\"description\":\"Eius et animi quos velit et.\",\"status\":\"draft\",\"surfaces\":[\"architecto\"]}" }, "description": "" }, "response": [] }, { "name": "Get a specific PV multi-roof configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/pv-multi-roof-configurations\/:configId", "query": [ { "key": "lang", "value": "de", "description": "Language code (de, fr, it).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/pv-multi-roof-configurations\/:configId?lang=de", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." }, { "id": "configId", "key": "configId", "value": "1", "description": "Configuration ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] }, { "name": "Get production profile for a specific configuration and year", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/buildings\/:egid\/pv-multi-roof-configurations\/:configId\/profiles\/:year", "query": [], "raw": "{{baseUrl}}\/api\/buildings\/:egid\/pv-multi-roof-configurations\/:configId\/profiles\/:year", "variable": [ { "id": "egid", "key": "egid", "value": "123456", "description": "Building EGID." }, { "id": "configId", "key": "configId", "value": "1", "description": "Configuration ID." }, { "id": "year", "key": "year", "value": "2025", "description": "Year." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Supports both TMY (Typical Meteorological Year) profiles and year-specific profiles.\nFor TMY profiles, the data is mapped to the requested year's calendar." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=(self)" }, { "key": "access-control-allow-origin", "value": "https:\/\/gwr-datahub.ecolabor.ch" }, { "key": "access-control-expose-headers", "value": "X-Datahub-Proxy, X-Datahub-Proxy-Version" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\",\"code\":\"unauthenticated\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }