/nhs/services

POST /api/nhs/services

Price: 5 credits

Get an NHS service organisation's profile by its type and ODS organisation code: name, full address, phone, website, current open/closed status, geographic coordinates, reception opening times by day, the facilities it offers, the services it provides, and — for GP surgeries — the online registration link.

How to use it

Look up one NHS organisation by service_type (gp, pharmacy, dentist, hospital, ...) and its ODS code (e.g. 'XE87002', accepts with or without the leading X). Returns one item with id, name, service_type, address, phone, website_url, registration_url, status, accepting_status, latitude, longitude, opening_hours (day, times), facilities and services. To find an ODS code by location, use nhs/services/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• service_type string required — Type of NHS service (one of: "gp", "dentist", "pharmacy", "hospital", "nhs_sight_test", "podiatrist", "sexual_health_clinic", "hiv_treatment", "breast_screening", "abdominal_aortic_aneurysm_screening", "diabetic_eye_screening", "chlamydia_screening", "sti_testing", "emergency_contraception", "free_condoms", "sexual_health_advice", "young_people_sexual_health", "rape_and_sexual_assault_referral", "drug_treatment", "drug_addiction_support", "stop_smoking", "pals", "pregnancy_testing")
• ods_code string required — Organisation identifier (ODS code) (examples: "XE87002", "XFHV67"; minLength: 1)

Response

• @type string (default: "NhsService")
• id string required
• name string required
• service_type string required
• address string nullable
• phone string nullable
• website_url string nullable
• registration_url string nullable
• status string nullable
• accepting_status string nullable
• latitude number nullable
• longitude number nullable
• opening_hours array (default: [])
  • @type string (default: "NhsOpeningTime")
  • day string required
  • times string required
• facilities array (default: [])
• services array (default: [])
• url string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No organisation found for the given service type and ODS code Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.