{ "openapi": "3.0.1", "info": { "title": "UK NHS Organisation Lookup (Official ODS Codes)", "description": "Look up the official NHS Organisation Data Service (ODS) register by postcode, type or ODS code: GP practices, pharmacies, dentists, opticians, NHS trusts, ICBs, PCNs, care homes. Open organisations only, updated every working day, no API key, no personal data. JSON via API or MCP. $5/1,000 rows.", "version": "0.1", "x-build-id": "d2GqMFBxhVYrariV9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/japan-open-data~uk-nhs-organisation-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-japan-open-data-uk-nhs-organisation-lookup", "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/japan-open-data~uk-nhs-organisation-lookup/runs": { "post": { "operationId": "runs-sync-japan-open-data-uk-nhs-organisation-lookup", "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/japan-open-data~uk-nhs-organisation-lookup/run-sync": { "post": { "operationId": "run-sync-japan-open-data-uk-nhs-organisation-lookup", "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": { "postcodes": { "title": "Postcodes", "type": "array", "description": "UK postcodes to search. The NHS register matches a postcode as a PREFIX, so \"LS1\" returns organisations in LS1 and in LS10-LS19, and \"M1\" also covers M10-M19; four-character codes such as \"TS18\" or \"SW1A\" match one district only, and a full postcode (\"TS18 1HU\") matches one address. Up to 20 per run, and \"maxResults\" is split evenly between them. Leave empty to search the whole UK by organisation type instead.", "default": [ "LS1" ], "items": { "type": "string" } }, "organisationType": { "title": "Organisation type", "enum": [ "any", "gpPractice", "branchSurgery", "pharmacy", "dentalPractice", "optician", "nhsTrust", "nhsTrustSite", "integratedCareBoard", "primaryCareNetwork", "careHome", "socialCareProvider", "independentProvider", "prescribingCostCentre", "localAuthority", "hospice" ], "type": "string", "description": "Which kind of NHS organisation to return. \"Any organisation\" returns every kind, including NHS suppliers and administrative records. Each choice maps to an official ODS role code, shown in brackets.", "default": "gpPractice" }, "odsCodes": { "title": "ODS codes", "type": "array", "description": "Look up specific organisations by their ODS code, for example [\"RJ1\", \"A81001\", \"FA002\"]. Takes priority over the postcodes and the organisation type. Up to 200 per run, but never more than \"maxResults\", so raise that as well. Any code that returns no row is listed in one extra free row.", "default": [], "items": { "type": "string" } }, "includeInactive": { "title": "Include closed organisations", "type": "boolean", "description": "Off by default, so only organisations that are currently open are returned. Turn it on to include closed ones, such as the CCGs replaced by integrated care boards in 2022.", "default": false }, "roleId": { "title": "ODS role code (advanced)", "type": "string", "description": "Any of the ~205 official ODS role codes, for example \"RO227\" (Scottish GP practice), \"RO142\" (local health board) or \"RO175\" (prison). Overrides \"Organisation type\". The full list is at https://directory.spineservices.nhs.uk/ORD/2-0-0/roles . Leave empty to ignore.", "default": "" }, "maxResults": { "title": "Maximum organisations", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of organisation rows to return (1 to 500). Each returned row is charged.", "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 } } } } } } } } } }