{ "openapi": "3.0.1", "info": { "title": "UK Pharmacist Register Scraper", "description": "Search the General Pharmaceutical Council (GPhC) public register for pharmacists, pharmacy technicians, pharmacies, and training sites in Great Britain. Get registration numbers, status, annotations, fitness-to-practise flags, addresses, and inspection info.", "version": "1.0", "x-build-id": "sqzDUi9ePih4H5Gys" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~uk-pharmacist-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-uk-pharmacist-register-scraper", "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/crawlerbros~uk-pharmacist-register-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-uk-pharmacist-register-scraper", "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/crawlerbros~uk-pharmacist-register-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-uk-pharmacist-register-scraper", "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", "required": [ "mode", "registerType" ], "properties": { "mode": { "title": "Mode", "enum": [ "byName", "byRegistrationNumber" ], "type": "string", "description": "How to search the register.", "default": "byName" }, "registerType": { "title": "Register", "enum": [ "pharmacist", "pharmacyTechnician", "pharmacy", "trainingSite" ], "type": "string", "description": "Which GPhC register to search.", "default": "pharmacist" }, "firstName": { "title": "First name (mode=byName, registerType=pharmacist/pharmacyTechnician)", "type": "string", "description": "Given name of the pharmacist or pharmacy technician. Optional if `lastName` is set." }, "lastName": { "title": "Last name (mode=byName, registerType=pharmacist/pharmacyTechnician)", "type": "string", "description": "Family name / surname of the pharmacist or pharmacy technician. Optional if `firstName` is set." }, "premisesName": { "title": "Pharmacy / training site name (mode=byName, registerType=pharmacy/trainingSite)", "type": "string", "description": "Business or premises name to search for, e.g. `Boots`, `Superdrug`, `Lloyds Pharmacy`. Use `*` alone to browse all premises (e.g. combined with `sectorFilter`)." }, "townOrPostcode": { "title": "Town or postcode (mode=byName, registerType=pharmacy/trainingSite)", "type": "string", "description": "Optional town or postcode to narrow a pharmacy/training-site name search, e.g. `London`, `SW1A 1AA`." }, "fuzzyMatch": { "title": "Fuzzy / \"not sure of the spelling\" match", "type": "boolean", "description": "Enable the register's phonetic \"I'm not sure of the spelling\" match instead of an exact name match (mode=byName).", "default": false }, "annotationFilter": { "title": "Annotation filter (registerType=pharmacist, mode=byName)", "enum": [ "", "INDPRESC", "SUPPRESC" ], "type": "string", "description": "Only return pharmacists holding this prescribing annotation.", "default": "" }, "sectorFilter": { "title": "Training sector (registerType=trainingSite, mode=byName)", "enum": [ "", "717750000", "717750001", "717750003", "717750004", "717750005", "981360003", "981360009", "981360010", "981360011" ], "type": "string", "description": "Only return training sites in this sector. Combine with `premisesName: *` (or any name) to browse a whole sector.", "default": "" }, "registrationNumber": { "title": "Registration number (mode=byRegistrationNumber)", "type": "string", "description": "Exact GPhC registration number to look up, e.g. `2025781`. For registerType=trainingSite, you may also supply a `P`-prefixed \"training site only number\" (e.g. `P1031261`) for training sites that don't have a separate pharmacy registration (e.g. hospital foundation-training programmes)." }, "fetchDetails": { "title": "Fetch full detail page per record", "type": "boolean", "description": "Enrich every result with its individual registration-details page (expiry date, town, superintendent, enforcement history, etc.). Disable for faster runs with only summary fields.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted records.", "default": 20 } } }, "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 } } } } } } } } } }