{ "openapi": "3.0.1", "info": { "title": "France Healthcare Professionals (RPPS / Annuaire Santé)", "description": "Every health professional registered in France (doctors, pharmacists, nurses, physios, dentists...) from the official RPPS register: profession, specialty, practice mode, workplace, SIRET/FINESS and address. Filter by area or monitor new installations.", "version": "1.0", "x-build-id": "e4xI2v3wLlAXS3YQ7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jet_mythology~france-healthcare-professionals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jet_mythology-france-healthcare-professionals", "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-healthcare-professionals/runs": { "post": { "operationId": "runs-sync-jet_mythology-france-healthcare-professionals", "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-healthcare-professionals/run-sync": { "post": { "operationId": "run-sync-jet_mythology-france-healthcare-professionals", "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": { "professions": { "title": "Professions", "type": "array", "description": "Partial match on the profession, in French: 'Médecin', 'Pharmacien', 'Infirmier', 'Masseur-Kinésithérapeute', 'Chirurgien-Dentiste', 'Sage-Femme', 'Orthophoniste'…", "items": { "type": "string" } }, "specialties": { "title": "Specialties (savoir-faire)", "type": "array", "description": "Partial match: 'Cardiologie', 'Médecine Générale', 'Pédiatrie', 'Dermatologie'…", "items": { "type": "string" } }, "exerciseModes": { "title": "Mode of practice", "type": "array", "description": "'Libéral', 'Salarié' or 'Bénévole' (partial match).", "items": { "type": "string" } }, "sectors": { "title": "Activity sectors", "type": "array", "description": "Partial match on the sector of the workplace: 'Pharmacie d'officine', 'Cabinet individuel', 'Etablissement public de santé'…", "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 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" } }, "names": { "title": "Names", "type": "array", "description": "Partial match on 'last name first name'.", "items": { "type": "string" } }, "rppsIds": { "title": "RPPS / ADELI numbers", "type": "array", "description": "Check specific professionals by their national identifier.", "items": { "type": "string" } }, "withEmailOnly": { "title": "Only workplaces with an e-mail", "type": "boolean", "description": "Keep only rows where the workplace e-mail is published.", "default": false }, "withPhoneOnly": { "title": "Only workplaces with a phone", "type": "boolean", "description": "Keep only rows where a workplace phone number is published.", "default": false }, "groupByProfessional": { "title": "One item per professional", "type": "boolean", "description": "Off = one item per (professional, workplace, specialty), as in the official file. On = one item per professional with the list of workplaces.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Upper limit of items output (and charged) per run.", "default": 1000 }, "monitorNew": { "title": "Monitor mode: output only new entries", "type": "boolean", "description": "Remembers what was already output and returns only new professionals or new workplaces next time (new installations). Schedule it weekly. Use filters: the full file has about 2 million rows.", "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": "baselineOnly" }, "fileUrl": { "title": "Source file URL", "type": "string", "description": "Leave empty: the current official file is found automatically on data.gouv.fr." } } }, "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 } } } } } } } } } }