Skip to main content
POST
/
api
/
nhs
/
services
/nhs/services
curl --request POST \
  --url https://api.anysite.io/api/nhs/services \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "ods_code": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "name": "<string>",
    "service_type": "<string>",
    "url": "<string>",
    "@type": "@nhs_service",
    "address": "<string>",
    "phone": "<string>",
    "website_url": "<string>",
    "registration_url": "<string>",
    "status": "<string>",
    "accepting_status": "<string>",
    "latitude": 123,
    "longitude": 123,
    "opening_hours": [],
    "facilities": [],
    "services": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
service_type
enum<string>
required

Type of NHS service

Available options:
gp,
dentist,
pharmacy,
hospital,
nhs_sight_test,
accident_and_emergency,
mental_health,
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,
healthwatch,
pals,
social_care,
pregnancy_testing,
sensory_impairments,
physical_disabilities
​
ods_code
string
required

Organisation identifier (ODS code)

Minimum string length: 1
Examples:

"XE87002"

"XFHV67"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
id
string
required
​
name
string
required
​
service_type
string
required
​
url
string
required
​
@type
string
default:@nhs_service
​
address
string | null
​
phone
string | null
​
website_url
string | null
​
registration_url
string | null
​
status
string | null
​
accepting_status
string | null
​
latitude
number | null
​
longitude
number | null
​
opening_hours
NhsOpeningTime · object[]
​
facilities
string[]
​
services
string[]