{ "openapi": "3.0.1", "info": { "title": "France Road Transport Companies: Hauliers, Coaches, Forwarders", "description": "All French road transport companies from the official national registers: goods hauliers, coach/bus/taxi operators and freight forwarders. SIRET, legal form, city, domestic and EU licences, fleet size (licence copies), expiry dates. Alert mode. Pay per company.", "version": "1.0", "x-build-id": "yAWib8c0FpHJ5ehte" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~france-road-transport-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-france-road-transport-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/datacraft-studio~france-road-transport-companies/runs": { "post": { "operationId": "runs-sync-datacraft-studio-france-road-transport-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/datacraft-studio~france-road-transport-companies/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-france-road-transport-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": { "registers": { "title": "Registers", "type": "array", "description": "Which official registers to search. Leave empty for all three.", "items": { "type": "string", "enum": [ "goods", "passengers", "freight_forwarder" ], "enumTitles": [ "Goods hauliers (marchandises)", "Passenger carriers: coach, bus, taxi (voyageurs)", "Freight forwarders (commissionnaires de transport)" ] } }, "sirens": { "title": "SIREN or SIRET numbers", "type": "array", "description": "Check specific companies (9-digit SIREN) or establishments (14-digit SIRET), e.g. to verify that a carrier holds a valid licence. Leave empty to search with the filters below.", "items": { "type": "string" } }, "nameContains": { "title": "Company name contains", "type": "string", "description": "Case- and accent-insensitive, e.g. transports or geodis." }, "departments": { "title": "Departments", "type": "array", "description": "Department codes of the establishment, e.g. 75, 69, 2A, 974.", "items": { "type": "string" } }, "postalCodePrefixes": { "title": "Postal code prefixes", "type": "array", "description": "e.g. 690 or 13127.", "items": { "type": "string" } }, "minLicenceCopies": { "title": "Minimum licence copies (fleet size)", "minimum": 0, "type": "integer", "description": "One certified copy of a licence is needed per vehicle in use, so the number of valid copies is a good proxy for fleet size. Company-wide figure, repeated on each establishment. Goods and passenger registers only." }, "maxLicenceCopies": { "title": "Maximum licence copies (fleet size)", "minimum": 0, "type": "integer", "description": "e.g. 5 to target small fleets." }, "onlyCommunityLicence": { "title": "Only companies with an EU (community) licence", "type": "boolean", "description": "Carriers allowed to work internationally in the EU.", "default": false }, "onlyWithLightVans": { "title": "Only goods carriers with light van copies (≤ 3.5 t)", "type": "boolean", "description": "Companies holding EU licence copies for vans up to 3.5 tonnes (last-mile and express delivery).", "default": false }, "licensedSince": { "title": "Licence valid from (on or after)", "type": "string", "description": "YYYY-MM-DD. Keeps companies whose current licence started on or after this date: new carriers and recent renewals." }, "licenceExpiresBefore": { "title": "Licence expires before", "type": "string", "description": "YYYY-MM-DD. Keeps companies with a licence ending before this date." }, "headOfficesOnly": { "title": "Head offices only", "type": "boolean", "description": "Skip secondary establishments.", "default": false }, "onePerCompany": { "title": "One row per company", "type": "boolean", "description": "Keep one establishment per SIREN and register (the head office when listed).", "default": false }, "includePublicBodies": { "title": "Include public bodies", "type": "boolean", "description": "Municipalities, inter-municipal unions and public companies running their own transport.", "default": true }, "onlyNew": { "title": "Alert mode: only new or changed entries", "type": "boolean", "description": "Remembers what earlier runs delivered and only returns new establishments or changed licences (copies, dates). Schedule it weekly for fresh leads. The register is updated on Mondays and Thursdays.", "default": false }, "stateStoreName": { "title": "Alert mode memory name", "type": "string", "description": "Use a different name for each saved search in alert mode.", "default": "france-road-transport-companies-state" }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Maximum number of companies delivered (and charged). 0 means no limit. Results are sorted by fleet size, largest first.", "default": 1000 } } }, "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 } } } } } } } } } }