{ "openapi": "3.0.1", "info": { "title": "France Restaurant Hygiene Ratings API (Alim'confiance)", "description": "Official hygiene inspection results of French restaurants, bakeries, butchers and food plants (Alim'confiance): rating, date, SIRET, address and GPS. Filter by rating, activity and area, or get daily alerts on new inspections.", "version": "1.0", "x-build-id": "XQQ9mykNo7FgJsuLq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jet_mythology~france-food-hygiene-inspections/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jet_mythology-france-food-hygiene-inspections", "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/jet_mythology~france-food-hygiene-inspections/runs": { "post": { "operationId": "runs-sync-jet_mythology-france-food-hygiene-inspections", "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/jet_mythology~france-food-hygiene-inspections/run-sync": { "post": { "operationId": "run-sync-jet_mythology-france-food-hygiene-inspections", "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": { "lastNDays": { "title": "Inspections of the last N days", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Time window. Ignored if 'Inspected since' is set. The official dataset covers roughly the last 12 months.", "default": 90 }, "inspectedSince": { "title": "Inspected since", "type": "string", "description": "Only inspections on or after this date (YYYY-MM-DD)." }, "ratings": { "title": "Ratings", "type": "array", "description": "Keep only these hygiene levels. Empty = all.", "items": { "type": "string", "enum": [ "very-good", "good", "to-improve", "urgent" ], "enumTitles": [ "Très satisfaisant", "Satisfaisant", "A améliorer", "A corriger de manière urgente" ] } }, "activities": { "title": "Activities", "type": "array", "description": "Partial match, in French: 'restaurant', 'boulangerie', 'boucherie', 'restauration collective', 'traiteur', 'rayon'…", "items": { "type": "string" } }, "departments": { "title": "Départements", "type": "array", "description": "Codes such as '33', '75', '2A', '974'.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Full postal codes or prefixes ('750' for Paris).", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Exact city names (case- and accent-insensitive).", "items": { "type": "string" } }, "nameKeywords": { "title": "Name contains", "type": "array", "description": "Matches the establishment name, legal name or brand.", "items": { "type": "string" } }, "sirets": { "title": "SIRET / SIREN lookup", "type": "array", "description": "Check specific companies (14-digit SIRET or 9-digit SIREN).", "items": { "type": "string" } }, "latestPerEstablishment": { "title": "Latest inspection per establishment only", "type": "boolean", "description": "Off = every inspection, including older ones of the same place.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Upper limit of inspections output (and charged) per run.", "default": 1000 }, "monitorNewInspections": { "title": "Monitor mode: output only new inspections", "type": "boolean", "description": "Remembers the inspections already output and returns only new ones next time. Schedule it daily or weekly.", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Use one name per saved search you monitor.", "default": "default" }, "monitorFirstRun": { "title": "First monitoring run", "enum": [ "outputAll", "baselineOnly" ], "type": "string", "description": "What to do the first time a monitor runs.", "default": "outputAll" } } }, "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 } } } } } } } } } }