{ "openapi": "3.0.1", "info": { "title": "French RGE Renovation Companies", "description": "List French companies holding the RGE label (energy renovation, heat pumps, insulation, solar). Filter by department, NAF code and size. Official open data.", "version": "0.0", "x-build-id": "cFbHB2OP80owUPlbe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mcmh_data~french-rge-eco-renovation-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mcmh_data-french-rge-eco-renovation-companies", "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/mcmh_data~french-rge-eco-renovation-companies/runs": { "post": { "operationId": "runs-sync-mcmh_data-french-rge-eco-renovation-companies", "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/mcmh_data~french-rge-eco-renovation-companies/run-sync": { "post": { "operationId": "run-sync-mcmh_data-french-rge-eco-renovation-companies", "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": { "query": { "title": "Text query", "type": "string", "description": "Company name, address, executive name, or an exact SIREN/SIRET number." }, "nafCodes": { "title": "Activity codes (NAF/APE)", "type": "array", "description": "Examples: 62.01Z (software), 86.23Z (dental practices), 10.71C (bakeries). One search is run per code so results are not capped at 10,000.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Examples: 69, 01, 2A, 971. One search is run per department.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Examples: 69001, 01090.", "items": { "type": "string" } }, "categories": { "title": "Company size category", "type": "array", "description": "PME (small and medium), ETI (mid-size), GE (large).", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ] } }, "workforceBrackets": { "title": "Workforce brackets", "type": "array", "description": "Sirene workforce codes: 00 (0), 01 (1-2), 02 (3-5), 03 (6-9), 11 (10-19), 12 (20-49), 21 (50-99), 22 (100-199), 31 (200-249), 32 (250-499), 41 (500-999), 42 (1000-1999), 51 (2000-4999), 52 (5000-9999), 53 (10000+).", "items": { "type": "string" } }, "legalForms": { "title": "Legal form codes", "type": "array", "description": "INSEE legal category codes, for example 5710 (SAS), 5499 (SARL), 1000 (sole trader).", "items": { "type": "string" } }, "minRevenue": { "title": "Minimum revenue (EUR)", "type": "integer", "description": "Only companies whose last published revenue is at least this amount." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "type": "integer", "description": "Only companies whose last published revenue is at most this amount." }, "excludeSoleTraders": { "title": "Exclude sole traders", "type": "boolean", "description": "Remove individual entrepreneurs (entrepreneur individuel).", "default": false }, "includeInactive": { "title": "Include closed companies", "type": "boolean", "description": "By default only active companies are returned.", "default": false }, "includeExecutives": { "title": "Include executives", "type": "boolean", "description": "Adds the names and roles of registered executives. Personal data: use it only for a lawful purpose (see README).", "default": false }, "maxResults": { "title": "Maximum number of companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper bound on companies returned (you are charged per company returned).", "default": 100 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }