Skip to main content

NHS APIs NHS services

Content from the NHS website NHS services hub excluding data libraries.

Important: Migration of NHS website syndication APIs

We are migrating the NHS website syndication APIs to the NHS Developer and integration hub.

The combined NHS Website Content API v2 (including the NHS services API) is now available on the hub. If you currently use this API, you need to migrate to the new Content API. Please use our migration guide and migration assistant to help you through the migration process.

This API is accessed through HTTP and returns data in a JSON format.

Base URL

All requests to this API should start with the following base URL:

https://api.nhs.uk/nhs-services

API Version

The API version number can be supplied as a query parameter:

?api-version=1.0

Authentication and Headers

Your request must include a subscription-key header with a valid subscription key.

Request header keys and values
Header key Header value
subscription-key

Login or register to get an API key to use this API

Endpoints

An endpoint is added to the base URL to create the full request URL. Some APIs have more than 1 type of endpoint you can use.

NHS services (content)

Content from the <a href="https://www.nhs.uk/nhs-services/">NHS website NHS services hub</a> excluding data libraries.

Endpoint

GET `/*`

Responses

200 - Successful response for a health topic

                          {
  "@context": "http://schema.org",
  "@type": "MedicalWebPage",
  "name": "Cold sores",
  "copyrightHolder": {
    "name": "Crown Copyright",
    "@type": "Organization"
  },
  "license": "https://developer.api.nhs.uk/terms",
  "author": {
    "url": "https://www.nhs.uk",
    "logo": "https://www.nhs.uk/nhscwebservices/documents/logo1.jpg",
    "email": "nhswebsite.servicedesk@nhs.net",
    "@type": "Organization",
    "name": "NHS website"
  },
  "about": {
    "@type": "MedicalCondition",
    "name": "Cold sores",
    "alternateName": []
  },
  "description": "Cold sores are common and usually clear up on their own within 10 days. They're contagious until they go away.",
  "url": "https://api.nhs.uk/conditions/cold-sores/",
  "lastReviewed": [
    "2017-07-04T17:54:00+00:00",
    "2020-07-04T17:54:00+00:00"
  ],
  "breadcrumb": {
    "@context": "http://schema.org",
    "@type": "BreadcrumbList",
    "itemListElement": [
      {
        "@type": "ListItem",
        "position": 0,
        "item": {
          "@id": "https://api.nhs.uk/conditions/",
          "name": "Health A to Z",
          "genre": "condition"
        }
      },
      {
        "@type": "ListItem",
        "position": 1,
        "item": {
          "@id": "https://api.nhs.uk/conditions/cold-sores/",
          "name": "Cold sores",
          "genre": "condition"
        }
      }
    ]
  },
  "dateModified": "2020-02-04T18:50:05+00:00",
  "genre": "condition",
  "hasPart": [
    {
      "@type": "WebPageElement",
      "name": "overview",
      "url": "https://api.nhs.uk/conditions/cold-sores/#overview",
      "description": "",
      "text": "<p>A cold sore usually starts with a tingling, itching or burning feeling. Over the next day or 2, a painful lump or blister will appear on your face.</p><p>Treatments for cold sores include antiviral creams and cold sore patches you can get from a pharmacy.</p><p></p><p></p>"
    },
    {
      "@type": "WebPageElement",
      "name": "symptoms",
      "url": "https://api.nhs.uk/conditions/cold-sores/#symptoms",
      "description": "A cold sore usually starts with a tingling, itching or burning feeling. Over the next day or 2, a painful lump or blister will appear on your face.",
      "text": "<p>A cold sore usually starts with a tingling, itching or burning feeling.</p><p><b>Over the next 48 hours:</b></p>    <p><img  alt=\"Cold sores 1\" height=\"426\" src=\"https://assets.nhs.uk/prod/images/M1700345-Herpes_Cold_Sore-SPL.width-640.jpg\" width=\"640\" alt=\"Cold sore on lower lip\"/><br/>Small fluid-filled blisters appear.</p>    <p><img  alt=\"Cold sore 3\" height=\"426\" src=\"https://assets.nhs.uk/prod/images/C0144603-Cold_sore-SPL.width-640.jpg\" width=\"640\" alt=\"Cold sore on face just below the nose\"/><br/>The blisters can appear anywhere on the face.</p>    <p><img  alt=\"Cold sores 2\" height=\"426\" src=\"https://assets.nhs.uk/prod/images/C0263434-Cold_sores-SPL.width-640.jpg\" width=\"640\" alt=\"old sore on lower lip that has become a scabBurst c\"/><br/>The blisters burst and crust over into a scab.</p><p>Cold sores should start to heal within 10 days, but are contagious and may be irritating or painful while they heal.</p><p>Some people find that certain things trigger a cold sore, such as another illness, sunshine or periods.</p>",
      "title": "Check if it's a cold sore"
    },
    {
      "@type": "WebPageElement",
      "name": "treatments_overview",
      "url": "https://api.nhs.uk/conditions/cold-sores/#treatments-summary",
      "description": "Treatments for cold sores include antiviral creams and cold sore patches you can get from a pharmacy.",
      "text": "",
      "title": ""
    },
    {
      "@type": "WebPageElement",
      "name": "self_care",
      "url": "https://api.nhs.uk/conditions/cold-sores/#self-care",
      "description": "",
      "text": "<p>Cold sores take time to heal and they're very contagious, especially when the blisters burst.</p><h3>Important</h3><p>Do not kiss babies if you have a cold sore. It can lead to <a href=\"https://api.nhs.uk/conditions/neonatal-herpes/\">neonatal herpes</a>, which is very dangerous to newborn babies.</p><br/><h3>Do</h3><ul>    <li><p>eat cool, soft foods</p></li>    <li><p>wash your hands with soap and water before and after applying cream</p></li>    <li><p>avoid anything that triggers your cold sores</p></li>    <li><p>use sunblock lip balm (SPF 15 or above) if sunshine is the trigger</p></li>    <li><p>take <a href=\"https://api.nhs.uk/conditions/paracetamol/\">paracetamol</a> or <a href=\"https://api.nhs.uk/conditions/ibuprofen/\">ibuprofen</a> to ease pain and swelling (liquid paracetamol is available for children) – do not give aspirin to children under 16</p></li>    <li><p>drink plenty of fluids to avoid <a href=\"https://api.nhs.uk/conditions/dehydration/\">dehydration</a></p></li></ul><br/><h3>Don't</h3><ul>    <li><p>do not kiss anyone while you have a cold sore</p></li>    <li><p>do not share anything that comes into contact with a cold sore (such as cold sore creams, cutlery or lipstick)</p></li>    <li><p>do not have oral sex until your cold sore completely heals – the cold sore virus also causes <a href=\"https://api.nhs.uk/conditions/genital-herpes/\">genital herpes</a></p></li>    <li><p>do not touch your cold sore (apart from applying cream)</p></li>    <li><p>do not rub cream into the cold sore – dab it on instead</p></li>    <li><p>do not eat acidic or salty food</p></li></ul>",
      "title": "Things you can do yourself"
    },
    {
      "@type": "WebPageElement",
      "name": "other_treatments",
      "url": "https://api.nhs.uk/conditions/cold-sores/#treatments-other",
      "description": "",
      "text": "<p>A GP may prescribe antiviral tablets if your cold sores are very large, painful or keep coming back.</p><p>Newborn babies, pregnant women and people with a weakened immune system may be referred to hospital for advice or treatment.</p>",
      "title": "Treatment from a GP"
    }
  ],
  "relatedLink": [
    {
      "@type": "LinkRole",
      "url": "https://api.nhs.uk/conditions/cold-sores/",
      "linkRelationship": "Navigation",
      "position": 0,
      "name": "Cold sores"
    }
  ],
  "keywords": [
    "Cold sores",
    "Genital herpes"
  ],
  "interactionStatistic": [
    {
      "interactionService": {
        "url": "<img style='border: 0; width: 1px; height: 1px;' alt='' src='https://statse.webtrendslive.com/dcs2221tai1ckz5huxw0mfq86_1m2w/njs.gif?dcsuri=conditions/cold-sores/&wt.cg_n=Syndication&wt.cg_s=Conditions&synduserid=56dda0792399060e5876b61c&syndreviewdate=21-07-2020T16:14'/> <img style='border: 0; width: 1px; height: 1px;' alt='' src='https://nhsdigital.d3.sc.omtrdc.net/b/ss/nhsuk-prod/1/JS-2.9.0-L8UK/654321?c27=56dda0792399060e5876b61c&c28=conditions/cold-sores/&c29=Conditions&c75=web&events=event23'/>",
        "@type": "Website",
        "name": "Webtrends tracking pixel"
      },
      "@type": "InteractionCounter"
    }
  ],
  "mainEntityOfPage": [
    {
      "identifier": "0",
      "name": "section heading",
      "position": 0,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<p><b>Cold sores are common and usually clear up on their own within 10 days. But there are things you can do to help ease the pain.</b></p>",
          "@type": "WebPageElement",
          "name": "markdown"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 1,
      "@type": "WebPageElement",
      "headline": "Check if it's a cold sore",
      "text": "Symptoms",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<p>A cold sore usually starts with a tingling, itching or burning feeling.</p><p><b>Over the next 48 hours:</b></p>",
          "@type": "WebPageElement",
          "name": "markdown"
        },
        {
          "position": 1,
          "identifier": "13",
          "@type": "ImageObject",
          "name": "Cold sore on lower lip",
          "url": "https://assets.nhs.uk/prod/images/M1700345-Herpes_Cold_Sore-SPL.max-600x600.jpg",
          "provider": "Science Photo Library",
          "license": "SCIENCE SOURCE/SCIENCE PHOTO LIBRARY\r\n\r\nhttps://www.sciencephoto.com/media/257566/view",
          "datePublished": "2017-06-15T08:28:15+00:00",
          "keywords": [
            "Cold sores",
            "herpes",
            "cold sore",
            "herpes mouth"
          ]
        },
        {
          "position": 2,
          "identifier": "13",
          "@type": "ImageObject",
          "name": "Cold sore on face just below the nose",
          "url": "https://assets.nhs.uk/prod/images/C0144603-Cold_sore-SPL.max-600x600.jpg",
          "provider": "Science Photo Library",
          "license": "PAN XUNBIN/SCIENCE PHOTO LIBRARY\r\n\r\nhttps://www.sciencephoto.com/media/479137/view",
          "datePublished": "2017-06-15T08:28:15+00:00",
          "keywords": [
            "cold sore",
            "Herpes simplex virus"
          ]
        },
        {
          "position": 3,
          "identifier": "13",
          "@type": "ImageObject",
          "name": "old sore on lower lip that has become a scabBurst c",
          "url": "https://assets.nhs.uk/prod/images/C0263434-Cold_sores-SPL.max-600x600.jpg",
          "provider": "Science Photo Library",
          "license": "DR P. MARAZZI/SCIENCE PHOTO LIBRARY\r\n\r\nhttps://www.sciencephoto.com/media/683456/view",
          "datePublished": "2017-06-15T08:28:15+00:00",
          "keywords": [
            "cold sore"
          ]
        },
        {
          "position": 4,
          "identifier": "1",
          "text": "<p>Cold sores should start to heal within 10 days, but are contagious and may be irritating or painful while they heal.</p><p>Some people find that certain things trigger a cold sore, such as another illness, sunshine or periods.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 2,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": [
        {
          "position": 0,
          "@type": "WebPageElement",
          "name": "Reveal",
          "subjectOf": "When it's not a cold sore",
          "identifier": "11",
          "mainEntity": [
            {
              "position": 0,
              "@type": "WebPageElement",
              "name": "Table",
              "identifier": "21",
              "text": "<table>\n<thead>\n<tr>\n  <th>Symptoms</th>\n  <th>Possible cause</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n  <td>Painful red spot on the face filled with pus</td>\n  <td>Spot or <a href=\"https://api.nhs.uk/conditions/boils/\">boil</a></td>\n</tr>\n<tr>\n  <td>Blister on the lip or inside the mouth</td>\n  <td><a href=\"https://api.nhs.uk/conditions/mouth-ulcers/\">Mouth ulcer</a></td>\n</tr>\n<tr>\n  <td>Red sores or blisters on the face that become crusty, golden-brown patches</td>\n  <td><a href=\"https://api.nhs.uk/conditions/impetigo/\">Impetigo</a></td>\n</tr>\n</tbody>\n</table>\n"
            }
          ]
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 3,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<h2>How long cold sores are contagious</h2><p>Cold sores are contagious from the moment you first feel tingling or other signs of a cold sore coming on to when the cold sore has completely healed.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 4,
      "@type": "WebPageElement",
      "headline": "",
      "text": "How a pharmacist can help",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<h2>A pharmacist can help with cold sores</h2><p>A pharmacist can recommend:</p><ul><li>creams to ease pain and irritation</li><li>antiviral creams to speed up healing time</li><li>cold sore patches to protect the skin while it heals</li></ul><p>You can buy electronic devices from pharmacies that treat cold sores with light or lasers.</p><p>Some people find these helpful, but there have not been many studies to find out if they work.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        },
        {
          "position": 1,
          "@type": "WebPageElement",
          "name": "Information",
          "identifier": "3",
          "text": "<p>If you regularly get cold sores, use antiviral creams as soon as you recognise the early tingling feeling. They do not always work after blisters appear.</p>"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 5,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": [
        {
          "position": 0,
          "@type": "WebPageElement",
          "name": "Find a service",
          "identifier": "2",
          "text": "<p><a href=\"https://beta.nhs.uk/find-a-pharmacy/\">Find a pharmacy</a></p>\n"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 6,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": []
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 7,
      "@type": "WebPageElement",
      "headline": "Things you can do yourself",
      "text": "Things you can try",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<p>Cold sores take time to heal and they&#x27;re very contagious, especially when the blisters burst.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        },
        {
          "position": 1,
          "@type": "WebPageElement",
          "name": "Callout",
          "identifier": "4",
          "text": "<h3>Important</h3><p>Do not kiss babies if you have a cold sore. It can lead to <a href=\"https://api.nhs.uk/conditions/neonatal-herpes/\">neonatal herpes</a>, which is very dangerous to newborn babies.</p>"
        },
        {
          "position": 2,
          "@type": "WebPageElement",
          "name": "Do/Don't",
          "identifier": "9",
          "text": "<div><h3>Do</h3><ul><li><p>eat cool, soft foods</p></li><li><p>wash your hands with soap and water before and after applying cream</p></li><li><p>avoid anything that triggers your cold sores</p></li><li><p>use sunblock lip balm (SPF 15 or above) if sunshine is the trigger</p></li><li><p>take <a href=\"https://api.nhs.uk/conditions/paracetamol/\">paracetamol</a> or <a href=\"https://api.nhs.uk/conditions/ibuprofen/\">ibuprofen</a> to ease pain and swelling (liquid paracetamol is available for children) – do not give aspirin to children under 16</p></li><li><p>drink plenty of fluids to avoid <a href=\"https://api.nhs.uk/conditions/dehydration/\">dehydration</a></p></li></ul></div>"
        },
        {
          "position": 3,
          "@type": "WebPageElement",
          "name": "Do/Don't",
          "identifier": "9",
          "text": "<div><h3>Don't</h3><ul><li><p>do not kiss anyone while you have a cold sore</p></li><li><p>do not share anything that comes into contact with a cold sore (such as cold sore creams, cutlery or lipstick)</p></li><li><p>do not have oral sex until your cold sore completely heals – the cold sore virus also causes <a href=\"https://api.nhs.uk/conditions/genital-herpes/\">genital herpes</a></p></li><li><p>do not touch your cold sore (apart from applying cream)</p></li><li><p>do not rub cream into the cold sore – dab it on instead</p></li><li><p>do not eat acidic or salty food</p></li></ul></div>"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 8,
      "@type": "WebPageElement",
      "headline": "",
      "text": "When to get medical help",
      "mainEntityOfPage": [
        {
          "position": 0,
          "@type": "WebPageElement",
          "name": "Primary care",
          "identifier": "5",
          "text": "<h3>See a GP if:</h3><div class=\"block-richtext\"><ul><li>the cold sore has not started to heal within 10 days</li><li>you&#x27;re worried about a cold sore or think it&#x27;s something else</li><li>the cold sore is very large or painful</li><li>you or your child also have swollen, painful gums and sores in the mouth (gingivostomatitis)</li><li>you&#x27;re pregnant – there&#x27;s an increased risk of <a href=\"https://api.nhs.uk/conditions/neonatal-herpes/\">neonatal herpes</a></li><li>you have a weakened immune system – for example, because of chemotherapy or diabetes</li></ul></div>"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 9,
      "@type": "WebPageElement",
      "headline": "Treatment from a GP",
      "text": "Treatment from a GP",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<p>A GP may prescribe antiviral tablets if your cold sores are very large, painful or keep coming back.</p><p>Newborn babies, pregnant women and people with a weakened immune system may be referred to hospital for advice or treatment.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 10,
      "@type": "WebPageElement",
      "headline": "",
      "text": "Causes",
      "mainEntityOfPage": [
        {
          "position": 0,
          "identifier": "1",
          "text": "<h2>Why cold sores come back</h2><p>Cold sores are caused by a virus called herpes simplex.</p><p>Once you have the virus, it stays in your skin for the rest of your life. Sometimes it causes a cold sore.</p><p>Most people are exposed to the virus when they&#x27;re young after close contact with someone who has a cold sore.</p><p>It does not usually cause any symptoms until you&#x27;re older. You will not know if it&#x27;s in your skin unless you get a cold sore.</p>",
          "@type": "WebPageElement",
          "name": "markdown"
        }
      ]
    },
    {
      "identifier": "0",
      "name": "section heading",
      "position": 11,
      "@type": "WebPageElement",
      "headline": "",
      "text": "",
      "mainEntityOfPage": []
    }
  ]
}
                        

Attribution

Any syndicated content must incorporate the following attribution (credit) to the NHS website:

Content supplied by the NHS website logo

The logo should be clearly visible and in line with the associated content on every web page that contains the syndicated content. You should also link this logo to the relevant page on the NHS website that the content has been supplied from. This URL is supplied as part of the feed under author:

"author": {
  "url": "https://www.nhs.uk",
  "logo": "https://www.nhs.uk/nhscwebservices/documents/logo1.jpg",
  "email": "nhswebsite.servicedesk@nhs.net",
  "@type": "Organization",
  "name": "NHS website"
}

If you are displaying NHS syndicated content in a context where a functional link back to the article on the NHS website is not possible then you should use the following attribution (credit):

From www.nhs.uk

Caching

Caching all content supplied through our API is recommended where possible. Unless otherwise notified by the syndication team, you should refresh cached content at least once every 7 days. If instructed to refresh cached our content, you must do so immediately.

Information:

Certain topics on the NHS website need to be refreshed more frequently than every 7 days. Find out about content not covered by our standard terms and conditions.

Usage caps

When using a trial subscription, you will only be able to run 10 calls/minute up to a maximum of 1,000 calls per month. A full subscription caps usage at 4,000 calls per hour. You are not to call the APIs over 4,000 times in any one-hour period, unless you have notified the syndication team in advance and they have confirmed in writing that you can do so.

Standard licence terms

By using the NHS website syndicated content, you agree to be bound by the standard licence terms.

Your contact details

You must provide accurate contact details that must be kept up to date while you are using our content. Failure to keep contact details updated is a breach of our licence terms and may result in your subscription being disabled. You can check your details on your profile.

Information:

Help and support

If you need help using any of our APIs , please email the NHS website service desk at nhswebsite.servicedesk@nhs.net.