{ "openapi": "3.0.1", "info": { "title": "General Osteopathic Council Register Scraper", "description": "Search the General Osteopathic Council's public register (osteopathy.org.uk) by postcode/town, surname, or practice features, or look up exact registration numbers. Returns status, qualifications, training, and practice details.", "version": "2.0", "x-build-id": "SH8rgwf1fMdTdbNJP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~general-osteopathic-council-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-general-osteopathic-council-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/vexaloom-labs~general-osteopathic-council-register-scraper/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-general-osteopathic-council-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/vexaloom-labs~general-osteopathic-council-register-scraper/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-general-osteopathic-council-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" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byRegistrationNumbers", "fullRegister" ], "type": "string", "description": "Choose how to query the register.", "default": "search" }, "surname": { "title": "Exact surname", "type": "string", "description": "Exact surname as held by the register, case-insensitive (for example Smith). Partial surnames such as Smit do not match. Combine with location or practice features to narrow results." }, "location": { "title": "Town, county, country or postcode", "type": "string", "description": "Exact town, county or country name, or a UK postcode/outcode such as SW1A 1AA or SW1A. Town names must match the register's own location labels." }, "radius": { "title": "Distance from postcode", "enum": [ "5mi", "10mi", "25mi", "50mi" ], "type": "string", "description": "Radius used when location is a UK postcode or outcode. Town and county searches use the register's own boundary.", "default": "10mi" }, "firstName": { "title": "First name contains", "type": "string", "description": "Optional case-insensitive contains filter applied to the first-name part of the register name." }, "disabilityAccess": { "title": "Requires disabled access", "type": "boolean", "description": "Only return osteopaths whose practice reports disabled access. Partial access counts as access, matching the register's own filter.", "default": false }, "homeVisit": { "title": "Offers home visits", "type": "boolean", "description": "Only return osteopaths whose practice reports home visits.", "default": false }, "welshSpoken": { "title": "Welsh spoken", "type": "boolean", "description": "Only return osteopaths whose practice reports that Welsh is spoken.", "default": false }, "status": { "title": "Practising status", "enum": [ "", "Fully Registered", "Non Practising", "Practising Overseas", "Suspended", "Conditions of Practice", "Undertaking" ], "type": "string", "description": "Optional exact status filter applied after each register entry is read. Leave blank for every status.", "default": "" }, "registeredAfter": { "title": "Registered on or after", "type": "string", "description": "Optional ISO date (YYYY-MM-DD). Only return entries whose date of registration is on or after this date." }, "registeredBefore": { "title": "Registered on or before", "type": "string", "description": "Optional ISO date (YYYY-MM-DD). Only return entries whose date of registration is on or before this date." }, "qualificationContains": { "title": "Qualification contains", "type": "string", "description": "Optional case-insensitive text filter over the published qualifications, for example Ost or DO." }, "registrationNumbers": { "title": "GOsC registration numbers", "type": "array", "description": "Exact registration numbers for byRegistrationNumbers mode. Strings or integers are accepted; duplicates and leading zeros are normalised. Only the first 10,000 unique numbers are read.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum osteopaths", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on emitted osteopath records. The full practice-linked register currently holds about 5,688 unique registrants.", "default": 50 } } }, "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 } } } } } } } } } }