{ "openapi": "3.0.1", "info": { "title": "SyndicData API", "description": "Professional API for Belgian VME discovery, syndic market data, stats, exports, and integration workflows.", "version": "v1" }, "servers": [ { "url": "/" } ], "paths": { "/api/feedback": { "post": { "tags": [ "SyndicData" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFeedbackPayload" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/stripe/webhook": { "post": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/account/syndic/{enterpriseNumber}/logo": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "logo": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "returnUrl": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/account/syndic/{enterpriseNumber}/logo/remove": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/profile-unlocks/{enterpriseNumber}": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "returnUrl": { "type": "string" } } }, { "type": "object", "properties": { "source": { "type": "string" } } } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "returnUrl": { "type": "string" } } }, { "type": "object", "properties": { "source": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/watchlist/{entityType}/{entityKey}": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/watchlist/{entityType}/{entityKey}/remove": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/packages/{purchaseId}/regional-export": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "purchaseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "region": { "type": "string" } } }, { "type": "object", "properties": { "returnUrl": { "type": "string" } } } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "region": { "type": "string" } } }, { "type": "object", "properties": { "returnUrl": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/packages/{purchaseId}/vme-deep-dive": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "purchaseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "enterpriseNumber": { "type": "string" } } }, { "type": "object", "properties": { "returnUrl": { "type": "string" } } } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "enterpriseNumber": { "type": "string" } } }, { "type": "object", "properties": { "returnUrl": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/map/vme-points": { "get": { "tags": [ "Map" ], "summary": "Get map points", "description": "Returns map-ready VME and syndic points, optionally filtered by syndic, focus VME, or category.", "operationId": "GetMapPoints", "parameters": [ { "name": "syndicNumber", "in": "query", "schema": { "type": "string" } }, { "name": "focusVme", "in": "query", "schema": { "type": "string" } }, { "name": "categories", "in": "query", "schema": { "type": "string" } }, { "name": "south", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "west", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "north", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "east", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "zoom", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeVmes", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/map/property-insights": { "get": { "tags": [ "Map" ], "summary": "Get property insight map points", "description": "Returns map-ready multi-unit property points and aggregates, including known VME markers and likely opportunities.", "operationId": "GetPropertyInsightMapPoints", "parameters": [ { "name": "south", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "west", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "north", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "east", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "zoom", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/exports/checkout": { "post": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/exports/d/{token}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/exports/preview/{municipalityKey}.xlsx": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "municipalityKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/export/file/{id}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/streetview/{enterpriseNumber}": { "get": { "tags": [ "Media" ], "summary": "Get cached Street View image", "description": "Returns a cached or freshly fetched Street View image for a VME address.", "operationId": "GetStreetView", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/digest/unsubscribe/{token}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/search/suggestions": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/locations/suggestions": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/leads/{leadId}": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "leadId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/set-culture": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/search-vme": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/search-syndics": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/vme/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/acp/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/hoa/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/syndic/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/syndicus/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/property-manager/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/robots.txt": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemap.xml": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public.xml": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public-nl.xml": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public-fr.xml": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public-en.xml": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public-{culture}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/public/{culture}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/public-{culture}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/vmes-{culture}-{page}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/vmes-{page}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/syndics-{culture}-{page}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/sitemaps/syndics-{page}.xml": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/whoami": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-cbso-annual-accounts": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/stripe-bootstrap": { "post": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-cbso-annual-accounts/{enterpriseNumber}": { "get": { "tags": [ "SyndicData" ], "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-vlaamse-vergunningen": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-cadastral-geodata": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-cadastral-parcels": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-cadastral-buildings": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-building-units": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/rebuild-property-insights": { "post": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/rematch-vlaamse-vergunningen": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/import-power-outages": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/exports/rebuild": { "post": { "tags": [ "SyndicData" ], "parameters": [ { "name": "family", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/jobs/status": { "get": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } }, "/api/vme": { "get": { "tags": [ "VME" ], "summary": "Search VMEs", "description": "Searches Belgian VMEs by query, region, and postal code with pagination.", "operationId": "SearchVmes", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/vme/{enterpriseNumber}": { "get": { "tags": [ "VME" ], "summary": "Get VME details", "description": "Returns a single VME profile by enterprise number.", "operationId": "GetVmeByEnterpriseNumber", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VmeSummary" } } } }, "404": { "description": "Not Found" } } } }, "/api/vme/{enterpriseNumber}/coordinates": { "post": { "tags": [ "VME" ], "summary": "Retired VME coordinate update endpoint", "description": "Coordinates are now maintained by Argus and are read-only in SyndicData.", "operationId": "UpdateVmeCoordinates", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoordinateUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/v1/vme": { "get": { "tags": [ "VME" ], "summary": "Search VMEs", "description": "Searches Belgian VMEs by query, region, and postal code with pagination.", "operationId": "V1SearchVmes", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/vme/{enterpriseNumber}": { "get": { "tags": [ "VME" ], "summary": "Get VME details", "description": "Returns a single VME profile by enterprise number.", "operationId": "V1GetVmeByEnterpriseNumber", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VmeSummary" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/vme/{enterpriseNumber}/coordinates": { "post": { "tags": [ "VME" ], "summary": "Retired VME coordinate update endpoint", "description": "Coordinates are now maintained by Argus and are read-only in SyndicData.", "operationId": "V1UpdateVmeCoordinates", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoordinateUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/syndics": { "get": { "tags": [ "Syndic" ], "summary": "Search syndics", "description": "Searches professional or personal syndics by name, region, and portfolio size.", "operationId": "SearchSyndics", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "minVme", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxVme", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/syndics/{enterpriseNumber}": { "get": { "tags": [ "Syndic" ], "summary": "Get syndic details", "description": "Returns a syndic profile by enterprise number, including consolidation data.", "operationId": "GetSyndicByEnterpriseNumber", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyndicSummary" } } } }, "404": { "description": "Not Found" } } } }, "/api/syndics/{enterpriseNumber}/portfolio": { "get": { "tags": [ "Syndic" ], "summary": "Get syndic portfolio", "description": "Returns the VMEs currently managed by a syndic, including inherited portfolio items.", "operationId": "GetSyndicPortfolio", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VmeSummary" } } } } } } } }, "/api/syndics/top/{count}": { "get": { "tags": [ "Syndic" ], "summary": "Get top syndics", "description": "Returns the top syndic rankings by managed VME count.", "operationId": "GetTopSyndics", "parameters": [ { "name": "count", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyndicSummary" } } } } } } } }, "/api/v1/syndics": { "get": { "tags": [ "Syndic" ], "summary": "Search syndics", "description": "Searches professional or personal syndics by name, region, and portfolio size.", "operationId": "V1SearchSyndics", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "minVme", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxVme", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/syndics/{enterpriseNumber}": { "get": { "tags": [ "Syndic" ], "summary": "Get syndic details", "description": "Returns a syndic profile by enterprise number, including consolidation data.", "operationId": "V1GetSyndicByEnterpriseNumber", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyndicSummary" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/syndics/{enterpriseNumber}/portfolio": { "get": { "tags": [ "Syndic" ], "summary": "Get syndic portfolio", "description": "Returns the VMEs currently managed by a syndic, including inherited portfolio items.", "operationId": "V1GetSyndicPortfolio", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VmeSummary" } } } } } } } }, "/api/v1/syndics/top/{count}": { "get": { "tags": [ "Syndic" ], "summary": "Get top syndics", "description": "Returns the top syndic rankings by managed VME count.", "operationId": "V1GetTopSyndics", "parameters": [ { "name": "count", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyndicSummary" } } } } } } } }, "/api/stats/overview/live": { "get": { "tags": [ "Stats" ], "summary": "Get live overview stats", "description": "Returns the live counts of VMEs, professional syndics, personal syndics, and known links.", "operationId": "GetLiveOverviewStats", "responses": { "200": { "description": "OK" } } } }, "/api/stats/overview": { "get": { "tags": [ "Stats" ], "summary": "Get computed overview stats", "description": "Returns the latest computed market statistics, or falls back to live counts when unavailable.", "operationId": "GetOverviewStats", "responses": { "200": { "description": "OK" } } } }, "/api/v1/stats/overview/live": { "get": { "tags": [ "Stats" ], "summary": "Get live overview stats", "description": "Returns the live counts of VMEs, professional syndics, personal syndics, and known links.", "operationId": "V1GetLiveOverviewStats", "responses": { "200": { "description": "OK" } } } }, "/api/v1/stats/overview": { "get": { "tags": [ "Stats" ], "summary": "Get computed overview stats", "description": "Returns the latest computed market statistics, or falls back to live counts when unavailable.", "operationId": "V1GetOverviewStats", "responses": { "200": { "description": "OK" } } } }, "/api/power-outage/vme-impact": { "get": { "tags": [ "Power outage" ], "summary": "Get live power-outage impact on VMEs", "description": "Returns the current number of active Argus power outages and matched impacted VMEs.", "operationId": "GetPowerOutageVmeImpact", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOutageImpactSummary" } } } } } } }, "/api/power-outage/impacted-vmes": { "get": { "tags": [ "Power outage" ], "summary": "Get VMEs currently impacted by a power outage", "description": "Returns a paginated list of VMEs matched to active power outages.", "operationId": "GetPowerOutageImpactedVmes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOutageImpactedVmeList" } } } } } } }, "/api/power-outage/impacted-vmes-map": { "get": { "tags": [ "Power outage" ], "summary": "Get impacted VMEs with coordinates for map rendering", "description": "Returns lat/lon-stamped VME impact points. ActiveNow takes precedence, then FuturePlanned, then Past24Hours.", "operationId": "GetPowerOutageImpactedVmesMap", "responses": { "200": { "description": "OK" } } } }, "/api/v1/power-outage/vme-impact": { "get": { "tags": [ "Power outage" ], "summary": "Get live power-outage impact on VMEs", "description": "Returns the current number of active Argus power outages and matched impacted VMEs.", "operationId": "V1GetPowerOutageVmeImpact", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOutageImpactSummary" } } } } } } }, "/api/v1/power-outage/impacted-vmes": { "get": { "tags": [ "Power outage" ], "summary": "Get VMEs currently impacted by a power outage", "description": "Returns a paginated list of VMEs matched to active power outages.", "operationId": "V1GetPowerOutageImpactedVmes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOutageImpactedVmeList" } } } } } } }, "/api/v1/power-outage/impacted-vmes-map": { "get": { "tags": [ "Power outage" ], "summary": "Get impacted VMEs with coordinates for map rendering", "description": "Returns lat/lon-stamped VME impact points. ActiveNow takes precedence, then FuturePlanned, then Past24Hours.", "operationId": "V1GetPowerOutageImpactedVmesMap", "responses": { "200": { "description": "OK" } } } }, "/api/public-works/vme-impact": { "get": { "tags": [ "Public works" ], "summary": "Get live public-works impact on VMEs", "description": "Returns the current number of active GIPOD public-works events and matched impacted VMEs.", "operationId": "GetPublicWorksVmeImpact", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorksImpactSummary" } } } } } } }, "/api/public-works/impacted-vmes": { "get": { "tags": [ "Public works" ], "summary": "Get VMEs currently impacted by public works", "description": "Returns a paginated list of VMEs matched to active public-works events.", "operationId": "GetPublicWorksImpactedVmes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorksImpactedVmeList" } } } } } } }, "/api/public-works/impacted-vmes-map": { "get": { "tags": [ "Public works" ], "summary": "Get impacted VMEs with coordinates for map rendering", "description": "Returns lat/lon-stamped VME impact points for GIPOD public-works events. ActiveNow takes precedence, then FuturePlanned, then Past24Hours.", "operationId": "GetPublicWorksImpactedVmesMap", "responses": { "200": { "description": "OK" } } } }, "/api/v1/public-works/vme-impact": { "get": { "tags": [ "Public works" ], "summary": "Get live public-works impact on VMEs", "description": "Returns the current number of active GIPOD public-works events and matched impacted VMEs.", "operationId": "V1GetPublicWorksVmeImpact", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorksImpactSummary" } } } } } } }, "/api/v1/public-works/impacted-vmes": { "get": { "tags": [ "Public works" ], "summary": "Get VMEs currently impacted by public works", "description": "Returns a paginated list of VMEs matched to active public-works events.", "operationId": "V1GetPublicWorksImpactedVmes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorksImpactedVmeList" } } } } } } }, "/api/v1/public-works/impacted-vmes-map": { "get": { "tags": [ "Public works" ], "summary": "Get impacted VMEs with coordinates for map rendering", "description": "Returns lat/lon-stamped VME impact points for GIPOD public-works events. ActiveNow takes precedence, then FuturePlanned, then Past24Hours.", "operationId": "V1GetPublicWorksImpactedVmesMap", "responses": { "200": { "description": "OK" } } } }, "/api/export/catalog": { "get": { "tags": [ "Export" ], "responses": { "200": { "description": "OK" } } } }, "/api/export/family/{family}": { "get": { "tags": [ "Export" ], "parameters": [ { "name": "family", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/financials/{enterpriseNumber}": { "get": { "tags": [ "Financials" ], "summary": "Get annual accounts for an enterprise", "description": "Returns parsed NBB CBSO filings (one per year) with KPIs and attachment metadata.", "operationId": "GetAnnualAccounts", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/financials/attachments/{id}": { "get": { "tags": [ "Financials" ], "summary": "Download an attachment", "description": "Streams an embedded document (PDF, image, ...) extracted from an XBRL filing.", "operationId": "DownloadAnnualAccountAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/api/v1/financials/{enterpriseNumber}": { "get": { "tags": [ "Financials" ], "summary": "Get annual accounts for an enterprise", "description": "Returns parsed NBB CBSO filings (one per year) with KPIs and attachment metadata.", "operationId": "V1GetAnnualAccounts", "parameters": [ { "name": "enterpriseNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/financials/attachments/{id}": { "get": { "tags": [ "Financials" ], "summary": "Download an attachment", "description": "Streams an embedded document (PDF, image, ...) extracted from an XBRL filing.", "operationId": "V1DownloadAnnualAccountAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/api/export/vme": { "get": { "tags": [ "Export" ], "summary": "Retired — see /exports.", "operationId": "ExportVmesLegacy", "responses": { "200": { "description": "OK" } } } }, "/api/export/syndics": { "get": { "tags": [ "Export" ], "summary": "Retired — see /exports.", "operationId": "ExportSyndicsLegacy", "responses": { "200": { "description": "OK" } } } }, "/api/export/leads": { "get": { "tags": [ "Export" ], "summary": "Export saved leads as CSV or Excel", "description": "Exports the authenticated user's saved leads as CSV or Excel (XLSX).", "operationId": "ExportLeads", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "entityType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" } } } }, "/api/export/prospecting/switches": { "get": { "tags": [ "Export" ], "summary": "Export syndic switch prospects as CSV or Excel", "description": "Exports the full filtered list of detected syndic mandate switches as a CRM-ready prospecting file (Professional+).", "operationId": "ExportSwitchProspects", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden" } } } }, "/api/export/prospecting/mandate-expiries": { "get": { "tags": [ "Export" ], "summary": "Export upcoming mandate-expiry prospects as CSV or Excel", "description": "Exports the full filtered list of upcoming syndic mandate expiries as a CRM-ready prospecting file (Professional+).", "operationId": "ExportMandateExpiryProspects", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden" } } } }, "/api/export/prospecting/unmanaged-vmes": { "get": { "tags": [ "Export" ], "summary": "Export VMEs without a published syndic as CSV or Excel", "description": "Exports the full list of active VMEs with no published syndic — prime acquisition prospects — as a CRM-ready file (Professional+).", "operationId": "ExportUnmanagedVmeProspects", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden" } } } }, "/api/export/prospecting/new-vmes": { "get": { "tags": [ "Export" ], "summary": "Export newly registered VMEs as CSV or Excel", "description": "Exports the full list of recently registered VMEs (new buildings that still need a syndic) as a CRM-ready prospecting file (Professional+).", "operationId": "ExportNewVmeProspects", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden" } } } }, "/api/export/syndic-portfolio": { "get": { "tags": [ "Export" ], "summary": "Export a syndic's full VME portfolio as CSV or Excel", "description": "Exports the complete VME portfolio of a single syndic — competitive intelligence for due-diligence and acquisition analysis (Professional+).", "operationId": "ExportSyndicPortfolio", "parameters": [ { "name": "syndicNumber", "in": "query", "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden" } } } }, "/Account/Logout": { "post": { "tags": [ "SyndicData" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "returnUrl" ], "type": "object", "properties": { "returnUrl": { "type": "string" } } } }, "application/x-www-form-urlencoded": { "schema": { "required": [ "returnUrl" ], "type": "object", "properties": { "returnUrl": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/Account/Manage/DownloadPersonalData": { "post": { "tags": [ "SyndicData" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "CoordinateUpdate": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } }, "EnterpriseLink": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sourceEnterpriseNumber": { "type": "string" }, "targetEnterpriseNumber": { "type": "string" }, "linkType": { "type": "string" }, "effectiveSince": { "type": "string", "format": "date", "nullable": true }, "sourceName": { "type": "string", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "rawText": { "type": "string", "nullable": true }, "observedAtUtc": { "type": "string", "format": "date-time" } } }, "IFormFile": { "type": "string", "format": "binary" }, "LeadUpdateRequest": { "required": [ "status", "notes" ], "type": "object", "properties": { "status": { "type": "string" }, "notes": { "type": "string", "nullable": true } } }, "PowerOutageCityImpact": { "required": [ "city", "activeOutageCount", "impactedVmeCount" ], "type": "object", "properties": { "city": { "type": "string" }, "activeOutageCount": { "type": "integer", "format": "int32" }, "impactedVmeCount": { "type": "integer", "format": "int32" } } }, "PowerOutageImpactedVmeList": { "required": [ "total", "page", "pageSize", "items" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PowerOutageImpactedVmeListItem" } } } }, "PowerOutageImpactedVmeListItem": { "required": [ "vmeEnterpriseNumber", "vmeName", "street", "zipCode", "city", "activeOutageCount", "impactWindow", "primaryOutageId", "dso", "planned", "startAt", "endAt", "impactedClients", "cause", "updatedAtUtc" ], "type": "object", "properties": { "vmeEnterpriseNumber": { "type": "string" }, "vmeName": { "type": "string" }, "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "activeOutageCount": { "type": "integer", "format": "int32" }, "impactWindow": { "$ref": "#/components/schemas/PowerOutageImpactWindow" }, "primaryOutageId": { "type": "string" }, "dso": { "type": "string" }, "planned": { "type": "boolean", "nullable": true }, "startAt": { "type": "string", "format": "date-time", "nullable": true }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "impactedClients": { "type": "integer", "format": "int32", "nullable": true }, "cause": { "type": "string", "nullable": true }, "updatedAtUtc": { "type": "string", "format": "date-time" } } }, "PowerOutageImpactSummary": { "required": [ "activeOutageCount", "impactedVmeCount", "futurePlannedVmeCount", "past24HoursVmeCount", "updatedAtUtc", "topCities" ], "type": "object", "properties": { "activeOutageCount": { "type": "integer", "format": "int32" }, "impactedVmeCount": { "type": "integer", "format": "int32" }, "futurePlannedVmeCount": { "type": "integer", "format": "int32" }, "past24HoursVmeCount": { "type": "integer", "format": "int32" }, "updatedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "topCities": { "type": "array", "items": { "$ref": "#/components/schemas/PowerOutageCityImpact" } } } }, "PowerOutageImpactWindow": { "type": "integer" }, "PublicWorksCityImpact": { "required": [ "city", "activeEventCount", "impactedVmeCount" ], "type": "object", "properties": { "city": { "type": "string" }, "activeEventCount": { "type": "integer", "format": "int32" }, "impactedVmeCount": { "type": "integer", "format": "int32" } } }, "PublicWorksImpactedVmeList": { "required": [ "total", "page", "pageSize", "items" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorksImpactedVmeListItem" } } } }, "PublicWorksImpactedVmeListItem": { "required": [ "vmeEnterpriseNumber", "vmeName", "street", "zipCode", "city", "activeEventCount", "impactWindow", "primaryGipodId", "eventType", "severeHindrance", "startAt", "endAt", "updatedAtUtc" ], "type": "object", "properties": { "vmeEnterpriseNumber": { "type": "string" }, "vmeName": { "type": "string" }, "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "activeEventCount": { "type": "integer", "format": "int32" }, "impactWindow": { "$ref": "#/components/schemas/PublicWorksImpactWindow" }, "primaryGipodId": { "type": "string" }, "eventType": { "type": "string" }, "severeHindrance": { "type": "boolean", "nullable": true }, "startAt": { "type": "string", "format": "date-time", "nullable": true }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAtUtc": { "type": "string", "format": "date-time" } } }, "PublicWorksImpactSummary": { "required": [ "activeEventCount", "impactedVmeCount", "futurePlannedVmeCount", "past24HoursVmeCount", "updatedAtUtc", "topCities" ], "type": "object", "properties": { "activeEventCount": { "type": "integer", "format": "int32" }, "impactedVmeCount": { "type": "integer", "format": "int32" }, "futurePlannedVmeCount": { "type": "integer", "format": "int32" }, "past24HoursVmeCount": { "type": "integer", "format": "int32" }, "updatedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "topCities": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorksCityImpact" } } } }, "PublicWorksImpactWindow": { "type": "integer" }, "SyndicLocationSummary": { "type": "object", "properties": { "establishmentNumber": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "typeOfAddress": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string" }, "isRegisteredOffice": { "type": "boolean" }, "shortLabel": { "type": "string", "nullable": true }, "addressLine": { "type": "string", "nullable": true } } }, "SyndicSummary": { "type": "object", "properties": { "enterpriseNumber": { "type": "string" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "isPersonalSyndic": { "type": "boolean" }, "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/SyndicLocationSummary" } }, "activeRegions": { "type": "array", "items": { "type": "string" } }, "vmeCount": { "type": "integer", "format": "int32" }, "aggregatedVmeCount": { "type": "integer", "format": "int32" }, "directVmeCount": { "type": "integer", "format": "int32" }, "inheritedVmeCount": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "phones": { "type": "array", "items": { "type": "string" } }, "emails": { "type": "array", "items": { "type": "string" } }, "websites": { "type": "array", "items": { "type": "string" } }, "hasVerifiedClaim": { "type": "boolean" }, "logoUrl": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "pricingGuideMarkdown": { "type": "string", "nullable": true }, "salesPitchMarkdown": { "type": "string", "nullable": true }, "serviceRegions": { "type": "string", "nullable": true }, "consolidationParentNumber": { "type": "string", "nullable": true }, "consolidationParentName": { "type": "string", "nullable": true }, "absorbedNumbers": { "type": "array", "items": { "type": "string" } }, "absorbedLinks": { "type": "array", "items": { "$ref": "#/components/schemas/EnterpriseLink" } }, "portfolio": { "type": "array", "items": { "$ref": "#/components/schemas/VmeSummary" } }, "locationLabel": { "type": "string", "nullable": true } } }, "UserFeedbackPayload": { "required": [ "message", "category", "pagePath", "contextJson", "email" ], "type": "object", "properties": { "message": { "type": "string" }, "category": { "type": "string", "nullable": true }, "pagePath": { "type": "string", "nullable": true }, "contextJson": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "VmeSummary": { "type": "object", "properties": { "enterpriseNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string" }, "syndicEnterpriseNumber": { "type": "string", "nullable": true }, "syndicName": { "type": "string", "nullable": true }, "isPersonalSyndic": { "type": "boolean" }, "syndicAppointedSince": { "type": "string", "format": "date", "nullable": true }, "originalSyndicNumber": { "type": "string", "nullable": true }, "originalSyndicName": { "type": "string", "nullable": true }, "isInherited": { "type": "boolean" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true } } } }, "securitySchemes": { "SyndicDataApiKey": { "type": "http", "description": "Create an API key at /account/api-keys and send it as Authorization: Bearer sd_live_...", "scheme": "bearer", "bearerFormat": "SyndicData API key" } } }, "security": [ { "SyndicDataApiKey": [ ] } ], "tags": [ { "name": "SyndicData" }, { "name": "Map" }, { "name": "Media" }, { "name": "VME" }, { "name": "Syndic" }, { "name": "Stats" }, { "name": "Power outage" }, { "name": "Public works" }, { "name": "Export" }, { "name": "Financials" } ] }