{ "openapi": "3.0.1", "info": { "title": "New French Building Permits Finder (SITADEL)", "description": "Find newly authorized French building permits (permis de construire, DP, PA, PD) from the official SITADEL database. Filter by department, commune, date, dwellings. Get project, address and company applicant SIREN/SIRET for BTP lead generation.", "version": "0.0", "x-build-id": "NeW5eTVgQQHJ7996I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fit_melon~new-french-building-permits-finder-sitadel/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fit_melon-new-french-building-permits-finder-sitadel", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/fit_melon~new-french-building-permits-finder-sitadel/runs": { "post": { "operationId": "runs-sync-fit_melon-new-french-building-permits-finder-sitadel", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/fit_melon~new-french-building-permits-finder-sitadel/run-sync": { "post": { "operationId": "run-sync-fit_melon-new-french-building-permits-finder-sitadel", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "permitTypes": { "title": "Permit types", "type": "array", "description": "Which SITADEL lists to search: `housing` (building permits & prior declarations creating dwellings), `nonResidential` (offices, shops, warehouses, industry…), `development` (permis d'aménager), `demolition` (permis de démolir).", "items": { "type": "string", "enum": [ "housing", "nonResidential", "development", "demolition" ], "enumTitles": [ "Housing (PC/DP logements)", "Non-residential (PC/DP locaux)", "Development (PA)", "Demolition (PD)" ] } }, "departments": { "title": "Department codes", "type": "array", "description": "French department codes to filter on (e.g. 59, 75, 2A, 971). Leave empty to search all of France.", "items": { "type": "string" } }, "communes": { "title": "INSEE commune codes", "type": "array", "description": "Optional INSEE commune codes (e.g. 59350 for Lille). Narrower than departments.", "items": { "type": "string" } }, "monthsBack": { "title": "Months back", "minimum": 1, "maximum": 120, "type": "integer", "description": "Rolling window: only permits authorized in the last N months. Ignored if 'Authorized after' is set.", "default": 3 }, "authorizedAfter": { "title": "Authorized after (YYYY-MM-DD)", "type": "string", "description": "Only permits with a real authorization date on or after this ISO date. Overrides 'Months back'." }, "authorizedBefore": { "title": "Authorized before (YYYY-MM-DD)", "type": "string", "description": "Optional upper bound on the real authorization date (ISO format)." }, "minDwellings": { "title": "Minimum dwellings created", "minimum": 1, "type": "integer", "description": "Housing list only: keep permits creating at least this many dwellings (spot real estate developments)." }, "companiesOnly": { "title": "Companies only (B2B leads)", "type": "boolean", "description": "Keep only permits filed by a legal entity (personne morale) — the output then includes the applicant's SIREN/SIRET, name and APE code, ready for enrichment.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of permit items pushed to the dataset (across all selected types).", "default": 200 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }