dateAdded,dateUpdated,url,name,description,documentation,license,maintainer,areaServed,startDate,endDate,provider
2020-01-08,2020-08-24,https://api.notifications.service.gov.uk/,GOV.UK Notify,"GOV.UK Notify allows government departments to send emails, text messages and letters to their users.\n\nThe API contains:\n\n- the public-facing REST API for GOV.UK Notify, which teams can integrate with using our clients\n- an internal-only REST API built using Flask to manage services, users, templates, etc (this is what the admin app talks to)\n- asynchronous workers built using Celery to put things on queues and read them off to be processed, sent to providers, updated, etc.",https://www.notifications.service.gov.uk/documentation,,,,,,government-digital-service
2020-01-08,2020-08-24,https://www.gov.uk/bank-holidays.json,Bank Holidays,"The Bank Holidays API provides access to data about when bank holidays are in England and Wales, Scotland and Northern Ireland.",https://github.com/alphagov/calendars/blob/master/README.md,,,,,,government-digital-service
2020-01-08,2020-08-24,https://publicapi.payments.service.gov.uk/,GOV.UK Pay,"Anyone in the public sector can use GOV.UK Pay to take online payments. It only takes minutes to get set up with GOV.UK Pay. Then you can:\n\n- take payments using debit cards, credit cards or digital wallets\n- give full or partial refunds\n- switch Payment Service Providers, for free, when you choose\n- use custom branding on your payment pages.\n\nGOV.UK Pay is ideal if you currently take payments using paper forms, by email or if you have an online service.",https://docs.payments.service.gov.uk/api_reference/#api-reference,,,,,,government-digital-service
2020-01-08,2020-08-24,https://www.gov.uk/api/content,GOV.UK Content,GOV.UK Content API makes it easy to access the data used to render content on https://www.gov.uk. For any page hosted on GOV.UK you can use the path to access the content and associated metadata for a page.,https://content-api.publishing.service.gov.uk/,,,,,,government-digital-service
2020-01-08,2025-01-16,https://www.gov.uk/api/search.json,GOV.UK Search,GOV.UK Search API allows you to find content on GOV.UK.,https://docs.publishing.service.gov.uk/apis/search/search-api.html,,,,,,government-digital-service
2020-01-08,2020-08-24,https://www.gov.uk/api/organisations,GOV.UK Organisations,The organisations API provides information about government organisations.,https://docs.publishing.service.gov.uk/repos/collections/api.html,,,,,,government-digital-service
2020-01-08,2020-08-24,https://data.gov.uk/api/action/,Data.gov.uk,"This API allows you to access the data.gov.uk dataset metadata in a machine-readable way, as JSON. A dataset's metadata includes details such as title, description, usage licence, and a list of 'resources', which describe each data file that makes up the dataset. Each resource contains a format, description and URL (for example for download).",https://guidance.data.gov.uk/get_data/api_documentation/,,,,,,government-digital-service
2020-01-08,2020-08-24,https://api.beta.ons.gov.uk/v1,Statistics,"The Office for National Statistics API makes datasets and other data available programmatically using HTTP. It allows you to filter datasets and directly access specific data points. The API is open and unrestricted - no API keys are required, so you can start using it immediately. This API is currently in Beta and still being developed. Please be aware that as a result of this there may occasionally be breaking changes as we enhance functionality and respond to feedback.",https://developer.beta.ons.gov.uk/,,,,,,office-of-national-statistics
2020-01-08,2020-08-24,https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/,Open Geography portal,"The Open Geography portal from the Office for National Statistics (ONS) provides free and open access to the definitive source of geographic products, web applications, story maps, services and APIs. All content is available under the Open Government Licence v3.0, except where otherwise stated.",https://developers.arcgis.com/rest/services-reference/get-started-with-the-services-directory.htm,,,,,,office-of-national-statistics
2020-01-08,2020-08-24,https://driver-vehicle-licensing.api.gov.uk/vehicle-enquiry,DVLA Vehicle Enquiry Service,The DVLA Vehicle Enquiry Service API provides vehicle details of a specified vehicle. It uses the vehicle registration number as input to search and provide details of the vehicle.,https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/vehicle-enquiry-service/vehicle-enquiry-service-description.html,,,,,,driver-and-vehicle-licensing-agency
2020-01-08,2020-08-24,https://driver-vehicle-licensing.api.gov.uk/thirdparty-access,DVLA Authentication,"The DVLA Authentication API provides authentication, change password, new password and change API key services for users of DVLA secure APIs.",https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/authentication-api/authentication-api-description.html,,,,,,driver-and-vehicle-licensing-agency
2020-01-08,2020-08-24,https://api.companieshouse.gov.uk/,Companies House,"The Companies House API provides access to all of the public data we hold on companies free of charge. This includes information about companies, officers, people of significant control and more.",https://developer.companieshouse.gov.uk/api/docs/,,,,,,companies-house
2020-01-08,2020-08-24,https://stream.companieshouse.gov.uk/,Companies House Streaming,"The Companies House streaming API gives you access to realtime data changes of the information held at Companies House. This delivers the same information that is available through the on-demand REST API GET requests, but instead pushes data to your client as it changes, through a long-running connection that you first establish. Streams include:\n\n- company information\n- filing history\n- insolvency cases\n- charges",https://developer-specs.companieshouse.gov.uk/streaming-api/guides/overview,,,,,,companies-house
2020-08-24,2020-08-24,https://api.os.uk/maps/raster/v1,OS Maps API,"Add Ordnance Survey's detailed maps to your GIS, web or mobile applications with ease and make location-based decisions with confidence. Available in four styles, two projections and two access methods, OS Maps API gives unrivalled geographic context to your data. You can access these maps via OGC standard WMTS or Restful ZXY.",https://osdatahub.os.uk/docs/wmts/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/maps/vector/v1/,OS Vector Tile API,"Slick, quick vector maps. Integrate Ordnance Survey's up-to-date, detailed maps in your applications, enabling you to make location-based decisions with confidence. You can customise the content and style to make your perfect map.",https://osdatahub.os.uk/docs/vts/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/search/names/v1,OS Names API,"A free, searchable, reliable database to help you find and verify populated places, road names, road numbers and postcodes. OS Names API is a reliable way of supporting the discovery or identification and visualisation of a named place; geocoding; routing and navigation, and linking diverse information such as statistics or descriptions. OS Names can locate a feature using just its name, or it can find the closest location to a given point.",https://osdatahub.os.uk/docs/names/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/features/v1,OS Features API,"Buildings, roads, greenspaces and much more. Get direct access to the most detailed geographic data for your analysis, taking full advantage of rich geometries and attributes to generate new insight. No need to download, store and manage large and complex datasets - we take care of that so you can focus on adding value.",https://osdatahub.os.uk/docs/wfs/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/search/links/v1,OS Linked Identifiers API,"The OS Linked Identifiers API allows users to access the valuable relationships between properties, streets and OS MasterMap identifiers for free.\n\nAn identifier is a unique reference assigned to a specific thing, so when you are talking to someone else you can use it to ensure you're talking about the same thing. They are used all the time, such as telephone numbers, postcodes and customer reference numbers. OS is striving to make its identifiers more accessible and useful for its customers.\n\nThe OS Linked Identifiers API takes this further by enabling the linking together of datasets that are using different identifiers; for example, linking a property address (UPRN - Unique Property Reference Number) to the street that it is on (USRN - Unique Street Reference Number).",https://osdatahub.os.uk/docs/linkedIdentifiers/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/downloads/v1,OS Download API,"The OS Downloads API is a service that lets users automate the discovery and download of OS OpenData. In doing so it improves the accessibility of the OS OpenData products. Using the OS Downloads API, you can:\n\n- discover which OS OpenData is available\n- automate the download of OS OpenData\n- request various coverage areas depending on the dataset\n- request various formats depending on the dataset\n- request metadata on available datasets including thumbnail images",https://osdatahub.os.uk/docs/downloads/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/oauth2/token/v1,OS OAuth 2 API,OAuth 2 is an authentication mechanism for APIs that allows applications to use time limited tokens for access to resources. A  common use case for the OAuth 2 API is when implementing a web application that uses the OS Data Hub APIs.,https://osdatahub.os.uk/docs/oauth2/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,,2020-07-01,,ordnance-survey
2020-08-24,2020-08-24,https://api.os.uk/search/places/v1,OS Places API,"Our secure, scalable, and resilient address look-up web service, OS Places API lets you search the UK's most comprehensive online address database. With OS Places API, managing customer data is a breeze. Lightning-quick postcode and address search means your records are accurate and customer deliveries should always get to the right front door.\n\nWhen an incident happens, control room staff need to know which properties are closest. OS Places' geosearch tool gives instant answers. This helps create the common operating picture that's vital for the emergency services.\n\nImportant note: OS Places API will be migrating to the OS Data Hub in January 2021 and at that time the base URLs will migrate to the common OS Data Hub API pattern.",https://osdatahub.os.uk/docs/places/overview,https://osdatahub.os.uk/legal/termsConditions,Ordnance Survey - <osdatahubenquiries@os.uk>,"England, Scotland, Wales",2020-07-01,,ordnance-survey
2020-01-08,2020-08-26,http://environment.data.gov.uk/flood-monitoring/id/floods,Flood-monitoring,"The Environment Agency flood-monitoring API provides developers with access to near real-time information covering:\n\n- flood warnings and flood alerts\n- flood areas which to which warnings or alerts apply\n- measurements of water levels and flows\n- information on the monitoring stations providing those measurements \n\nWater levels and flows are regularly monitored, usually every 15 minutes. However, data is transferred back to the Environment Agency at various frequencies, usually depending on the site and level of flood risk. Transfer of data is typically once or twice per day but usually increases during times of heightened flood risk. \n\nThese APIs are provided as open data under the Open Government Licence with no requirement for registration. If you make use of this data please acknowledge this with the following attribution statement: 'This uses Environment Agency flood and river level data from the real-time data API (Beta)'. \n\n Please visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",http://environment.data.gov.uk/flood-monitoring/doc/reference,,,,,,environment-agency
2020-01-08,2020-08-26,http://environment.data.gov.uk/flood-monitoring/id/stations?parameter=rainfall,Rainfall,"The Environment Agency has approximately 1000 real-time rain gauges which are connected by telemetry. Measurements of the amount of precipitation (mm) are captured in Tipping Bucket Raingauges (TBR). The data reported here gives accumulated totals for each 15 min period. The data is typically transferred once or twice per day.\n\nThe Rainfall API provides access to these rainfall measurements, and to information on the monitoring stations providing those measurements. It is compatible with (and integrated into) the API for water level/flow readings.\n\nNote that for information protection reasons the rainfall monitoring stations do not have names and their geographic location has been reduced to a 100m grid.\n\nThese APIs are provided as open data under the Open Government Licence with no requirement for registration. If you make use of this data please acknowledge this with the following attribution statement: 'This uses Environment Agency rainfall data from the real-time data API (Beta)'.\n\nPlease visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",http://environment.data.gov.uk/flood-monitoring/doc/rainfall,,,,,,environment-agency
2020-01-08,2020-08-26,http://environment.data.gov.uk/flood-monitoring/id/stations?type=TideGauge,Tide Gauge,"The UK National Tide Gauge Network is owned and operated by the Environment Agency on behalf of the UK Coastal Flood Forecasting service (a partnership between the Environment Agency, Natural Resources Wales, the Scottish Environment Protection Agency and Northern Ireland Department for Infrastructure - Rivers). It records tidal elevations at 44 locations around the UK coast. Data is made available in near real-time with measurements reported every 15 mins. The measurements provide mean sea level within each 15 min window and are reported both relative to local datum (unit m) and relative to the Ordnance Datum at Newlyn (unit mAOD).\n\nThe Tide Gauge API provides access to these measurements, and to information on the monitoring stations providing those measurements. It is compatible with (and integrated into) the API for water level/flow and rainfall readings. The API data is normally updated every 15 mins so typically the latest available reading will lag between 15 and 30 mins.\n\nNote that all times given by the API are in GMT (also known as UTC), as indicated by the Z suffix (see XML Schema datatypes).\n\nThese APIs are provided as open data under the Open Government Licence with no requirement for registration. If you make use of this data please acknowledge this with the following attribution statement: 'This uses Environment Agency tide gauge data from the real-time data API (Beta)'.\n\nPlease visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",http://environment.data.gov.uk/flood-monitoring/doc/tidegauge,,,,,,environment-agency
2020-01-08,2020-08-26,http://environment.data.gov.uk/asset-management,Asset Management,"The Environment Agency maintains records on assets of many types related to environmental activities particularly flood defences, including some assets owned or managed by other bodies. The API provides access to these asset description records along with information on maintenance activities planned for the assets. Only some assets have an associated maintenance schedule.\n\nIn the API the maintenance information is split in to three different types. Maintenance activities represent funded and scheduled work. A single activity may involve several maintenance actions on several different assets. We divide the activities into separate tasks, where each task represents a specific maintenance action on a single asset. Finally maintenance plans represent intended maintenance activities for future financial years but which have not necessarily been scheduled or funded at this stage. The API allows all activities, tasks and plans to be listed for a particular asset, set of assets or across all assets.\n\nPlease visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/asset-management/doc/reference,,,,,,environment-agency
2020-01-08,2020-08-26,https://environment.data.gov.uk/bwq/index.html,Bathing Water,"The Environment Agency collects water quality data each year from May to September, to ensure that designated bathing water sites on the coast and inland are safe and clean for swimming and other activities. We make this data reusable and accessible to developers and to members of the public, by publishing it as linked data. \n\n Please visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/bwq/doc/api-reference-v0.6.html,,,,,,environment-agency
2020-01-08,2025-03-25,https://environment.data.gov.uk/catchment-planning/,Catchment Data,The Catchment Data Explorer (CDE) helps you explore and download information about the water environment. It supports and builds upon the data in the river basin management plans. The Catchment Data API complements this by providing selective programmatic access to the data. \n\n Please visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.,https://environment.data.gov.uk/catchment-planning/api/docs,,,,,,environment-agency
2020-01-08,2020-08-26,https://environment.data.gov.uk/water-quality/view/landing,Water Quality,"The Water Quality Archive provides data on water quality measurements carried out by the Environment Agency. Samples are taken from sampling points round the country and then analysed by laboratories to measure aspects of the water quality or the environment at the sampling point. The archive provides data on these measurements and samples dating from 2000 to present day. It contains 58 million measurements on nearly 4 million samples from 58 thousand sampling points. \n\n The archive provides an API to allow selective access to the data, together with the ability to download the data split into either pre-defined or customizable subsets. The data is made available in CSV, JSON and RDF formats. \n\n Please visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/water-quality/view/doc/reference,,,,,,environment-agency
2020-01-08,2020-08-26,https://environment.data.gov.uk/hydrology/landing,Hydrology,"The Hydrology API provides access to historic water flow information. It complements the near real-time data provided under `/flood-monitoring` in that it provides access to a long term archive of quality checked and qualified data. \n\n The API and data model for the `/hydrology` API differs slightly from that under `/flood-monitoring` due to intrinsic differences (for example presence of quality flags on each reading for qualified data), modelling changes (for example adding links to [SOSA/SSN](https://www.w3.org/TR/vocab-ssn/) terms) and technology differences. \n\n In addition Environment Agency are moving to using new identifiers for monitoring stations based on GUIDs and the station URIs provided by this API use these new standards. For convenience, the stations shown here provide annotations showing the old `stationReference` notations (as well as the River Levels on the Internet and WISKI notations) and provide `sameAs` links to the equivalent `/flood-monitoring` stations. \n\n Please visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/hydrology/doc/reference,,,,,,environment-agency
2020-01-08,2022-07-21,https://environment.data.gov.uk/public-register/view/index,Public Registers for Environmental Information,"The Environment Agency licenses industry, business and individuals to carry out certain activities that have the potential to pollute the environment. When we receive an application for such a licence, we make that application and other relevant information available to the public. We do this before we make the decision of whether to issue the licence, or what conditions we will attach to it.\n\nAfter any permit is issued, further information is also made available on the registers. This can typically include monitoring information, details of any breaches of the terms of the licence, any enforcement actions that we have carried out and any applications to vary the terms of the licence.\n\nThe Public Registers for Environmental Information provide access to this registration and permit information both in the form of searchable web pages and as data which can be accessed by developers via an API.\n\nThe APIs cover the following public registers:\n\n- Waste Carriers, Brokers and Dealers\n- Waste exemptions\n- Scrap Metal Dealers\n- Enforcement Actions\n- Water Quality Exemptions\n- Environmental Permitting Regulations - Radioactive Substances\n- Environmental Permitting Regulations - Installations\n- Environmental Permitting Regulations - Waste Operations\n- Environmental Permitting Regulations - End of Life Vehicles\n- Environmental Permitting Regulations - Discharge Consents\n\nThese APIs are provided under the Environment Agency Conditional Licence with no requirement for registration. If you make use of this data please note the conditions carefully.\n\nPlease visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/public-register/view/api-reference,,,,,,environment-agency
2022-07-21,2022-07-21,https://environment.data.gov.uk/ecology/api/,Ecology and Fish Data,"The Ecology and Fish Data API provides access to the Environment Agency's open data on freshwater fish data, as well as freshwater and marine ecology survey data. This data collection is taken from the National Fish Populations Database (NFPD) and Biosys (Biological survey database).\n\nThe Ecology and Fish Data API uses a data model that harmonises these different sources, so that measurements taken for variety of purposes can be queried in a consistent way.The most central points of interest are the **Observations**. Each observation has a single result for a particular **Observable Property** for a particular **Feature of Interest**.\n\nPlease visit the [Defra Data Services Platform Support](https://environment.data.gov.uk/support) to let us know about any issues or to ask questions.",https://environment.data.gov.uk/ecology/api/v1/index.html,,,,,,environment-agency
2020-01-08,2020-08-26,https://statistics.gov.scot/sparql,Statistics.gov.scot,"statistics.gov.scot provides public access to the data behind Scotland's official statistics in linked open data format.\n\nThe SPARQL endpoint allows flexible querying of the datastore using the SPARQL 1.1 language.\n\nThis API can be used to extract data, automate report-writing, publish data visualisations, or make interactive tools for exploring the data.\n\nThe site is managed by the Scottish Government on behalf of all producers of Scottish official statistics including Scottish Government, National Records of Scotland, NHS Information Services Division, Visit Scotland and others.\n\nThe API is provided under the Open Government Licence with no requirement for registration.\n\nFor queries or comments, please contact [statistics.opendata@gov.scot](mailto:statistics.opendata@gov.scot).",https://guides.statistics.gov.scot/category/37-api,,statistics.opendata@gov.scot,Scotland,,,scottish-government
2020-08-24,2020-08-24,,Get into Teaching API,Provides a RESTful API for integrating with the Get into Teaching CRM.,https://github.com/DFE-Digital/get-into-teaching-api,,,,,,department-for-education
2020-08-24,2020-08-24,https://api.publish-teacher-training-courses.service.gov.uk/,Teacher Training API,"API to serve post graduate teacher training courses, subjects and training providers.",https://github.com/DFE-Digital/teacher-training-api,,,,,,department-for-education
2020-08-28,2022-08-23,,FINDr Matching Service,Identifies the correct service identifier for a given set of biographic data.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2020-08-28,2022-08-23,,Get Interest Details,Allows users to update a citizen's interest record.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2020-08-28,2022-08-23,,Maintain Interest Details,Allows users to update a citizen's interest record.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2022-08-23,2022-08-23,,Care Homes Information Service,Allows Local Authorities to notify DWP of changes around care home provision for citizens identified as being of interest.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2022-08-23,2022-08-23,,Citizen API,Provides access to DWP citizen information to Other Government Departments and approved external agencies.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2022-08-23,2022-08-23,,Citizen Benefit Relationships,"Provides a list of benefits (and where relevant, which components) a person is entitled to.",,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2022-08-23,2022-08-23,,GOVUK Notify,"Automatically send emails (including attachments), letters and text messages.",,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2023-02-08,2023-02-08,,Address Lookup (Location Service),"DWP single, strategic, solution to address checking.",,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2023-02-08,2023-02-08,,Organisations,Retrieves an organisation's contact details to be used for the administration of claims.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2020-01-08,2025-03-20,https://webservices.esd.org.uk/,LGInform Plus,A subscription service with access to 2 billion+ metric values for English areas drawn from approximately 50 organisations publishing metrics that describe local authorities and their component areas. Details of subscriptions can be found at [https://lginformplus.org](https://lginformplus.org).\n\nDeveloper tool can be found at [https://home.esd.org.uk/developers](https://home.esd.org.uk/developers).\n\nThe API also supports queries on the taxonomies and mappings published on the [LG Inform Plus website](https://standards.esd.org.uk/).,https://api.esd.org.uk/,Subscription required see https://lginformplus.org/,,,,,local-government-association
2020-01-08,2020-08-24,https://www.westberks.gov.uk/webservices/open311.asmx,GeoReport,To raise new requests for service to West Berkshire Council for highways and countryside related issues.,http://wiki.open311.org/GeoReport_v2/,,,West Berkshire,,,west-berkshire-council
2020-09-14,2025-03-23,https://www.trade-tariff.service.gov.uk/uk/api,GOV.UK Trade Tariff API,"The GOV.UK Trade Tariff API makes it easy to access UK Trade Tariff data from [the Trade Tariff service](https://www.gov.uk/trade-tariff). The data includes commodity codes, import/export controls, customs duty and VAT rates. It is accessed via HTTPS and returns data in a JSON format. The reference documentation provides a thorough overview of the endpoints and the response format.",https://api.trade-tariff.service.gov.uk/,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,hmrc-trade-tariff-support-g@digital.hmrc.gov.uk,UK,,,hm-revenue-customs
2020-03-09,2020-03-09,https://data.api.trade.gov.uk/v1/datasets/market-barriers/versions/latest/data?format=json,Check barriers to trading and investing abroad,"Check barriers to trading and investing abroad is the service to which DBT publishes trade barriers. It is aimed at UK-based businesses planning to export goods, provide services or invest money in another country.</p>The dataset will give you information about things that could slow down, stop or raise costs for UK companies and citizens doing business in a specific country (a ‘trade barrier’).</p> API calls can be made using a GET request to `https://data.api.trade.gov.uk/v1/datasets/market-barriers/versions/latest/data?format=json`.",https://data.api.trade.gov.uk/,,,,,,department-for-business-and-trade
2020-09-18,2021-02-09,https://developer.admiralty.co.uk/product#product=avcs-online-discovery-api,AVCS Online Discovery API,"The ADMIRALTY Vector Chart Service (AVCS) Online Discovery API provides free access to a trial version of the AVCS Online Web Map Service (WMS). It is intended for use by developers from organisations who are interested in becoming re-sellers of AVCS Online.\n\nThe Discovery API provides you with Electronic Navigational Charts (ENCs) along the south coast of England. You will have access to a maximum of 2000 API calls per day at a maximum rate of 30 calls per 30 second period.\n\nAVCS Online gives shore-based users and planning teams access to more than 15,000 Electronic Navigational Charts (ENCs), updated weekly, to support vessel tracking, voyage planning and for use in accident and emergency incidents. The inclusion of chart display settings and pick reports enables the on-board experience to be replicated from ashore.\n\nAVCS Online can be integrated into existing web-based systems as a standalone chart solution, or as a base layer with other layers added, to optimise the planning and support potential of the service.",https://admiraltyapi.developer.azure-api.net/discovery-api-instructions,subscription required,customerservices@ukho.gov.uk,South Coast of England,in service,,uk-hydrographic-office
2020-09-18,2021-02-09,https://developer.admiralty.co.uk/product#product=uk-tidal-api,UK Tidal API - Discovery,The ADMIRALTY UK Tidal API provides authoritative source of tidal height predictions for Standard and Secondary tidal level stations around the United Kingdom. Discovery provides a free 1-year subscription to access the current plus 6 days’ worth of tidal events for 607 tidal stations around the United Kingdom.,https://developer.admiralty.co.uk/api-details#api=uk-tidal-api&operation=Stations_GetStation,subscription required,customerservices@ukho.gov.uk,UK EEZ,in service,,uk-hydrographic-office
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Agent Authorisation,This API allows tax agents to request authorisation to act on a client's behalf for a specific Making Tax Digital (MTD) tax service and have the option to cancel the authorisation request.\n\nThe API also allows the agent to check the status of authorisations already requested and query active or inactive relationships.\n\n<p>The sandbox endpoint is  `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/agent-authorisation-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Business Rates,This API provides endpoints related to Business Rates.\n\nThe Valuation Office Agency (VOA) sets the rateable value of a property. Local councils use this to calculate a business rates bill for that property.\n\nBefore using this API please ensure you have registered with the VOA for Business Rates via the website.\n\n<p>The sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/business-rates-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Interest Restrictition Return (IRR),The API in its current state supports the following functions:\n\n- revoke an existing Reporting Company from submitting Interest Restriction Returns\n- appoint a new Reporting Company for submitting Interest Restriction Returns\n- submit an Interest Restriction Return (full)\n- submit an Interest Restriction Return (abbreviated)\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/interest-restriction-return,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Bulk Data File List,The API lists the bulk data files available to download for a specific information type. For each file in list there will be a URL to download the file.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/secure-data-exchange-bulk-download,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Check an EORI Number,This API enables your application to:\n\n- check if an EORI number beginning with GB (issued by the UK) is valid\n\n- view the name and address of the business that the EORI number is registered to (if the business agreed to share this information)\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.</p>,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/check-eori-number-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Common Transit Convention Traders,This API will allow you to send departure and arrival movement notifications to the New Computerised Transit System (NCTS). It will also let you retrieve messages sent from the offices of departure and destination.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/common-transit-convention-traders,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Customs Inventory Linking Exports,"This API enables the functionality to support the Inventory Linking Export process. Inventory Linking controls and monitors cargo moving through temporary storage facilities, and allows the movement/transition through frontiers.\n\nThere are three functional areas:\n\n- consolidation - this enables the combining of consignments into one master consignment, or splitting into multiple consignments\n\n- movement - records the movement of consignments within Customs controlled storage facilities\n\n- query - the querying of data held within the Inventory Linking Export database\n\nWithin each of these functional areas, there are multiple message types, each performing a specific activity.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/customs-inventory-linking-exports,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Goods Vehicle Movements,"This API provides resources related to the Goods Vehicle Movement Service.\n\nThe Goods Vehicle Movement Service (GVMS) links declaration references together. This means the person moving goods only needs to present one reference at the frontier to prove that their goods have pre-lodged declarations.\n\nThe GVMS also links the movement of goods to declarations, meaning they can be automatically arrived and departed in HMRC systems in near-real-time.\n\nIt also notifies users via your software whether their inbound goods have been successfully cleared in HMRC systems by the time they arrive in the UK.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/goods-movement-system-haulier-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Safety and Security Import Declarations,The Safety and Security system handles digital communications between:\n\n- customs administrators\n- carriers or their appointed representatives\n\nYou must provide the UK customs authorities with advance information by submitting an ENS before you bring goods into the UK.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/import-control-entry-declaration-store,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Safety and Security Import Notifications,The APIs will receive new ENS submissions or amendments and will return a response for the end user. The response will include a movement reference number or an error message.\n\nThis API will allow you to:\n\n- get a list of notifications\n- retrieve a notification\n- acknowledge a notification\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/import-control-entry-declaration-intervention,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Safety and Security Import Outcomes,The APIs will receive new ENS submissions or amendments and will return a response for the end user. The response will include a movement reference number or an error message.\n\nThis API will allow you to:\n\n- get a list of outcomes\n- retrieve an outcome\n- acknowledge an outcome\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/import-control-entry-declaration-outcome,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Business Details (MTD),The business details API allows a developer to:\n\n- list all businesses\n- retrieve additional information for a user's business details\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/business-details-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Business Income Source Summary (MTD),The Self Assessment BISS (Business Income Source Summary) API allows a developer to retrieve a summary of income and expenditure for a specified self-employment or UK property business for a given tax year.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/self-assessment-biss-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Business Source Adjustable Summary (MTD),The Self Assessment BSAS (Business Source Adjustable Summary) API allows a developer to retrieve an adjustable summary calculation for a specified self-employment or UK property business for a given accounting period.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/self-assessment-bsas-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,CIS Deductions (MTD),"Under the Construction Industry Scheme (CIS), contractors deduct money from a subcontractor’s payments and pass it to HM Revenue and Customs (HMRC). The deductions count as advance payments towards the subcontractor’s tax and National Insurance.\n\nContractors must register for the scheme. Subcontractors don’t have to register, but deductions are taken from their payments at a higher rate if they’re not registered.\n\nHere a developer can:\n\n- create CIS deductions where they have not previously registered with HMRC\n- amend CIS deductions which have been previously populated when creating their record\n- retrieve a list of CIS deductions for a subcontractor that has been previously populated\n- remove CIS deductions that have been previously populated\n\n\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/cis-deductions-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Individual Calculations (MTD),The individual calculations API allows a self-assessment taxpayer via software to:\n\n- trigger a self-assessment tax calculation\n- list all their self-assessment tax calculations for a tax year\n- retrieve their self-assessment tax calculation result using multiple endpoints\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-calculations-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Individual Losses (MTD),This API allows software packages to show and provide a taxpayer's financial data for their Brought Forward Losses and Loss Claims.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-losses-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Obligations (MTD),This API allows a developer to:\n\n- retrieve obligations for a user's business income sources\n- retrieve the crystallisation obligations for a user's Income Tax account\n- retrieve the End of Period Statement obligations for a user's business income sources\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/obligations-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Self Assessment (MTD),"This API is monolithic and is in the process of being broken down to more granular APIs.\n\nOnly taxpayers subscribed to Making Tax Digital for Business for tax years 2017/18 onwards can use the API.\n\nAs part of the subscription process, the user supplies HMRC with the following information:\n\n- the name of their business\n- their accounting period\n- whether they use cash or accruals accounting\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api?filter=self-assessment,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Self Assessment Accounts (MTD),"The Self Assessment Accounts API allows a developer to:\n\n- retrieve the overall liability broken down into overdue, payable and pending amounts\n- retrieve a list of charges and payments for a given date range\n- retrieve more detail about a specific transaction\n- retrieve a list of charges made to an account for a given date range\n- retrieve the history of changes to an individual charge\n- retrieve a list of payments for a given date range\n- retrieve the allocation details of a specific payment against one or more liabilities\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/self-assessment-accounts-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Lifetime ISA,This API allows financial organisations to report Lifetime ISA (LISA) information to HM Revenue and Customs (HMRC) and get information about payments made by HMRC.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/lisa-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,National Insurance,This API retrieves an annual summary of an individual taxpayer's class 1 total earnings and class 2 National Insurance contributions due for a given tax year.\n\nIts primary use is for the calculation of a self-employed taxpayer's National Insurance liability within the Self Assessment tax calculation.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/national-insurance,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Marriage Allowance,"Marriage Allowance lets the lower earner of a couple transfer some of their Personal Allowance to their husband, wife or civil partner. If they are eligible this will then lower their tax bill.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/marriage-allowance,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Relief at Source,Check if a pension scheme member is a resident in Scotland or Wales for tax purposes. Pension scheme administrators need this for relief at source claims.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/ras-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Individual Benefits,"This API provides information about an employee’s or director’s benefits for a given tax year, as reported to HMRC by their employer or employers through the PAYE process. For example company cars and fuel, interest-free and low interest loans, private medical and dental insurance.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-benefits,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2023-05-02,https://api.service.hmrc.gov.uk,Individual Employment,"This API provides information about an individual's history of employment for a given tax year, as reported to HMRC by their employer or employers through the PAYE process.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-employment,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Individual Income,"This API provides the following information about an individual's income for a given tax year:\n\n- income from employments, as reported to HMRC by their employer or employers through the PAYE process\n- income from pensions (other than state pension) and retirement annuities\n- income from other state benefits, such as taxable Incapacity Benefit or contribution-based Employment and Support Allowance.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-income,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Individual Tax,"This API provides the following information about an individual's tax record for a given year:\n\n- tax deducted from annual gross income for a given employment and tax year\n- tax deducted from pensions (other than state pension) or retirement annuities\n- tax deducted from Incapacity Benefit\n\nThe API also provides information about tax refunded, or set off, within this tax year. For example a repayment of CIS deductions (if you work in the construction industry), PAYE tax or tax paid on savings income. It may also be an amount that HMRC has reallocated to an existing debt.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/individual-tax,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,VAT (MTD),"Making Tax Digital introduces digital record-keeping for VAT-registered businesses. For businesses that are above the VAT threshold, it is mandatory to use this service. Those that are below the threshold can use this service voluntarily. HMRC customers (and their agents) will use digital record-keeping software to interact directly with our systems via the MTD APIs.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.",https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-02,2020-09-02,https://api.service.hmrc.gov.uk,Push Pull Notifications,Use the Push Pull Notifications API to get notifications (pull) and to send notifications (push) automatically.\nOther HMRC APIs create notifications in response to events like asynchronous API requests.\n\nThe sandbox endpoint is `https://test-api.service.hmrc.gov.uk`.,https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/push-pull-notifications-api,,SDSTeam@hmrc.gov.uk,,,,hm-revenue-customs
2020-09-05,2022-02-15,https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/latest/tables/measures-on-declarable-commodities/data?format=csv&download,UK Global Tariff (measures on declarable commodities),"The UK Global Tariff (UKGT) is the UK's first independent tariff policy which replaced the EU Common External Tariff (CET) which applied until 31 December 2020. This tariff entered into force on 1 January 2021. The UKGT applies to all goods imported into the UK. It lists preferential measures where the UK has entered into a new trade agreement or arrangement with a third country or territory. For other countries and territories, it shows the UK's Most Favoured Nation (MFN) tariffs. The dataset does not include other import duties (such as VAT) and details of quota volumes.\n\nThis table (one of 3 available) is an expanded table showing the measures that apply to all declarable commodity codes. These are 10-digit codes which are at the lowest level in the commodity code hierarchy (for example, when they do not have any commodity codes below them in the hierarchy) and are therefore at the most granular classification for that product. Any code in this table is usable on declarations at the rates specified.\n\nThe tariffs in this dataset are a representation of future events and as such are subject to change.\n\nYou can use this data when you need to make a calculation against the new duties that apply in the UK. You cannot use this data to calculate the total cost of an import because it does not include VAT. You also cannot use this data to understand the commodity code hierarchy because not all codes are present.\n\nParameters can be specified to the API to filter the returned results. See the metadata at the above link for more information on how to access the API and how to use the filters.",https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/latest/metadata?format=html,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,,,,,department-for-business-and-trade
2020-09-05,2022-02-15,https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/latest/tables/measures-as-defined/data?format=csv&download,UK Global Tariff (measures as defined),"The UK Global Tariff (UKGT) is the UK's first independent tariff policy which replaced the EU Common External Tariff (CET) which applied until 31 December 2020. This tariff entered into force on 1 January 2021. The UKGT applies to all goods imported into the UK. It lists preferential measures where the UK has entered into a new trade agreement or arrangement with a third country or territory. For other countries and territories, it shows the UK's Most Favoured Nation (MFN) tariffs. The dataset does not include other import duties (such as VAT) and details of quota volumes.\n\nThis table (one of 3 available) is a smaller table showing where in the commodity code hierarchy each measure is defined. This includes commodity codes which are not declarable. Codes are organised in a hierarchy with the 'indent' column identifying the depth of the code. Measures apply to all of the codes in the hierarchy below where they are defined.\n\nThe tariffs in this dataset are a representation of future events and as such are subject to change.\n\nYou can use this data when you need to make a calculation against the new duties that apply in the UK. You cannot use this data to calculate the total cost of an import because it does not include VAT. You also cannot use this data to understand the commodity code hierarchy because not all codes are present.\n\nParameters can be specified to the API to filter the returned results. See the metadata at the above link for more information on how to access the API and how to use the filters.",https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/latest/metadata?format=html,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,,,,,department-for-business-and-trade
2020-10-05,2020-10-05,http://api.tfwm.org.uk/,Transport for West Midlands API,"The Transport for West Midlands API provides information about bus and tram services in the West Midlands. This includes station locations, timetables, routes and real-time predicted departures.",https://api-portal.tfwm.org.uk/docs#/,,,,,,west-midlands-combined-authority
2020-10-05,2020-10-05,https://discovery.nationalarchives.gov.uk/API,Discovery,"Our Discovery application programming interface (API) is designed to maximise access to the information held in The National Archives' Discovery service. Discovery holds more than 35 million descriptions of records held by The National Archives and more than 2,500 archives and institutions across the United Kingdom, as well as a smaller number of archives around the world.\n\nThe information in Discovery is made up of record descriptions provided by or derived from the catalogues of the different archives. Discovery also contains significant information on hundreds of thousands of record creators from anonymous diarists to the world renowned.\n\nThe API is open and a [sandbox](https://discovery.nationalarchives.gov.uk/API/sandbox/index#!/) and documentation are provided.",http://www.nationalarchives.gov.uk/help/discovery-for-developers-about-the-application-programming-interface-api/,,discovery@nationalarchives.gov.uk,,,,the-national-archives
2020-10-12,2020-10-28,https://github.com/alphagov/courts-api,GOV.UK Courts and Tribunals Publishing API,This app is for publishing courts and tribunals information to GOV.UK. The (initial) intended user is [Ministry of Justice's Courts and Tribunal Finder admin app](https://github.com/ministryofjustice/courtfinder).,https://github.com/alphagov/courts-api/blob/master/doc/api-specification.md,,,,,,ministry-of-justice
2023-02-20,2023-02-20,https://sign-in.hmpps.service.justice.gov.uk/auth,HMPPS Auth,The service provides access to HMPPS internal services.,https://github.com/ministryofjustice/hmpps-auth,,,,,,ministry-of-justice
2020-10-12,2020-10-28,https://github.com/ministryofjustice/money-to-prisoners-api,Money to Prisoners API,Backend and internal admin site for [Prisoner Money suite of apps](https://github.com/ministryofjustice/money-to-prisoners).,https://github.com/ministryofjustice/money-to-prisoners-api#api-documentation,,,,,,ministry-of-justice
2023-02-20,2023-02-20,https://api.prison.service.justice.gov.uk/swagger-ui.html,Prison API,The service provides REST access to the Nomis Oracle DB prisoner information.,https://github.com/ministryofjustice/prison-api,,,,,,ministry-of-justice
2020-10-12,2020-10-28,https://data.police.uk/api/,Police API,"The API provides a rich data source for information, including:\n\n- neighbourhood team members\n- upcoming events\n- street-level crime and outcome data\n- nearest police stations\n\nThe API is implemented as a standard JSON web service using HTTP GET and POST requests. Full request and response examples are provided in the documentation.",https://data.police.uk/docs/,,https://data.police.uk/contact/,,,,uk-police
2020-10-12,2020-10-28,https://api.tfl.gov.uk/,Transport for London Unified API,"OpenAPI / Swagger spec: https://api.tfl.gov.uk/swagger/docs/v1 <br> Swagger UI is here : https://api.tfl.gov.uk/swagger/ui/index.html <br> To use the Unified API, developers should register for an Application ID and Key. Append the `app_id` and `app_key` query parameters to your requests.\n\nThe public TfL data (or 'open data') released here is for open data users to use in their own software and services. We encourage software developers to use this data to present customer travel information in innovative ways - providing they adhere to the transport data terms and conditions.",https://api.tfl.gov.uk/,,,,,,transport-for-london
2020-10-12,2020-10-28,https://github.com/DFE-Digital/eapim-platform-api,DfE EAPIM Platform API,"Enterprise API Management Platform API for managing applications, subscriptions and retreiving API details.",https://github.com/DFE-Digital/eapim-platform-api,,,,,,department-for-education
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/domestic/search,Energy Performance Certificates - Domestic Buildings Search API,Allows searching and filtering of our property-level open data on Energy Performance of buildings by one or any combination of the following attributes:\n\n- address\n- postcode\n- local authority\n- parliamentary constituency\n- type of property\n- energy band\n- date that the EPC was lodged on the register,https://epc.opendatacommunities.org/docs/api/domestic#domestic-search,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/domestic/certificate/:lmk-key,Energy Performance Certificates - Domestic Certificates API,"Retrieves full details for a particular Energy Performance Certificate, where `:lmk-key` is the LMK key of a certificate from a search result or download. For example we can request the certificate with an LMK key of `219873319402019053122194154717408` by making a request to the API at the URL: `https://epc.opendatacommunities.org/api/v1/domestic/certificate/219873319402019053122194154717408`.",https://epc.opendatacommunities.org/docs/api/domestic#domestic-cert,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/domestic/recommendations/:lmk-key,Energy Performance Certificates - Domestic Certificate Recommendations API,"Retrieves full details of recommendations made for a particular Energy Performance Certificate. If the property has no recommendations a `HTTP 404 not found` status code will be returned. Note that this API route does not recognise the `application/zip` mime type. Recommendations are keyed on the certificate's lmk-key, which can be obtained from the certificate's `lmk-key` field.",https://epc.opendatacommunities.org/docs/api/domestic#domestic-recommendations,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/non-domestic/search,Energy Performance Certificates - Non-domestic Buildings Search API,Allows searching and filtering of our property-level open data on Energy Performance of buildings by one or any combination of the following attributes:\n\n- address\n- postcode\n- local authority\n- parliamentary consistency\n- type of property\n- energy band\n- date that the EPC was lodged on the register,https://epc.opendatacommunities.org/docs/api/non-domestic#non-domestic-search,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/non-domestic/certificate/:lmk-key,Energy Performance Certificates - Non-domestic Certificates API,"Retrieves full details for a particular Energy Performance Certificate, where `:lmk-key` is the LMK key of a certificate from a search result or download. For example we can request the certificate with an LMK key of `89931970062019053113040836250130` by making a request to the API at the URL: `https://epc.opendatacommunities.org/api/v1/non-domestic/certificate/89931970062019053113040836250130`.",https://epc.opendatacommunities.org/docs/api/non-domestic#non-domestic-cert,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/non-domestic/recommendations/:lmk-key,Energy Performance Certificates - Non-domestic Recommendations API,"Retrieves full details of recommendations made for a particular Energy Performance Certificate. If the property has no recommendations a `HTTP 404 not found` status code will be returned. Note that this API route does not recognise the `application/zip` mime type. Recommendations are keyed on the certificate's lmk-key, which can be obtained from the certificate's `lmk-key` field.",https://epc.opendatacommunities.org/docs/api/non-domestic#non-domestic-recommendations,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/display/search,Energy Performance Certificates - Display (public buildings) certificates search API,Allows searching and filtering of our property-level open data on Energy Performance of buildings by one or any combination of the following attributes:\n\n- address\n- postcode\n- local authority\n- parliamentary consistency\n- type of property\n- energy band\n- date that the EPC was lodged on the register,https://epc.opendatacommunities.org/docs/api/display#display-search,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/display/certificate/:lmk-key,Energy Performance Certificates - Display (public buildings) Certificates API,"Retrieves full details for a particular Energy Performance Certificate, where `:lmk-key` is the LMK key of a certificate from a search result or download. For example we can request the certificate with an LMK key of `27649711032019053114460431000094` by making a request to the API at the URL: `https://epc.opendatacommunities.org/api/v1/display/certificate/27649711032019053114460431000094`.",https://epc.opendatacommunities.org/docs/api/display#display-cert,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://epc.opendatacommunities.org/api/v1/display/recommendations/:lmk-key,Energy Performance Certificates - Display (public buildings) Recommendations API,"Retrieves full details of recommendations made for a particular Energy Performance Certificate. If the property has no recommendations a `HTTP 404 not found` status code will be returned. Note that this API route does not recognise the `application/zip` mime type. Recommendations are keyed on the certificate's lmk-key, which can be obtained from the certificate's `lmk-key` field.",https://epc.opendatacommunities.org/docs/api/display#display-recommendations,https://epc.opendatacommunities.org/docs/copyright,opendatacommunities@communities.gov.uk,England and Wales,2018-02-26,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,https://opendatacommunities.org/sparql,OpenDataCommunities (Official statistics from MHCLG) SPARQL endpoint,A facility to write and run queries to link and extract data from multiple data sources.   Uses the SPARQL 1.1 standard and syntax.,https://opendatacommunities.org/help,"Licenced per dataset, but mostly OGL ",opendatacommunities@communities.gov.uk,England and Wales,2013-12-01,optional,ministry-of-housing-communities-local-government
2020-11-05,2020-11-05,http://opendatacommunities.org/resource?uri={url-encoded-resource-uri},OpenDataCommunities (Official statistics from MHCLG.) LinkedData resource API,A URL pattern for accessing information about individual resources in OpenDataCommunities.,https://opendatacommunities.org/help,"Licenced per dataset, but mostly OGL ",opendatacommunities@communities.gov.uk,England and Wales,2013-12-01,optional,ministry-of-housing-communities-local-government
2020-11-12,2020-11-12,https://spatialdata.gov.scot/geonetwork/srv/api,GeoNetwork REST API,"The Scottish Spatial Data Infrastructure API endpoint allows access to all the functionality of the Geonetwork metadata catalog. Whilst some functionality is limited to authenticated users and administrators only, published metadata records can be returned using the `records` endpoint and the record UUID, for example `https://spatialdata.gov.scot/geonetwork/srv/api/records/{uuid}`.",https://spatialdata.gov.scot/geonetwork/doc/api,,SSDI.Metadata@gov.scot,Scotland,,,scottish-government
2020-02-26,2020-02-06,https://uk-air.defra.gov.uk/sos-ukair/service?service=SOS&request=GetCapabilities,UK-AIR Sensor Observation Service,"This is an [OGC](https://www.ogc.org/) standards based Sensor Observation Service interface to Defra's UK Air Information Resource (UK-AIR). The service supports the UK obligations to European air quality e-Reporting initiative and Defra Open Data policy. The SOS provides a machine readable access point for air pollution measurements funded by Defra, Scottish Government, Welsh Government and Department of the Environment Northern Ireland. The service implements [INSPIRE guidelines](https://inspire.ec.europa.eu/id/document/tg/download-sos). You can read more about the [European air quality e-Reporting initiative](http://www.eionet.europa.eu/aqportal) and the [OGC SOS 2.0 standard](https://www.ogc.org/standards/sos).",https://uk-air.defra.gov.uk/data/about_sos,,The service provider is described on the Capabilities document as: Ricardo Energy & Environment (http://ee.ricardo.com/cms/). The phone number and email address are on the GetCapabilities response document in the <ows:ServiceProvider> element.,,,,defra
2021-03-09,2021-03-09,https://api.familyinfo.buckinghamshire.gov.uk/api/v1/services,Services,Use this API to search for community and volunteer-run services in Buckinghamshire. It is a partial implementation of the [Open Referral UK](https://openreferraluk.org/) standard for human services data.,https://github.com/wearefuturegov/outpost-api-service/wiki,,fisdigital@buckinghamshire.gov.uk,Buckinghamshire,2021-03-01,,buckinghamshire-council
2021-03-09,2021-03-09,https://www.gov.uk/api/debt-respite-scheme,Debt Respite Scheme (Breathing Space),"The Debt Respite Scheme (Breathing Space) will give someone in problem debt the right to legal protections from their creditors.\n\nThis API allows money advisers to manage their clients through a breathing space, whilst also allowing creditors to digitally interact with the service.\n\nYou can read more in:\n\n- [Debt Respite Scheme (Breathing Space) - guidance for money advisers](https://www.gov.uk/government/publications/debt-respite-scheme-breathing-space-guidance/debt-respite-scheme-breathing-space-guidance-for-money-advisers)\n- [Debt Respite Scheme (Breathing Space) - guidance for creditors](https://www.gov.uk/government/publications/debt-respite-scheme-breathing-space-guidance/debt-respite-scheme-breathing-space-guidance-for-creditors)",https://gitlab.com/breathing-space-scheme/breathing-space,,itproblems.breathingspace@insolvency.gov.uk,England and Wales,2021-05-04,,Insolvency-service
2022-01-07,2022-01-07,https://naptan.api.dft.gov.uk/swagger/index.html,National Public Transport Access Nodes (NaPTAN) and National Public Transport Gazetteer (NPTG) API,"The NaPTAN & NPTG API can be used to automatically download transport, gazetteer and locality data.\n\nThe API has three endpoints. The NaPTAN API allows you to download data either by ATCOAreaCode, a group of ATCOAreaCodes or the whole national dataset. The NPTG API allows you to download national gazetteer dataset. The NPTG localities API allows you to download national localities' dataset.\n\nThe NaPTAN & NPTG data are available in either XML or CSV format.",https://naptan.api.dft.gov.uk/swagger/index.html,,https://beta-naptan.dft.gov.uk/,"England, Scotland and Wales",,,department-for-transport
2022-01-24,2022-01-24,https://api.apprenticeships.education.gov.uk/vacancies,Display vacancy advert API,The display vacancy advert API allows you to retrieve recruitment adverts from Find an apprenticeship. You can filter results based upon a variety of criteria in order to display the returned adverts on your own website.,https://developer.apprenticeships.education.gov.uk/,,Details available on developer portal,,,,the-apprenticeship-service
2022-01-24,2022-01-24,https://api.apprenticeships.education.gov.uk/managevacancies,Recruitment API,The Recruitment API allows you to create an advert on Find an apprenticeship using your existing systems. Submitting a new vacancy advert via this API will create the vacancy advert in the live system. We provide a sandbox version of the API which you can use for testing purposes. The sandbox is available at: https://api-sandbox.apprenticeships.education.gov.uk/managevacancies. Note: In order to use the Recruitment API you need to obtain an API key from either an Employer or Training Provider registered on the Apprenticeship Service. More information is available on the developer portal.,https://developer.apprenticeships.education.gov.uk/,,Details available on developer portal,,,,the-apprenticeship-service
2022-01-31,2022-01-31,https://data-api.cefas.co.uk/,Cefas Data Portal APIs,"A suite of APIs which allow external interaction with all metadata and data published via our data portal (https://data.cefas.co.uk/), the portal covers many marine science themes including fisheries, biodiversity, environmental monitoring and aquaculture. Our metadata follow the MEDIN standard (https://medin.org.uk/medin-discovery-metadata-standard) which is compatible with UK GEMINI and INSPIRE. Our datasets do not currently follow one particular data standard. We are currently undertaking a pilot project which will implement the OGC EDR standard (https://ogcapi.ogc.org/edr/) to a subset of our data.",https://www.cefas.co.uk/data-and-publications/cefas-data-hub-apis/,,Data Governance Strategy and Support Team - data.manager@cefas.co.uk,Global,,,cefas
2022-02-01,2022-02-01,https://sensors.bgs.ac.uk/FROST-Server/v1.1,BGS Sensor Data Service,"This service provides an application programming interface (API) for data scientists, software developers and software applications to query and download BGS-hosted sensor data in machine-readable JSON format. The API is powered by FROST Server and conforms to the OGC SensorThings API specification (https://www.ogc.org/standards/sensorthings). See https://sensors.bgs.ac.uk/ for details, videos and code examples.",https://sensors-docs.bgs.ac.uk/,Open Government License,BGS Enquiries - enquiries@bgs.ac.uk,"England, Scotland and Wales",,,bgs
2022-02-01,2022-02-01,https://ogcapi.bgs.ac.uk/openapi?f=json,BGS OpenGeoscience OGCAPI Server,"This server provides endpoints for a selection of BGS geospatial data using the OGCAPI suite of standards (https://ogcapi.ogc.org/). Data includes; geology, sensor, earthquake, landslide and borehole data. The BGS has a wide range of datasets and wants to increase access to these, publishing as many as possible under Open Government Licence. The API is powered by https://pygeoapi.io/",https://ogcapi.bgs.ac.uk/openapi?f=html,Data under Open Government License,BGS Enquiries - enquiries@bgs.ac.uk,"England, Scotland and Wales",,,bgs
2022-02-01,2023-04-20,https://agsapi.bgs.ac.uk/openapi.json,AGS File Utilities Tool and API,"The tool (https://agsapi.bgs.ac.uk/) and associated API allow schema validation, data validation and conversion of your geotechnical AGS files, also offers generated graphical logs of AGS data held by the BGS. Features include; Accepts multiple AGS files, Tests AGS versions 4.x only, Files are not saved or stored by this tool. The codebase is available at https://github.com/BritishGeologicalSurvey/pyagsapi",https://agsapi.bgs.ac.uk/docs,Codebase is under LGPL v3.0,BGS Enquiries - enquiries@bgs.ac.uk,Global,,,bgs
2022-02-03,2022-02-03,https://admiraltyapi.developer.azure-api.net/product#product=tidal-api-foundation,Tidal API - Foundation,"The Tidal API provides an authoritative source of tidal height predictions for Standard and Secondary tidal level stations. Also, now available are Tidal Stream Events for a range of geographic locations.\n\nFoundation provides a 1-year subscription to access the current plus 13 days’ worth of tidal height and stream events for a wide range of tidal height stations and stream locations around the British Isles and Ireland. This includes The Isle of Man and The Channel Islands consisting of the Bailiwicks of Jersey and Guernsey.\n\n- 20 calls per second\n\n- 20,000 calls per month\n\n- 1 year subscription - £120 ex VAT",https://developer.admiralty.co.uk/api-details#api=uk-tidal-api-foundation&operation=5da44920154665d3830ce356,,customerservices@ukho.gov.uk,The United Kingdom and Ireland,,,uk-hydrographic-office
2022-02-03,2022-02-03,https://developer.admiralty.co.uk/product#product=tidal-api-premium,Tidal API - Premium,"The Tidal API provides an authoritative source of tidal height predictions for Standard and Secondary tidal level stations. Also, now available are Tidal Stream Events and Rates for a range of geographic locations.\n\nPremium provides access to historical and the current plus 1 years’ worth of tidal events and interval predictions for a wide range of tidal height stations and stream locations around the British Isles and Ireland. This includes The Isle of Man and The Channel Islands consisting of the Bailiwicks of Jersey and Guernsey.\n\n- 100 calls per second\n\n- 100,000 calls per month\n\n- 1 year subscription - £300 ex VAT",https://developer.admiralty.co.uk/api-details#api=uk-tidal-api-premium&operation=5da449682480b97291c1235c,,customerservices@ukho.gov.uk,The United Kingdom and Ireland,,,uk-hydrographic-office
2022-02-15,2022-02-15,https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/latest/tables/commodities/data?format=csv&download,UK Global Tariff (commodities),"The UK Global Tariff (UKGT) is the UK's first independent tariff policy which replaced the EU Common External Tariff (CET) which applied until 31 December 2020. This tariff entered into force on 1 January 2021. The UKGT applies to all goods imported into the UK. It lists preferential measures where the UK has entered into a new trade agreement or arrangement with a third country or territory. For other countries and territories, it shows the UK's Most Favoured Nation (MFN) tariffs. The dataset does not include other import duties (such as VAT) and details of quota volumes. This table (one of 3 available) shows all of the commodities that are part of the UK's goods classification and their English descriptions.\n\n Codes are organised in a hierarchy with each ""parent"" code having zero or more ""child"" codes that represent a more specific classification of the parent commodity. \n\nCommodities at all depths of the commodity hierarchy are included, but only commodities without any children codes are declarable. The current parent code of each commodity code is also listed and is accurate at the time the file was generated – note that parent codes can change over time. \n\nThe tariffs in this dataset may be a representation of future events and as such are subject to change. \n\nYou can use this data when you need to make a calculation against the new duties that apply in the UK. You cannot use this data to calculate the total cost of an import because it does not include VAT.",https://data.api.trade.gov.uk/v1/datasets/uk-tariff-2021-01-01/versions/v2.2.0/metadata?format=html,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,,,,,department-for-business-and-trade
2022-02-15,2022-02-15,https://data.api.trade.gov.uk/v1/datasets/uk-trade-quotas/versions/v1.0.22/reports/quotas-including-current-volumes/data?format=csv&download,UK Trade Quotas,"This dataset shows the quotas available in the UK Tariff along with their current or final balances, updated daily. \n\nYou can use this data to analyse quota applicability and utilisation in bulk, and to understand trends in quota application and usage over time. \n\nPlease see the full UK Trade Quotas summary for detailed information on what this dataset contains and what it can be used for. \n\nParameters can be specified to the API to filter the returned results. See the metadata at the documentation link for more information on how to access the API and how to use the filters.",https://data.api.trade.gov.uk/v1/datasets/uk-trade-quotas/versions/v1.0.22/metadata?format=html,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,,,,,department-for-business-and-trade
2022-09-28,2022-10-11,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/ApplicationEnquiryV1_0WebService?wsdl,Application Enquiry,"Use this service to view applications that are not yet completed by HM Land Registry. Use this service to find out: an application's progress status, the reason for application delays, information about recently completed or cancelled applications, the full priority period for Official Searches. \n\nPoll Request Service URL for production environment: https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/ApplicationEnquiryV1_0PollRequestWebService?wsdl \n\nTest environment URL: https://bgtest.landregistry.gov.uk/b2b/BGStubService/ApplicationEnquiryV1_0WebService?wsdl \n\nPoll Request Service URL for test environment: https://bgtest.landregistry.gov.uk/b2b/BGStubService/ApplicationEnquiryV1_0PollRequestWebService?wsdl",https://landregistry.github.io/bgtechdoc/services/application_enquiry/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2022-10-11,2022-10-11,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/DischargeActivityV1_0WebService?wsdl,Discharge Enquiry,Use this service to check if any charges have been removed in the previous 30 days. \n\n Poll Request Service URL for production environment: https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/DischargeActivityV1_0PollRequestWebService?wsdl \n\n Test environment URL: https://bgtest.landregistry.gov.uk/b2b/BGStubService/DischargeActivityV1_0WebService?wsdl \n\n Poll Request Service URL for test environment: https://bgtest.landregistry.gov.uk/b2b/BGStubService/DischargeActivityV1_0PollRequestWebService?wsdl,https://landregistry.github.io/bgtechdoc/services/discharge_activity/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2022-11-24,2022-11-23,https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/EDocumentRegistrationV2_1WebService?wsdl,e-Document Registration Service,Use this service to: \n\n send applications to change the register \n\n - automate the collection of correspondence and responses \n\n - receive the completed application back \n\n If you are a software developer: \n\n - Use this document to integrate data into your system  \n\n Poll Request Service URL for production environment \n\n https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/EDocumentRegistrationV2_1PollRequestWebService?wsdl \n\n Attachment Service URLs: \n\n https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/AttachmentV2_1WebService?wsdl \n\n https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/AttachmentV2_1PollRequestWebService?wsdl \n\n Correspondence/Requisition URL: \n\n https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/CorrespondenceV2_1PollRequestWebService?wsdl \n\n Early Completion URL: \n\n https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine/EarlyCompletionV2_1PollRequestWebService?wsdl \n\n For test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/ECDRS_SoapEngine with https://bgtest.landregistry.gov.uk/b2b/ECDRS_StubService,https://landregistry.github.io/bgtechdoc/services/edrs/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2023-01-10,2023-01-10,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/FullSearchV2_1WebService?wsdl,Land Charges Full Search,A land charge is an interest in land that imposes an obligation on the landowner in favour of some other person. Use this service to request an official search of the Land Charges Register.\n\n If you're a software developer: \n\n - Use this document to integrate data into your system.\n\n Poll Request Service URL for production environment:\n\n https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/FullSearchV2_1PollRequestWebService?wsdl \n\n For test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine with https://bgtest.landregistry.gov.uk/b2b/BGStubService,https://landregistry.github.io/bgtechdoc/services/land_charges_full_search/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2023-02-13,2023-02-13,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/BankruptcySearchV2_1WebService?wsdl,Land Charges Bankruptcy Search,Use this service to find bankruptcy details on the Land Charges Register.\n\nIf you’re a software developer\n\n - Use this document to integrate data into your system.\n\nPoll Request Service URL for production environment:\n\nhttps://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/BankruptcySearchV2_1PollRequestWebService?wsdl\n\nFor test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine with https://bgtest.landregistry.gov.uk/b2b/BGStubService,https://landregistry.github.io/bgtechdoc/services/land_charges_bankruptcy_search/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2023-02-20,2023-02-20,https://businessgateway.landregistry.gov.uk/b2b/ECLLC_SoapEngine/LLCSearchV2_0WebService?wsdl,Local Land Charges Search,"Local Land Charges are financial charges or restrictions on the use of a property or area of land.\n\nWe’re working with local authorities across the country to standardise and migrate charges. This creates a single register that is up to date and accessible to all.\n\nUse the Local Land Charges service to find details of entries relating to land or property.\n\nIf you’re a software developer\n\n - Use this document to integrate data into your system.\n\nFor test environment endpoint, replace https://businessgateway.landregistry.gov.uk/b2b/ECLLC_SoapEngine with https://bgtest.landregistry.gov.uk/b2b/ECLLC_StubService",https://landregistry.github.io/bgtechdoc/services/local_land_charges_search/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2023-02-20,2023-02-20,https://directory.southampton.gov.uk/api/services,Directory of support services,"The Southampton directory API is an Open Referral UK standard API of support services relevant to the city of Southampton, including adult social care, early years and childcare and SEND local offer services.",,,directory@southampton.gov.uk,Southampton,2023-31-01,,scc
2023-05-16,2023-05-16,,Subscription Service API,ECNS subscription API allows other government departments and organisations to register or de-register subscriptions to citizen updates.,,ISC,dcbt.ogd@DWP.GOV.UK,Digital,,,department-for-work-and-pensions
2023-09-06,2026-03-31,https://businessgateway.landregistry.gov.uk/bg2/s1/v1,Official Copy Document Availability,"Check which register referred documents are available for immediate download. Use a title number to find out the Official Copy Document Availability status via a RESTful API. When you know what is available, you can order using the Official Copy Title Known service (https://landregistry.github.io/bgtechdoc/services/official_copy_title_known).\n\nTest URL:\n\nhttps://bgtest.landregistry.gov.uk/bg2test/s1/v1/titles/[title_number]/official-copies/availability\n\nWhere [title_number] is replaced by the title number you need to use.",https://landregistry.github.io/bgtechdoc/services/official_copy_document_availability_v1/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2026-03-31,2026-03-31,https://businessgateway.landregistry.gov.uk/bg2/api/v2/titles/{title_number}/official-copies/availability,Official Copy Document Availability V2,"Check which register referred documents are available for immediate download. Use a title number to find out the Official Copy Document Availability status via a RESTful API. When you know what is available, you can order using the Official Copy Title Known service (https://landregistry.github.io/bgtechdoc/services/official_copy_title_known/).\n\nTest URL:\n\nhttps://bgtest.landregistry.gov.uk/bg2test/api/v2/titles/[title_number]/official-copies/availability\n\nWhere [title_number] is replaced by the title number you need to use.",https://landregistry.github.io/bgtechdoc/services/official_copy_document_availability_v2/#official-copy-document-availability-v2,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2026-03-31,2026-03-31,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/EnquiryByPropertyDescriptionV2_0WebService?wsdl,Search by Property Description,"Use this service to find out the title number and tenure of a property based on the address supplied.\n\nPoll Request Service URL for production environment:\n\nhttps://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/EnquiryByPropertyDescriptionV2_0PollWebService?wsdl\n\nFor test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine with https://bgtest.landregistry.gov.uk/b2b/ECBG_StubService",https://landregistry.github.io/bgtechdoc/services/search_property_description/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/National_Heritage_List_for_England_NHLE_v02_VIEW/FeatureServer,National Heritage List for England (NHLE),"The National Heritage List for England (NHLE) is the only official, up to date, register of all nationally protected historic buildings and sites in England - listed buildings, scheduled monuments, protected wrecks, registered parks and gardens, and battlefields. This data uses the British National Grid (EPSG:27700) spatial reference. It contains points and polygons for Listed Buildings, Building Preservation Notices and Certificates of Immunity. Data is updated daily.\n\n‘Listing’ is the all-encompassing term for the legal protection given to a building, monument, structure or site through the planning system. It is recognition of historical, architectural or archaeological significance, intended to ensure that the character of the asset in question is preserved for future generations. The main types of Listing are:\n\nListed Buildings\n\nScheduled Monuments\n\nRegistered Parks and Gardens\n\nRegistered Battlefields\n\nProtected Wreck Sites\n\nWorld Heritage Sites",,Open Government Licence,gis@historicengland.org.uk,England,2023-03-20,,historic-england
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/Conservation_Areas/FeatureServer,Conservation Areas,"Conservation Areas in England as designated by Local Planning Authorities and compiled by Historic England\n\nConservation areas exist to manage and protect the special architectural and historic interest of a place - in other words, the features that make it unique. Every local authority in England has at least one conservation area and there are around 10,000 in England.Most conservation areas are designated by the Council as the local planning authority. In conservation areas there are some extra planning controls and considerations in place to protect the historic and architectural elements which make the place special.\n\nThis national dataset is “indicative” not “definitive”. Definitive information can only be provided by individual local authorities and you should refer directly to their information for all purposes that require the most up to date and complete dataset. Conservation area data has not been supplied for all local authority areas. Local authority areas without conservation area data are attributed with 'No data currently available for this district'.",,Open Government Licence,gis@historicengland.org.uk,England,2007-01-01,,historic-england
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/HE_AIM_data/FeatureServer,Historic England Aerial Investigation Mapping data,"Spatial data depicting archaeology that has been identified, mapped and recorded using aerial photographs and other aerial sources across England.\n\nVarious data recorded by Historic England relating to aerial investigation and mapping projects. N.B. This is a dynamic dataset that is constantly evolving, not only with the addition of newly completed projects, but also with the reassessment of some earlier projects. See https://historicengland.org.uk/research/methods/airborne-remote-sensing/aerial-investigation/ for further details of Historic England's work with aerial sources.",,Open Government Licence,gis@historicengland.org.uk,England,2023-09-14,,historic-england
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/Greater_London___Archaeological_Priority_Areas/FeatureServer,Greater London Archaeological Priority Areas (APAs),"Archaeological Priority Areas (APAs) are areas where there is significant known archaeological interest or potential for new discoveries. APAs are used to help highlight where development might affect heritage assets. Follow this link to find out more about our APAs: https://historicengland.org.uk/services-skills/our-planning-services/greater-london-archaeology-advisory-service/greater-london-archaeological-priority-areas/\n\nAn Archaeological Priority Area is a defined area where, according to existing information, there is significant known archaeological interest or particular potential for new discoveries. APAs are set out in the London boroughs' local plans. They inform the practical use of national and local planning policies for the recognition and conservation of archaeological interest. The Greater London APAs are based on evidence held in the Greater London Historic Environment Record (GLHER).\n\nThe Greater London APAs were created in the 1970s and 1980s either by the boroughs or local museums. They are now being comprehensively updated using up to date evidence and consistent standards to comply with National Planning Policy. The new system assigns all land to one of four tiers denoting different levels of sensitivity to development indicated by an archaeological risk model.",,Open Government Licence,gis@historicengland.org.uk,Greater London,2023-08-11,,historic-england
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/Historic_England_Heritage_at_Risk_Register_2022/FeatureServer,Historic England Heritage at Risk Register 2022,"Data from the annual Heritage at Risk Register for 2022\n\nHeritage at Risk provides an understanding of the overall state of England’s heritage assets. Every year Historic England updates the Heritage at Risk Register. The end result is a dynamic picture of the sites most at risk and most in need of safeguarding for the future.\n\nAssets may be assessed by using multiple methodologies so may appear multiple times.  For example, a scheduled monument could be made up of archaeological remains and a standing structure. In this instance, the remains would be assessed using the archaeological risk assessment, and the structure using the buildings or structures assessment. Conservation Area information is not complete due to availability of Conservation Area spatial data.\n\nThis data and its spatial depictions are purely indicative and are not a definitive representation. Users are advised to seek clarification and confirmation on risk assessments from Historic England.",,Open Government Licence,gis@historicengland.org.uk,England,2023-08-25,,historic-england
2023-10-11,2023-10-11,https://services-eu1.arcgis.com/ZOdPfBS3aqqDYPUQ/arcgis/rest/services/HAR_2021_OTHR/FeatureServer,Historic England Heritage at Risk Register 2021,"Data from the annual Heritage at Risk Register for 2021\n\nHeritage at Risk provides an understanding of the overall state of England’s heritage assets. Every year Historic England updates the Heritage at Risk Register. The end result is a dynamic picture of the sites most at risk and most in need of safeguarding for the future.\n\nAssets may be assessed by using multiple methodologies so may appear multiple times.  For example, a scheduled monument could be made up of archaeological remains and a standing structure. In this instance, the remains would be assessed using the archaeological risk assessment, and the structure using the buildings or structures assessment. Conservation Area information is not complete due to availability of Conservation Area spatial data.\n\nThis data and its spatial depictions are purely indicative and are not a definitive representation. Users are advised to seek clarification and confirmation on risk assessments from Historic England.\n\nHistoric England Open Data Hub - https://historicengland.org.uk/listing/the-list/open-data-hub/",,Open Government Licence,gis@historicengland.org.uk,England,2021-10-14,,historic-england
2023-10-12,2023-10-12,https://driver-vehicle-licensing.api.gov.uk/full-driver-enquiry/v1/driving-licences/retrieve,Access to Driver Data API,"The Access to Driver Data API allows authorised consumers to retrieve the driving records of UK citizens. It returns driver data, including current driving licence details, for a supplied driving licence number.",https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/driver-view/driver-view-description.html,,ADDEnquiries@dvla.gov.uk,,,,driver-and-vehicle-licensing-agency
2023-10-12,2023-10-12,https://driver-vehicle-licensing.api.gov.uk/driver-image-service,Driver Image API,The Drivers Enquiries Image API allows authorised consumers to retrieve the photo and/or signature from the driving licence records of UK citizens.,https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/driver-image/driver-image-description.html,,Des.support@dvla.gov.uk,,,,driver-and-vehicle-licensing-agency
2023-10-12,2023-10-12,https://driver-vehicle-licensing.api.gov.uk/driver-find,Driver Find API,"The Find Driver API allows authorised external clients to retrieve summary driver data with fine-grained search criteria. It returns driver summary data, including driving licence number, last name and gender, for the supplied search criteria.",https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/drivers-find/drivers-find-description.html,,Des.support@dvla.gov.uk,,,,driver-and-vehicle-licensing-agency
2023-10-12,2023-10-12,https://driver-vehicle-licensing.api.gov.uk/kadoe/v1/vehicle-keeper,KADOE API,The DVLA Keeper At Date Of Event API is a RESTful service that provides details of a vehicle and its keeper at a point in time. The response data is provided in JSON format.,https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/kadoe/kadoe-description.html,,dvlaapiaccess@dvla.gov.uk (please include ‘KADOE API technical query’ in the subject line),,,,driver-and-vehicle-licensing-agency
2023-10-12,2023-10-12,https://businessgateway.landregistry.gov.uk/bg2/api/v1/applications/{application_reference}/estimate-completion-date,Estimated Completion Date,"Overview\n\nThe Estimated Completion Date (ECD) is a date by which the application is likely to be completed. It is not based on the individual application but is an estimate of when the majority (90%) of that application type will be completed.\n\nIn order to retain parity with our Portal customer experience, we require that anyone integrating with this service refer to the estimated completion timeframes which can be found at https://www.gov.uk/guidance/hm-land-registry-estimated-completion-timeframes. We also see benefit in end users being familiar with the above URL, the insights provided are likely to reduce the need for customer contact. Therefore we also ask that you make your customers aware of the above URL.\n\nThe ECD:\n\nIs calculated on and from the day an application is received by HMLR.\n\nMay take up to an hour to be displayed after application submission.\n\nIs updated every 30 calendar days until the application is completed or cancelled.\n\nIs updated if HMLR correspondence is issued (first item of correspondence only).\n\nFor test endpoint, replace https://businessgateway.landregistry.gov.uk/bg2 with https://bgtest.landregistry.gov.uk/bg2test",https://landregistry.github.io/bgtechdoc/services/estimated_completion_date/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2024-01-16,2024-01-16,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OfficialCopyTitleKnownV2_1WebService?wsdl,Official Copy Title Known,"To use this service you will need a title number for a property or area of land. When you have these details, you can order:\n\n- an official copy of the register\n- an official copy of the title plan\n- an official copy of a conveyance referred to on the register\n- an official copy of a deed referred to on the register\n- an official copy of the lease\n\nIf you’re a software developer:\n\nUse this document to integrate data into your system.\n\nPoll Request Service URL for production environment:\n\nhttps://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OC1TitleKnownV2_1PollRequestWebService?wsdl\n\nFor test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine with https://bgtest.landregistry.gov.uk/b2b/ECBG_StubService",https://landregistry.github.io/bgtechdoc/services/official_copy_title_known/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2024-01-23,2024-01-23,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OfficialSearchV2_1WebService?wsdl,Official Search of Whole (with priority),"An Official Search of Whole (with priority) protects agreements between buyers, sellers and lenders. Use this service when your application relates to the whole of the registered title to protect transfers, leases and mortgages. It also prevents any registrations of adverse interest for 30 business days.\n\nIt will also tell you about:\n\n- alterations made to the register since the search from date\n- applications against the title that have not yet been completed\n- existing official searches\n- outline applications that are not protected by official search\n\nIf you’re a software developer:\n\nUse this document to integrate data into your system.\n\nPoll Request Service URL for production environment:\n\nhttps://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OfficialSearchV2_1PollRequestWebService?wsdl\n\nFor test environment endpoints replace https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine with https://bgtest.landregistry.gov.uk/b2b/ECBG_StubService",https://landregistry.github.io/bgtechdoc/services/official_search_of_whole/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2024-01-24,2024-01-24,https://businessgateway.landregistry.gov.uk/bg2/api/v1/official-searches-of-whole,Official Search of Whole (with Priority) with Data,"An Official Search of Whole (with Priority) with Data protects agreements between buyers, sellers and lenders. The Official Search of Whole (with Priority) with Data RESTful API expands on the existing Official Search of Whole (with Priority) SOAP API, see HMLR Developer Pack [here](https://landregistry.github.io/bgtechdoc/services/official_search_of_whole/) for information on the existing service.\n\nEach service can be used:\n\n- when your application relates to the whole of the registered title to protect transfers, leases and mortgages.\n- both services prevent any registrations of adverse interest for 30 business days.\n\nEach service will also tell you about:\n\n- alterations made to the register since the search from date\n- applications against the title that have not yet been completed\n- existing official searches\n- outline applications that are not protected by official search\n\nFor test environment endpoint replace https://businessgateway.landregistry.gov.uk/bg2/api with https://bgtest.landregistry.gov.uk/bg2test/api",https://landregistry.github.io/bgtechdoc/services/official_search_of_whole_rest/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2024-06-11,2024-06-11,https://register-api.ofqual.gov.uk,Ofqual Register of Regulated Qualifications API,The Ofqual Register of Regulated Qualifications API allows users to programmatically access details of qualifications and awarding organisations regulated by Ofqual and CCEA Regulation.,https://github.com/OfqualGovUK/ofqual-register-api,,https://github.com/orgs/OfqualGovUK/teams/developers,,,,ofqual
2024-06-24,2024-06-24,https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OfficialSearchOfPartV2_1WebService?wsdl,Official Search of Part,"An Official Search of Part (with priority) protects agreements between buyers, sellers and lenders. Use this service when your application relates to part of a registered title, to protect transfers, leases and mortgages. It also prevents any registrations of adverse interest for 30 business days.\n\nIt will also tell you about:\n\n - alterations made on the register since the search from date\n - applications against the title not yet complete\n - existing official searches\n - outline applications that are not protected by official search\n - land to be transferred, leased or mortgaged, that falls outside of the extent of the registered title\n\n If you’re a software developer:\n\n Use this document to integrate data into your system.\n\n Poll request Service URL for production environment:\n\n https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine/OfficialSearchOfPartV2_1PollRequestWebService?wsdl \n\n For test environment endpoints, replace `https://businessgateway.landregistry.gov.uk/b2b/BGSoapEngine` with `https://bgtest.landregistry.gov.uk/b2b/BGStubService`",https://landregistry.github.io/bgtechdoc/services/official_search_of_part/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2024-12-03,2024-12-03,https://epc.opendatacommunities.org/api/v1/info,Energy Performance Certificates General Informational API,"As of December 2023, OpenAPI v3 schemas are provided for all MHCLG APIs. These schemas document all published API routes and describe the format of the supported HTTP request parameters for querying the MHCLG APIs.",https://epc.opendatacommunities.org/docs/api/info,,opendatacommunities@communities.gov.uk,,,,ministry-of-housing-communities-local-government
2025-01-06,2025-01-06,https://businessgateway.landregistry.gov.uk/b2b/EOOV_SoapEngine/OnlineOwnershipVerificationV1_0WebService?wsdl,Online Owner Verification,"Use this service to verify property ownership data against HM Land Registry property titles in real time.\n\nGet information on:\n\n- historical name matching (from 2005 onwards)\n- partial matching to increase the chances of a match\n- the option to highlight if there are other legal owners on the title\n- the option to search by title number to make sure a registered address is available\n\nFor test environment endpoint, replace https://businessgateway.landregistry.gov.uk/b2b/EOOV_SoapEngine with https://bgtest.landregistry.gov.uk/b2b/EOOV_StubService",https://landregistry.github.io/bgtechdoc/services/online_owner_verification/,,channelpartners@landregistry.gov.uk,,,,hm-land-registry
2025-03-25,2025-03-25,https://explore-education-statistics.service.gov.uk/,Explore education statistics API,"The explore education statistics API is built following REST principles and provides access to data sets published by on the explore education statistics service, allowing you to:\n\n- get summary information about data sets and their related resources\n- query data sets based on specific criteria\n- download the underlying CSV files of data sets\n\nNote that not all data sets available in EES are accessible via the API. For a full list of data sets published by EES, visit the [Data catalogue](https://explore-education-statistics.service.gov.uk/data-catalogue) on the main website.",https://api.education.gov.uk/statistics/docs/,,,,,,department-for-education
2025-04-30,2025-04-30,https://data.api.trade.gov.uk/v1/datasets/uk-business-regulations/versions/latest/data?format=json,Regulations and legislation for UK businesses,"A dataset of laws and guidance that regulate business activities in England. The dataset contains metadata about each regulatory content item and links to the original content on GOV.UK, legislation.gov.uk or the regulator’s website.\n\nThis dataset is still under development. It only includes regulations for the construction sector. It does not include content from regulators in Scotland, Wales or Northern Ireland.\n\nThis data should not be used for official analysis or reporting.",https://data.api.trade.gov.uk/v1/datasets/uk-business-regulations/versions/latest/metadata?format=html,https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/,find-business-regulations@businessandtrade.gov.uk,"England, Wales, Scotland, Northern Ireland",,,department-for-business-and-trade
2024-04-23,2024-04-23,https://data.food.gov.uk/food-alerts,Food Alerts,"The FSA Food Alerts API provides access to current and recent Food Alerts: Allergy Alerts (AA), Product Recall Information Notices (PRIN) and Food Alerts for Action (FAFA). It provides applications with the facility to list alerts matching some filter criterion, and to retrieve a description of an alert.",https://data.food.gov.uk/food-alerts/ui/reference,,data@food.gov.uk,,,,food-standards-agency
2024-04-23,2024-04-23,https://api.ratings.food.gov.uk/,Food Hygiene Ratings Scheme (FHRS),"The FHRS API provides free programmatic access to the Food Standards Agency Rating Data for England, Scotland, Wales and Northern Ireland. Developers can leverage FSA data to provide their own services and websites, allowing you to build and develop custom solutions that are consistent with the data being held and displayed by the FSA. As a developer you get access to the same data and the majority of the same functionality that is used to deliver the Food Hygiene Rating Scheme website. Other than calling the available endpoints, there are no registration requirements for developers before they can start using the Food Standards Agency data. No sign-up process, API keys, or login details are required at this time to use the service.",https://api.ratings.food.gov.uk/help,,data@food.gov.uk,,,,food-standards-agency
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/access-control-service-hl7-v3,Access Control Service HL7 V3 API,"Use this API to access the Access Control Service (ACS) - which manages consent to share patient information, including their SCR.

GP systems must check consent to share before sharing, for example, a patient's Summary Care Record (SCR).

You can:

- get the access permissions for a patient's documents, including their SCR
- set access permissions on a patient's documents, including their SCR

Note the Summary Care Record - FHIR API also has endpoints enabling you to get and set access permissions, the same as this ACS API.

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/access-control-service-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/alerts-hl7-v3,Alerts - HL7 V3 API," 

Use this API to send an alert for the attention of a Privacy Officer - also known as Summary Care Record Governance Person (SGP) in community pharmacies - so they can audit proactively whether access to a patient’s data was appropriate. 

This provides a general alerting mechanism covering, for example, when a user looks up a patient on the Summary Care Record application (SCRa).

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/alerts-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/ambulance-data-submission-fhir,Ambulance Data Submission - FHIR API,"Use this API to submit ambulance data to our Data Processing Service (DPS) so that it can be made available for analysis and review by NHS England and ambulance trusts. Ambulance data is information relating to emergency calls (999, 111 and others), received at an Emergency Operations Centre (EOC) and processed into a Computer Aided Despatch (CAD) system, including: 

- call details
- response details - including response times and episode outcome times patient
- contact details - including patient demographics, patient response details, patient information, injury information, patient assessment, medication, observations, diagnoses, conveying outcome, safeguarding and public health information

You can: 

- post ambulance data individually or in batches

You cannot: 

- read any of the records stored in DPS

The API is asynchronous - when you submit data, it acknowledges receipt without validating or processing the data first. To receive error notifications, you need to use MESH. The following diagram illustrates the end-to-end process:  The following describes the end-to-end process: 

- The ambulance trust system sends the ambulance data to the Ambulance Data Submission API.
- The Ambulance Data Submission (ADS) API forwards the ambulance data to our Data Processing System (DPS).
- If there is an error, DPS sends an error notification to MESH.
- The ambulance trust system retrieves the error notification from MESH.
- An ADS User views the ambulance data in our NHS Digital ADS Dashboards.
- The NHS Digital ADS Dashboards get the ambulance data from DPS.

 ",https://digital.nhs.uk/developer/api-catalogue/ambulance-data-submission-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/assessment-discharge-and-withdrawal-fhir,Assessment Discharge and Withdrawal - FHIR,"Use this integration to support transfer of care from hospital to social services for patients with care and support needs, as described in the Care Act 2014. It enables the exchange of structured information between hospitals and social care organisations.

You can send:

- hospital assessment notices to inform social services that an assessment of a patient's care and support needs is required
- hospital discharge notices to confirm a patient's proposed discharge date
- withdrawal notices to withdraw a previous assessment or discharge notice

You can also send an admissions notice with this integration so a hospital can inform social services that a patient has been admitted.

This is a messaging integration which uses MESH to send and receive messages.

Information Standard SCCI2075 defines the minimum data sets that you must use for Assessment, Discharge and Withdrawal (ADW) notices. For additional message guidance on the implementation and use of ADW FHIR messages and some divergences from this ADW Information Standard, see Assessment Discharge and Withdrawal - FHIR API.

This integration is in production but deprecated. Do not begin any development work using this API. 
",https://digital.nhs.uk/developer/api-catalogue/assessment-discharge-and-withdrawal-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir,Booking and Referral - FHIR API,"This API forms part of the Booking and Referral Standard (BaRS). This API specification should be used in conjunction with the BaRS implementation guide for your use case.

Use this API to send booking and referral information between NHS service providers. You can: 

- get a specific booking
- get bookings for a patient
- process a message, either a booking or a referral
- get message definition
- get capability statement
- get a specific referral
- get referrals for a patient
- get slots

The following describes the end-to-end process: 

- Send a request from your sender application to this API, along with a service identifier header.
- This API redirects the request to the service associated with the service identifier header.
- The target backend handles the request and sends a response back to this API.
- This API returns the response to your sender application.

In some Applications the target may send a follow up request to indicate the outcome of a request.

For a non-technical overview of how to build software that deals with referrals and bookings, see Building healthcare software - referrals and bookings. 



 ",https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/bowel-cancer-screening-edifact,Bowel Cancer Screening - EDIFACT,"Use this messaging integration to receive bowel cancer screening test results in primary care GP systems from the screening system, specifically faecal occult blood test (FOBT) results.

This integration uses UN/EDIFACT based messages sent over MESH.

Also known as NHS004 messages, these are a simpler version of the NHS003 messages specified in the Pathology EDIFACT v1.003 Standard but with the changes specified in 'Electronic GP Communication Requirements for GPSoC Software Suppliers Draft', under 'Additional guidance' below.

Bowel cancer screening NHS004 messages are almost the same as pathology NHS003 messages except they are much simpler in structure, with a single SNOMED code and 5 result values.

If you are building a system to receive bowel cancer screening test results, you can use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format. 

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/bowel-cancer-screening-edifact,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/cervical-screening-edifact,Cervical Screening - EDIFACT,"Use this messaging integration to send cervical screening test results from screening laboratories and receive them at the patient's registered GP practice and NHAIS systems. 

You can:

- send and receive cytology test results
- send and receive human papillomavirus (HPV) immunisation data

We also use this integration to send and receive a patient's test results history between NHAIS systems, including between England and Wales: 

 This integration uses MESH to send and receive UN/EDIFACT based messages. 
",https://digital.nhs.uk/developer/api-catalogue/cervical-screening-edifact,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/child-protection-information-sharing-hl7-v3,Child Protection - Information Sharing - HL7 V3 API,"Use this API to access Child Protection - Information Sharing (CP-IS), the national electronic database of child protection information.

The API can be used by local authorities and unscheduled care providers as follows:  

- Local authorities

As a local authority, you can:

- upload a patient's CP-IS information
- receive a notification when the patient's CP-IS information is accessed from an unscheduled care setting
- receive a notification of an inactive NHS number

Local authorities originally used a CP-IS client to transfer CP-IS data from their children’s social care systems to CP-IS via the Spine. This was replaced by the MESH client which all local authorities now use to exchange information with CP-IS - see connections 1 to 4 on the diagram.

## Unscheduled care providers

As an unscheduled care provider, you can:

- get a patient's CP-IS information - which automatically triggers a notification to the relevant local authority - see connections 5 and 6 on the diagram


## Scheduled care providers

CP-IS is not currently available for use in scheduled care settings.

## Information held in CP-IS

CP-IS holds the following information for each registered patient:

- NHS number
- details of their plan - type, start date and end date
- details of the 25 most recent CP-IS information accesses from unscheduled care settings in England
- the name of the responsible local authority - together with their office hours phone and emergency duty contact numbers

## Identifying patients

All records in CP-IS are held against the patient's NHS number. It is therefore very important to ensure you use the correct NHS number for each patient.

For more details, see CP-IS NHS number matching information.

## Using SCRa as an interim measure

We prefer unscheduled care providers to integrate their applications directly with CP-IS using our CP-IS APIs. However, as an interim measure, you can use our Summary Care Record application (SCRa) to access CP-IS information.

Spine Mini Service Provider (SMSP) options

There are also commercially available products which give easier access to CP-IS, known as Spine Mini Service Providers (SMSPs).

These and other conforming software products are listed in our Conformance Catalogue.

If you are interested in becoming a provider of one of these products, see Child Protection - Information Sharing - SMSP API standards. 

",https://digital.nhs.uk/developer/api-catalogue/child-protection-information-sharing-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/covid-19-test-results-fhir,COVID-19 Test Results - FHIR API,"Use this API to access a patient’s coronavirus (COVID-19) test results history. You can: 

- get a patient's COVID-19 test history, based on their NHS number with an optional specific date range

You cannot currently use this API to: 

- get details of other types of test

You get the following data: 

- COVID-19 test event details

Data availability, timing and quality All test records are verified to ensure the NHS number is correct before making them available via the API. In most cases this is automatic, and the record is available within 48 hours of the test event, sometimes sooner. In a very small number of cases, we are unable to verify the NHS number, and we do not make the test record available at all. ",https://digital.nhs.uk/developer/api-catalogue/covid-19-test-results-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/cyber-alerts-rest,Cyber Alerts - REST API,"Use this API to access a feed of alerts issued by our NHS Digital cyber security centre.

You can:

- get a list of cyber alerts according to certain parameters 
- get details of a single cyber alert
- choose to get a concise subset or full details of the alerts

 ",https://digital.nhs.uk/developer/api-catalogue/cyber-alerts-rest,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/data-registers-service-rest,Data Registers Service - REST API,"Use this API to access a wide range of live lists of reference data with our Data Registers Service which includes historic data. Each register is managed by a custodian across a range of organisations. In each case, they represent the approved version of that data. 

Examples of these data registers include:

- organisation codes
- postcodes
- diagnosis codes

You can see what data registers are available using our data registers tool.

If you're looking for richer functionality from a data source, such as being able to test data validity, extract a subset or map data across different schemas then take a look at our Terminology Server - FHIR API - the terminology server provides a richer view of the SNOMED data set only. This also conforms to the international FHIR standards for its APIs.

If your use case requires historical, point-in-time snapshots of reference data, they are available either from this API or the TRUD API. ",https://digital.nhs.uk/developer/api-catalogue/data-registers-service-rest,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/demographics-batch-service,Demographics Batch Service,"Use this batch message integration to submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS) for direct care purposes.

The service is provided for organisations that do not want to write their own software - typically NHS trusts or local authorities.

It returns a limited set of PDS data items, as for PDS SMSP.

It requires PDS access approval before you can use it.

You can:
- Install a DBS client in a secure location, for example in a server room not a desktop PC
- download and complete the DBS End Point Registration form (see interactions below) and submit it to the DBS Implementation Team at [email protected]. You should receive endpoint information within 7 days.
- submit a test file to DBS to confirm connectivity over Secure FTP
- use the DBS client to submit batch trace requests and receive batch responses to them

DBS requires a secure network connection. It is an offline service so does not require smartcards. ",https://digital.nhs.uk/developer/api-catalogue/demographics-batch-service,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/digital-child-health-fhir,Digital Child Health - FHIR," Use this integration to share information about a child's health between healthcare workers.

This information is recorded throughout a child's clinical pathway or patient journey about:

- health events
- clinical contacts 

These events or contacts happen either as part of:

- a planned Healthy Child Programme
- unplanned GP or Emergency Department visits

Examples of such events include creating, updating or deleting a record of a:

- blood spot test outcome
- newborn hearing test
- Newborn and Infant Physical Examination (NIPE) outcome

This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via MESH.

Subscribed systems might be GPs, emergency departments, local authorities or some other care provider. Potentially, patients and carers could also share this information.

For more information see Digital Child Health specification versions.

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/digital-child-health-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/digital-medicine-fhir,Digital Medicine - FHIR,"Use this integration to notify a patient's registered GP practice about care services delivered at a pharmacy.

You can send notifications about:

- an immunisation given
- an emergency medication dispensed without a prescription
- a minor illness referral consultation

This integration uses MESH to send and receive messages.

The following use cases are now retired and you cannot use them:

- a medication review
- an appliance use review
- a New Medicine Service (NMS) appointment

For more details, see status. 

",https://digital.nhs.uk/developer/api-catalogue/digital-medicine-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/directory-of-healthcare-services,Directory of Healthcare Services (Service Search) API,"Use this API to find information about organisations that provide NHS healthcare services, NHS organisation types, and coronavirus (COVID-19) walk-in sites.

You can:

- retrieve a list of organisation types, for example, GP practices or hospitals
- search for NHS organisations that provide healthcare services listed in NHS services near you, for example, Leeds General Infirmary
- search for coronavirus (COVID-19) walk-in sites

This API was previously known as the Service Search API. ",https://digital.nhs.uk/developer/api-catalogue/directory-of-healthcare-services,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest,Directory of Services - Urgent and Emergency Care - REST API,"Use this API to access Directory of Services (DoS) information on a wide range of health and care services across England. 

You can search for services based on a combination of parameters: 

- the patient’s age, sex, and current location
- the patient’s clinical need

You can also search for services using similar parameters, such as by:

- service type - find matching service type ID, location and optional patient details
- clinical term - find matching symptoms, location and optional patient details
- ODS code - find active services with a matching ODS code
- service ID - find active services with a matching service identifier

This service is widely used in an Urgent and Emergency Care context.

It is not currently suitable for referrals from services using NHS Pathways outcomes, such as NHS 111 - for this, use the Directory of Services - Urgent and Emergency Care - SOAP API.

You need a valid DoS account to use this API. ",https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/directory-of-services-soap,Directory of Services - Urgent and Emergency Care - SOAP API," Use this API to access Directory of Services (DoS) information on a wide range of health and care services across England. 

You can search for services based on a combination of parameters: 

- find an appropriate list of services for a specific clinical need
- get technical endpoint information for a given service, using a service ID or ODS code
- obtain capacity information for specified hospitals or wards, using a service ID or ODS code

This service is widely used in an Urgent and Emergency Care context using NHS Pathways outcomes. For example, NHS 111 use it to find a service in real-time with the capacity to help a patient with given symptoms, within range of a given location.

You need a valid DoS account to use this API. ",https://digital.nhs.uk/developer/api-catalogue/directory-of-services-soap,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-directory-of-services,Electronic Prescription Service Directory of Services API,"Use this API to access information about dispensing services, including searching for dispensers who can provide services for a patient with a given location and urgency.

You can:

- search for a dispenser by its location and opening hours
- search for a specific dispenser that the patient might have named

The API combines data from both the Directory of Services (DoS) and  Electronic Transmission of Prescriptions (ETP) web services (formerly known as NHS Choices).

It uses DoS for user authentication.

Do not use this API if you are building GP software - instead use Electronic Transmission of Prescriptions (ETP) web services directly, as it provides access to information you'll need, for example, information such as dispensing appliance contractors. ",https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-directory-of-services,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir,Electronic Prescription Service - FHIR API,"Use this API to access the Electronic Prescription Service (EPS). EPS is the national service used to send electronic prescription messages between prescribers and community dispensers. Prescribers in primary and secondary care can: 

- create a prescription
- encode data so the prescription is ready to sign
- cancel a prescription

Creating and cancelling a prescription are both done by the prescriber. Encoding data so the prescription is ready to sign is done by the prescribing system. Dispensers can: 

- download an individual prescription from EPS
- download a batch of prescriptions from EPS
- return a prescription to EPS
- submit a dispense notification to EPS
- withdraw a dispense notification from EPS
- submit a dispense claim

You cannot currently use this API to: 

- view a prescription's detailed dispense history

 ",https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-hl7-v3,Electronic Prescription Service - HL7 V3 API,"Use this API to access the Electronic Prescription Service (EPS). EPS allows a prescriber (such as a GP) to send prescriptions electronically to a dispenser (such as a pharmacy) of the patient's choice. This makes the prescribing and dispensing process more efficient and convenient for patients and staff.

You can do different things, depending on your role.

As a prescriber you can:

- send prescriptions to EPS
- cancel prescriptions

As a dispenser you can:

- receive prescriptions from EPS
- confirm a prescription is dispensed
- claim for a dispensed prescription

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/spine-electronic-prescription-service-tracker-rest,Electronic Prescription Service Tracker - REST API,"Use this API to track a patient’s prescriptions within the Electronic Prescription Service (EPS) using our Electronic Prescription Service Tracker.

You can search for a list of prescriptions that meet your query parameters by providing: 

- patient's NHS number (mandatory)
- format (mandatory)
- prescription date range (optional)
- prescription status (optional)
- prescription version (optional)

Once you find the prescription, or if you already know its details, you can retrieve it by providing:

- prescription ID (mandatory)
- format (mandatory)
- issue number (optional)

For more details, see Introduction to Spine EPS Tracker.

This API is only for use when the end user is a healthcare worker, not a patient. You can vote to make it available to patients on our interactive backlog.  ",https://digital.nhs.uk/developer/api-catalogue/spine-electronic-prescription-service-tracker-rest,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/electronic-transmission-of-prescriptions-web-services-soap,Electronic Transmission of Prescriptions Web Services - SOAP API," 

Use this API to get Electronic Prescription Service (EPS) dispenser (and dispensing appliance contractor) information for a patient via NHS UK Web Services.

You can search for dispenser information using:



a valid ODS code (previously known as NACS code)

their name and service type (community pharmacy or appliance contractor), and whether they are EPS-enabled or not

their name and location and the service type, and whether they are EPS-enabled or not

their postcode and service type, and whether they are EPS-enabled or not



Use this API if you are building GP software - it provides additional information about dispensing appliance contractors that is not available through Electronic Prescription Service Directory of Services API.

As one of the Directory of Services APIs, this also provides data to the Electronic Prescription Service Directory of Services API.

Before you begin any development work using this API, contact us to discuss your best options. ",https://digital.nhs.uk/developer/api-catalogue/electronic-transmission-of-prescriptions-web-services-soap,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir,e-Referral Service - FHIR API,"Use this API to create paperless referrals from primary to secondary care with the e-Referral Service (e-RS). As a primary care referrer, you can: 

- create a new e-referral
- search for relevant patient services to create a shortlist
- access existing e-referrals
- create a triage request for the Referral Assessment Service (RAS)
- upload and manage a patient letter or attachments, linking them to a referral
- retrieve appointment slots and book appointments
- defer a booking to a provider if an appointment slot is unavailable

As a secondary care provider, you can: 

- access referrals as a worklist
- retrieve non-clinical information (meta-data) about the referral
- retrieve attachments which are linked to a referral or triage (RAS) request
- retrieve clinical information which has been provided by a referrer
- accept or reject a referral request
- retrieve Advice & Guidance (A&G) conversations and send responses
- convert Advice & Guidance (A&G) conversations into a referral

You cannot use this API to: 

- get patient details – instead, use the Personal Demographic Service (PDS)

You can access the following data: 

- referral attachments
- referral letters
- appointment slots
- worklists for referral requests
- worklists for triage (RAS) requests
- worklists for Advice and Guidance (A&G) requests
- conversation histories for Advice and Guidance (A&G) requests

## Access modes

This API has two access modes: 

### Application-restricted, unattended access 

- Authentication via: Signed JWT 
- Functions: A004, A005, A006, A007, A024, A025 and A043 
- Availability: In production, beta

### Healthcare worker, user-restricted access

- Authentication via: CIS2
- Functions: All Endpoints
- Availability: In production, beta


Application-restricted, unattended access This access mode has been introduced to allow a Partner application which has been registered with us and authenticated via signed JWT to interact with a subset of e-RS FHIR API endpoints in an unattended and read-only fashion.

Application-restricted, unattended access should only be used when authenticating a human user (for example via smartcard) is not possible. Writing changes (such as Create Referral) are not supported via this access mode. Healthcare worker, user-restricted access This access mode allows Partner applications to access e-RS FHIR API endpoints by authenticating users with NHS Care Identity Service 2 (CIS2). This access mode must be used for writing changes (such as Create Referral). ",https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir-hscn,e-Referral Service - FHIR API (HSCN)," 
Use this API to create paperless referrals from primary to secondary care.

As a primary care referrer, you can:

- create a new e-referral
- search for relevant patient services to create a shortlist
- access existing e-referrals
- create a triage request for the Referral Assessment Service (RAS)
- upload and manage a patient letter or attachments, linking them to a referral
- retrieve appointment slots and book appointments
- defer a booking to a provider if an appointment slot is unavailable

As a secondary care provider, you can:

- access referrals as a worklist
- retrieve non-clinical information (meta-data) about the referral
- retrieve attachments which are linked to a referral or triage (RAS) request
- retrieve clinical information which has been provided by a referrer
- accept or reject a referral request
- retrieve Advice & Guidance (A&G) conversations and send responses
- convert Advice & Guidance (A&G) conversations into a referral

You cannot use this API to:

- get patient details – instead, use the Personal Demographic Service (PDS)

You can access the following data:

- referral attachments
- referral letters
- appointment slots
- worklists for referral requests
- worklists for triage (RAS) requests
- worklists for Advice and Guidance (A&G) requests
- conversation histories for Advice and Guidance (A&G) requests

This API is only available over HSCN, and can only be used with CIS, not CIS2.

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir-hscn,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/e-referral-service-hl7-v3,e-Referral Service - HL7 V3 API,"Use this API to manage appointment slots for new or existing Patient Administration Systems, using our HL7 V3 API until there is a FHIR version available.

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/e-referral-service-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/e-referral-service-patient-care-fhir,e-Referral Service Patient Care – FHIR API,"Use this API to retrieve referrals for a patient from the e-Referral Service (e-RS) and, if applicable, retrieve service information for a referral that has a current appointment booking with a service or is currently deferred to a service. This API is designed to be used by the Patient Care Aggregator. As an integrated system acting on behalf of a patient, you can: 

- retrieve a patient's referrals
- retrieve information for a single service

You cannot use this API to: 

- get patient personal demographic details – instead, use the Personal Demographic Service (PDS)

You can access the following data: 

- a summary of each active referral

Access modes This API has one access mode: 


- Access mode: Patient access
- Authentication via: NHS login
- Functions: Get own details
- Availability: In production, beta

 Patient, user-restricted access This access mode allows integrated systems acting on behalf of a patient to access Patient Care FHIR API endpoints by authenticating users with NHS login. ",https://digital.nhs.uk/developer/api-catalogue/e-referral-service-patient-care-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/female-genital-mutilation-information-sharing-fhir,Female Genital Mutilation - Information Sharing - FHIR API,"Use this API to share female genital mutilation (FGM) information for children under 18 with relevant NHS professionals across England.

You can:

- query a patient's FGM status

You cannot currently:

- create an FGM indicator for a patient
- delete an FGM indicator for a patient

This API is only for use when the end user is a healthcare worker, not a patient. 

For more details, see Introduction to the FGM Information Sharing Service. ",https://digital.nhs.uk/developer/api-catalogue/female-genital-mutilation-information-sharing-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/fhir-converter,FHIR Converter API,"Use this API to convert resource types MedicationRequest and MedicationStatements from STU3 to FHIR R4 and vice versa. You can: 

- post either a MedicationRequest or MedicationStatement

You cannot: 

- convert between any other resource types

To use this API: 

- Send your source payload to this API.

This API converts your source payload to the target version.

You receive the converted payload in the response.

 ",https://digital.nhs.uk/developer/api-catalogue/fhir-converter,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gazetteer-service-soap,Gazetteer Service - SOAP API," Use this API to validate and retrieve UK-based postal addresses, for example before updating a patient's details in the Personal Demographics Service.  Also known as the Address Finder, it can validate and transform the address to the Postcode Address File (PAF) standard, as well as search for and return an address list based on your search criteria.

You can:

- get a single search result based on the house number or name and its postcode
- get multiple search results based on partial address inputs or wild card searches
- do fuzzy searches based on the phonetics of words entered in lines of an address
- do intelligent postcode parsing to validate the underlying structure
- get the PAF address key for each delivery point

You cannot use this API to update anyone's address.

## Data update frequency

At the moment, we only update the data in Gazetteer annually. We are working on updating it more frequently. If this is an issue for you, contact us.

## Licensing

This API uses Royal Mail's Postcode Address File (PAF), which is a licensed product. The licence applies to the end user organisation, not to the software developer.

If the end user organisation is a public sector organisation, such as a GP practice or a hospital trust, they can apply for a Public Sector Licence (PSL), which is free, even if they are using commercial software.

Private end user organisations (for example, non-NHS dentists and some types of GP practice) must obtain a commercial PAF licence.

Public sector end user organisations using the API for revenue-generating purposes (such as treating patients privately) must obtain a commercial PAF licence.

Software developers using the API for testing do not need a licence. ",https://digital.nhs.uk/developer/api-catalogue/gazetteer-service-soap,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/general-practice-extraction-service-mesh,General Practice Extraction Service - MESH,"Use this integration to send patient data from General Practice (GP) clinical systems to General Practice Extraction Service (GPES). This data can then be used for planning and research. 

You can:

- receive requests for data
- send requested data

For example, the GPES data for pandemic planning and research is used to support the response to the coronavirus (COVID-19) outbreak. This data is used to analyse healthcare information about patients, for the duration of the coronavirus emergency period.

This integration is an asynchronous messaging integration which uses MESH to send and receive messages. 

",https://digital.nhs.uk/developer/api-catalogue/general-practice-extraction-service-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp2gp,GP2GP - HL7 V3,"Use this integration to transfer patients' electronic health records between old and new practices when they change GPs.

You can:

- include large records and those with many attachments
- reduce paper printing when patients leave a practice
- integrate (file) the electronic health record for returning patients
- log issues easily with easy-to-understand and more informative error messages
- monitor in real time the processes to track issues and performance

For more details, see GP2GP. ",https://digital.nhs.uk/developer/api-catalogue/gp2gp,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp2gp-management-information-mesh,GP2GP Management Information MESH,"Use this integration to provide information to us at NHS Digital on the progress of the patient migration process between GP practices (GP2GP). 

This involves recording patient registration activity in the GP systems at specific stages in the patient migration process.

This integration uses MESH to send and receive messages.

For details, see NPFIT-PC-BLD-0173.01 GP2GP UC 2 Harvest and Prepare Management Information which describes the high level use case for reporting capability required by GP2GP 2.2b. 

",https://digital.nhs.uk/developer/api-catalogue/gp2gp-management-information-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-access-record-fhir,GP Connect (Patient Facing) Access Record - FHIR API,"Use this API to access structured and coded information from a patient's GP practice record to consume in a patient facing service. The API accesses GP principal supplier systems and provides a consistent interface and data model. You can retrieve patient record data for the following: 

- medications
- allergies
- immunisations
- consultations
- problems
- investigations
- attachments
- uncategorised data (other clinically coded items that are present in the record)

You cannot currently use this API to: 

- write back to the GP record

 ",https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-access-record-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-appointment-management-fhir,GP Connect (Patient Facing) Appointment Management - FHIR API,"Use this API to book and manage patient appointments at their GP practice. You can: 

- search for free slots
- book an appointment
- retrieve a patient’s appointments
- get details of a single appointment
- cancel an appointment

You cannot: 

- amend a patient's appointments beyond cancelling
- re-schedule a patient's appointments (this must be done by cancelling and re-booking)

To use this API, the end user must be a patient who is: 

- registered with the GP practice
- registered with NHS login to P9 identity verification level

 ",https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-appointment-management-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-prescriptions-fhir,GP Connect (Patient Facing) Prescriptions - FHIR API,"Use this API to manage a patient's prescriptions as held by their GP practice. You can: 

- request a new instance of a repeat prescription
- view all of a patients medications, whether acute or repeat, past or present
- cancel a repeat prescription request
- check the status of a current prescription request
- request a new instance of a repeat prescription to a one off nomination pharmacy

The end user must be a patient who is: 

- registered with the GP practice
- registered with NHS login to P9 identity verification level



 For example: 

- a patient can view their own medication, request a new instance of a repeat prescription and cancel that request

 ",https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-prescriptions-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-user-permissions,GP Connect (Patient Facing) User Permissions API,"Use this API to list and manage the permissions a patient has to their medical record and a selection of services provided at their GP practice. You can: 

- get a patient's permissions
- request to update a patient's permissions to a higher level

You cannot: 

- request to update a patient's permissions to a lower level

To use this API, the end user must be a patient who is: 

- registered with the GP practice
- registered with NHS login to P9 identity verification level

This API allows you to manage the permissions for: 

- appointments
- prescriptions
- medical record

This API is designed to respect the policy changes made in order to

- allow patients to access their future medical record entries.

For more details, see

- access to patient records through the NHS App. ",https://digital.nhs.uk/developer/api-catalogue/gp-connect-patient-facing-user-permissions,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-document-fhir,GP Connect Access Document - FHIR API," Use this API to retrieve unstructured documents from a patient’s GP practice record. Unstructured documents are usually clinical documents received from various health and care settings and held by a patient's registered GP practice.

You can:

- search for a patient’s documents
- retrieve a document


For example, a district nurse attends a patient at home and views their hospital discharge summary held by their GP practice.

For more details, see the GP Connect specifications for developers.  

## Clinical assurance process

We are here to support you to develop clinically safe systems in line with your responsibility to achieve the relevant DCB0129 or DCB0160 clinical safety standards. 

We host a series of meetings to help you develop clinically safe systems:

- initial meeting
- clinical safety process readiness review meeting
- clinical evaluation of readiness for deployment meeting

For more information, see Clinical assurance process details.



  

",https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-document-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-html-fhir,GP Connect Access Record: HTML - FHIR API,"Use this API to view a patient's registered GP practice record, with read-only access.

You can:

- view a patient’s primary care record by requesting sections or headings
- define a date range to filter larger sections
- incorporate these views directly into Electronic Patient Record systems

For example:

- GP practices can view all of the patient’s primary care records even when they are held on a different GP system
- care settings such as NHS111, ambulance and emergency care, primary care networks (PCNs), secondary care, pharmacy, care homes, community and dentistry can view the records held by the patient’s GP practice to better inform any care decisions they make for a patient

For more details, see the GP Connect specifications for developers.  

Start your development work within 6 months of use case approval. If you miss this date, a review or new submission of the use case will be required. Changes or additional development will also require a review or new use case submission.  

",https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-html-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-structured-fhir,GP Connect Access Record: Structured - FHIR API,"Use this API to access structured information from a patient’s registered GP practice record. Structured information is patient data in a coded format that a consuming system can import and process.

The API accesses GP principal supplier systems, provides a consistent interface and data model, and is brokered through Spine. 

You can retrieve data from GP practice records for the following areas:

- medications
- allergies

Data is available for the following clinical areas:

- immunizations
- consultations
- problems
- investigations
- outbound referrals
- diary entries
- uncategorised data (other clinically coded items that are present in the record)

These clinical areas are still in development; there is enough data to test, but it is subject to change as GP systems suppliers go through the development process.

It does not include:

- extended demographics information - for example, about carers
- flags and alerts
- templates
- test requests

Common use cases include:

- access GP medications on admission to secondary care, reducing transcription errors
- active checking of a patient's prescription in unscheduled care
- out-of-hours GP accesses patient's medications, allergies and problems
- midwife views patient record before visiting a patient
- community cardiac nurse accesses GP record before visiting a patient

For more details, see the GP Connect Access Record: Structured specification.

You cannot currently use this API to:

- create patient-facing views of a medical record
- create reports for secondary use, such as care planning
- write back to the GP record

## Retrieving documents

To retrieve documents from a patient’s registered GP practice, use GP Connect Access Document - FHIR API. After you've found the relevant document references within Access Record returns, use GP Connect Access Document to retrieve the documents. All documents can be requested separately.

Start your development work within 6 months of use case approval. If you miss this date, a review or new submission of the use case will be required. Changes or additional development will also require a review or new use case submission. For full details of the technical conformance process, see GP Connect Consumer Supplier Test Assurance for achieving Technical Conformance (PDF).

## Clinical assurance process

We are here to support you to develop clinically safe systems in line with your responsibility to achieve the relevant DCB0129 or DCB0160 clinical safety standards. 

We host a series of meetings to help you develop clinically safe systems:

- initial meeting
- clinical safety process readiness review meeting
- clinical evaluation of readiness for deployment meeting

For more information, see Clinical assurance process details. 

",https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-structured-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-appointment-management-fhir,GP Connect Appointment Management - FHIR API,"Use this API to enable administrative and clinical end users to book and manage patient appointments held in any of the principal GP practice systems.

You can:

- retrieve a patient’s appointments
- search for free slots
- read an appointment
- book an appointment
- amend an appointment
- cancel an appointment

For example:

- staff at a GP practice can book, view, amend or cancel appointments on behalf of a patient at another practice
- organisations such as NHS 111 call centre, out of hours services, or extended access hubs can book, view, amend or cancel appointments on behalf of a patient at their registered GP practice or federated GP practices

Note: You need to use this API in conjunction with the GP Connect Foundations FHIR API. With this API you can:

- get patient details - “Read Patient”
- search for patient - “Patient Search”
- get practitioner details - “Read Practitioner”
- search for practitioner - “Practitioner Search”
- get organisation details - “Read Organisation”
- search for organisation - “Organisation Search”
- get location details - “Read Location”
- register patient - “Register Patient”

For more details, see the GP Connect specifications for developers.  

Start your development work within 6 months of use case approval. If you miss this date, a review or new submission of the use case will be required. Changes or additional development will also require a review or new use case submission.  

",https://digital.nhs.uk/developer/api-catalogue/gp-connect-appointment-management-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-connect-send-document-fhir,GP Connect Send Document - FHIR,"Use this integration to send a PDF consultation summary to a registered GP practice - using GP Connect Messaging.

For example, use it to send a document containing a patient's consultation notes to their GP practice when a patient is seen:

- at another GP practice than their own
- by an out of hours service
- by a district nurse at home

Each message sent using this integration uses the GP Connect Messaging components, MESH, and ITK3, to deliver the message.

Each message sent is a FHIR Message, defined as a FHIR composition, constructed to meet the ITK3 standard with a specific payload structure.

For more details, see the GP Connect specifications for developers. 

",https://digital.nhs.uk/developer/api-catalogue/gp-connect-send-document-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/gp-registrations-management-information,GP Registrations Management Information API,"Use this API to send real-time GP registrations metrics to NHS for service monitoring of patient EHR transfers between GP Practices. This API replaces the weekly submission of GP2GP information sent to us via a MESH mailbox, as required by GP2GP V2.2b. You can send us Management Information for registrations regardless of the transfer protocol used (GP2GP or GP Connect). Using the API, you can send us information about the following: 

- when a requesting practice completes a registration
- the compatibility of that registration with an electronic transfer
- when the requesting practice requests an EHR
- when the sending practice sends an EHR
- when the requesting practice received attachments/documents
- when the requesting practice is ready for the user to integrate the transfer
- when the requesting practice has integrated the EHR received
- when an error, or negative acknowledgement occurs
- degrades

You cannot: 

- read any management information data submitted to us

 ",https://digital.nhs.uk/developer/api-catalogue/gp-registrations-management-information,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/health-research-data-catalogue,Health Research Data Catalogue API,"Use this API to retrieve metadata information suitable for publication in a health research data catalogue. You can: 

- get a list of data sets
- get data set details

You cannot currently use this API to: 

- retrieve data sets as a bulk transfer
- retrieve data set feeds

You can get the following metadata information for each data set: 

- overarching characteristics such as: publisher, keywords, coverage, provenance, access, format, standards, summary observations and data utility

The API conforms to the HDR UK Dataset Metadata Schema Standard v2.0.2 created to enable sharing of information with the UK-wide 'federated' health research data catalogue. API scope Current scope is limited to metadata information about national health-related data sets (such as description, size of the population contained within that data set and the legal basis for access) that can help researchers and innovators decide whether a data set could be useful to their research and help them to make further health discoveries. ",https://digital.nhs.uk/developer/api-catalogue/health-research-data-catalogue,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/hello-world,Hello World API,"Use this API alongside our  tutorials to teach yourself how to connect to our RESTful APIs.

You can: 

- get a response from an open-access endpoint, where the calling application and the end users are not authenticated
- get a response from an application-restricted endpoint, where the calling application is authenticated but the end user is not authenticated
- get a response from a user-restricted endpoint, where the calling application and the end user are authenticated

For further details, see the 'Security and authorisation' section below. ",https://digital.nhs.uk/developer/api-catalogue/hello-world,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/immunisation-history-fhir,Immunisation History - FHIR API,"Use this API to access a patient’s immunisation history. You can: 

- get a patient's coronavirus (COVID-19) immunisation history, based on their NHS number
 
You cannot currently use this API to: 

- get details of other types of immunisation

You get the following data: 

- immunisation event details
- patient demographic details, as captured at the point of immunisation

The patient demographic details might differ from those held in the Personal Demographics Service (PDS).

To get demographic details from PDS, use the Personal Demographics Service FHIR API. Data availability, timing and quality All immunisation records are verified to ensure the NHS number is correct before making them available via the API. In most cases this is automatic, and the record is available within 48 hours of the immunisation event, sometimes sooner. Where automated NHS number verification fails, we verify the NHS number manually, which can take longer. In a very small number of cases, we are unable to verify the NHS number, and we do not make the immunisation record available at all. ",https://digital.nhs.uk/developer/api-catalogue/immunisation-history-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api,Message Exchange for Social Care and Health (MESH) API,"You interact with MESH by making calls to this API from your application. With the API, you can: 

- check the number of messages in your inbox
- send a message, or a larger message as series of chunks
- download a message, or a larger message which was sent to you as a series of chunks
- acknowledge the successful download of a message, which removes it from your inbox
- get the identifiers of messages in your inbox that are ready for download
- track the status of messages that you sent from your outbox
- look up the mailbox of an organisation you want to send data to
- validate your mailbox every 24 hours to let Spine know it's still active

 ",https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-fhir,National Data Opt-out - FHIR API,"Use this API to capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes using National Data Opt-out (NDOP). 

You can:

- create National Data Opt-out preferences for a patient
- update the National Data Opt-out preferences for a patient
- display transaction history of National Data Opt-out preferences for a patient

You cannot currently:

- get existing National Data Opt-out preferences for a patient

Use the Check for National Data Opt-outs Service (POS) to get existing National Data Opt-out preferences for one or more patients. If your use case is not met by the POS service, please contact us. ",https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-service-mesh,National Data Opt-out - MESH,"As a GP system, use this integration to:

- submit a list of NHS numbers to the National Data Opt-outs Service
- receive a list back with the NHS numbers removed for those patients who have opted out of their data being used

You can use the Check for National Data Opt-outs Service to get existing National Data Opt-out preferences for one or more patients. If your use case is not met by the National Data Opt-outs Service, contact us.

This integration uses MESH to send and receive messages. 

",https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-service-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/national-events-management-service-fhir,National Event Management Service - FHIR API,"Use this API to publish and subscribe to patient-centric healthcare event messages with the National Events Management Service (NEMS).  This national service is implemented on the NHS Spine.

As a sending system, you can:

- publish an event message

As a subscribing system, you can:

- create a subscription
- read a subscription 
- delete a subscription

This API uses a publish-subscribe model - the sending system publishes specific range of healthcare event messages to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via MESH.

NEMS authorises a specific list of system suppliers and health and social care organisations to publish information as events.

For more details, see the Introduction to the National Events Management Service. 

",https://digital.nhs.uk/developer/api-catalogue/national-events-management-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links,National Health Application and Infrastructure Services - NHAIS GP Links,"Use this integration to manage GP registrations and other patient data in National Health Application and Infrastructure Services (NHAIS).

You can:

- register a patient at a GP practice
- receive a patient deregistration (deduction) notification at the previous GP practice
- update patient demographics information, such as address

This integration uses MESH to send and receive messages. 

This integration forms part of the end-to-end GP registration process. For more details on the end-to-end process, contact us. 

",https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir,National Record Locator - FHIR API,"Use this API to locate and access patient information shared by other healthcare organisations, to support the direct care of those patients, using the National Record Locator (NRL).

As a ""provider"" or ""producer"" who holds information about patients, you can:

- create a pointer in the NRL to your information
- replace your NRL pointer with a newer pointer, superseding the old one
- update your NRL pointer status to ""entered in error""
- delete your NRL pointer to this information

As a ""consumer"" who needs access to the patient information being shared by providers, you can:

- search for information by parameters including information ID, patient, information provider, information type,  or number of matching results
- retrieve an NRL pointer and access the information

There is a growing list of health and social care organisations authorised to share records using NRL. 

",https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-app,NHS App API,"Use this API to engage with users of the NHS App - a simple and secure way for patients registered with a GP surgery in England to access a range of services on their smartphone or tablet. You can: 

- send in-app messages to specific users of the NHS App
- include keyword replies to in-app messages
- include free text replies to in-app messages
- send native Apple or Android push notifications to mobile devices registered by specific users of the NHS App

 ",https://digital.nhs.uk/developer/api-catalogue/nhs-app,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-booking-fhir,NHS Booking - FHIR API,"Use this API to retrieve available slots and book an appointment for a specific health and care service, for example, from NHS 111 into an Urgent Treatment Centre (UTC). ",https://digital.nhs.uk/developer/api-catalogue/nhs-booking-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-cis2-care-identity-authentication,NHS CIS2 Care Identity Authentication API,"Use this API to access NHS Care Identity Service 2 (NHS CIS2) - the national service for verifying the identity of healthcare workers in England, such as NHS staff, when they access national clinical information systems. You can also get basic profile information about these end users.

You can authenticate the healthcare workers using:

- a CIS smartcard - with or without the Credential Management Application
- an iPad 
- a Windows 10 tablet 
- a security key

For further details, see Ways to authenticate using NHS Care Identity Service 2. ",https://digital.nhs.uk/developer/api-catalogue/nhs-cis2-care-identity-authentication,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-cis-authentication-spine-security-broker,NHS CIS Authentication (Spine Security Broker) API,"Use this API to verify the identity of healthcare workers in England, such as NHS staff. It provides a single sign-on capability across local and national digital services using physical and virtual smartcards.

This API is also known as the Spine Security Broker (SSB), and is part of the NHS Care Identity Service (CIS).

You can:

- access the Identity Server which serves up SSO Tokens and manages the sessions for users who have been successfully authenticated
- access the Identity Agent on the end user's workstation, which mediates the authentication transaction and serves subsequent user information on demand as part of the application's authorisation process
- access the Client Signing Interface, which provides client-side digital signing functions for the purposes of Content Commitment. This interface primarily uses cryptographic functions that execute on a user’s smart card.

Users can only be authenticated if they are formally registered on the Spine. This includes creating a user profile, stored in the Spine Directory Service (SDS), containing the user’s roles and other information that the Registration Authority or Service deems necessary to make appropriate data access decisions.

This authentication service makes use of smartcards to provide strong authentication for health care workers to control access to national services. It is being replaced by NHS Care Identity Service 2 (NHS CIS2), which provides additional authentication methods for scenarios where a smartcard might not be preferred or appropriate.

This API is described fully in the Spine External Interface Specification (EIS). Part 6 has the overview and part 7 the formal API specifications. These are a set of Word documents that provide system developers - architects, designers and builders - with the necessary information to connect to Spine national services. ",https://digital.nhs.uk/developer/api-catalogue/nhs-cis-authentication-spine-security-broker,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-login,NHS login API,"Use this API to enable patients and the public to access multiple digital health and social care services with NHS login, a single re-usable login.

You benefit from:

- using a trusted and secure identity platform
- choosing a proper level of end user verification
- displaying a brand name the public recognises
- meeting the [Identity Verification and Authentication Standard (DAPB3051)](https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services)

For more details, see [NHS login guidance for partners and developers.](https://digital.nhs.uk/services/nhs-login/nhs-login-for-partners-and-developers)",https://digital.nhs.uk/developer/api-catalogue/nhs-login,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhsmail,NHSmail APIs,"Use these APIs to connect your local, regional or national applications or services to NHSmail.

You can:

- work with email messages, calendar, task and contact information 
- access mailboxes
- get client configuration data and endpoint URLs from Exchange

The Microsoft APIs used are:

- Exchange Web Service (EWS) Managed API 2.0  - to work with mailboxes, messages, calendars, tasks and contacts
- Exchange Web Service (EWS) API - to work with mailboxes, messages, calendars, tasks and contacts
- SOAP Autodiscover  - to get client configuration data and endpoint URLs

For compatibility with Office 365, use EWS Managed API 2.0 and not the EWS API. ",https://digital.nhs.uk/developer/api-catalogue/nhsmail,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/nhs-syndicated-content,NHS Syndicated Content - REST APIs,"Use these APIs and widgets to pull a range of content from the NHS.UK website as part of our free syndication programme. 

You can choose from a range of APIs including:

- Common health questions
- Coronavirus (COVID-19)
- Health A to Z -  content also available as smaller specific modules
- Live Well
- Medicines 
- Mental health
- NHS services
- Pregnancy
- Ratings and Reviews
- Videos

You can choose from a range of widgets which give you code you can embed in your web page, including:

- Find services
- Health A to Z -  content also available as smaller specific modules
- Live Well
- Heavy periods self-assessment
- Heart age
- Your blood pressure
- Body Mass Index (BMI) calculator
- Your Mind Plan
- Personal Quit Plan

For more details, see NHS Syndicated content. ",https://digital.nhs.uk/developer/api-catalogue/nhs-syndicated-content,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/online-consultation,Online Consultation - MESH,"Use this message integration to send an online consultation form from a patient to a registered GP.

This integration uses MESH to send and receive messages. 

",https://digital.nhs.uk/developer/api-catalogue/online-consultation,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/ophthalmic-payments,Ophthalmic Payments API," 
Use this API to submit the General Ophthalmic Service (GOS) payment claims to Primary Care Support England (PCSE). Electronic claims are submitted via Practice Management Systems (PMS) and paper based claims are submitted via a bulk scanning facility, provided by Capita Intelligent Communications (CIC).

Activity data about NHS sight tests, optical vouchers, repairs and replacement are collected via a series of GOS payment claim forms.


GOS1 – Application for an NHS funded sight test

GOS3 – NHS optical vouchers and patient statement

GOS4 – NHS optical repair/replacement vouchers application form

GOS5 – Private sight tests with partial help towards the full costs

GOS6 – Application for a mobile NHS funded sight test



You can electronically:

- submit GOS1 claims from PMS and bulk scanning facility to PCSE
- submit GOS3 claims from PMS and bulk scanning facility to PCSE
- submit GOS4 claims from PMS and bulk scanning facility to PCSE
- submit GOS5 claims from PMS and bulk scanning facility to PCSE
- submit GOS6 claims from PMS and bulk scanning facility to PCSE
- submit GOS6 pre-visit notifications from PMS to PCSE
- submit and retrieve GOS3 voucher only between PMS and PCSE
- submit a status request to PCSE



You cannot submit:

- GOS2 claims
- health cost 5 (HC5) refund claims 
- pre-registration training (PRT) grant claims
- continuing education and training (CET) claims

A single GOS message can contain multiple claims for payment of a single GOS claim type, i.e. batch submission is allowed. A message cannot contain a mix of different GOS claim types.

You can also submit GOS payment claims via PCSE Online. For further information, see Ophthalmic payments. ",https://digital.nhs.uk/developer/api-catalogue/ophthalmic-payments,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/ordnance-survey-places-api,Ordnance Survey Places API," Use this API for looking up and validating addresses, typically before updating patient details in the Personal Demographics Service.

You can:

- identify UK addresses
- verify the address records you are capturing against authoritative data from Ordnance Survey’s AddressBase® Premium and AddressBase® Premium - Islands
- make requests using a full or partial address, a postcode, or a Unique Property Reference Number (UPRN)
- find addresses closest to a given point
- find all the known addresses within a user-defined area, bounding box or circle
- verify an address before updating a patient's details in the Personal Demographics Service

This API is a third party API recommended for UK government services.

## Data update frequency

The address, geometry and UPRN data is available for the UK and Isle of Man.  The address and UPRN data is available for Jersey and Guernsey.

This data is updated every 6 weeks.

## Requests

This API has seven types of request in two categories.

Capture and verification category:

- Find - a free text search for quick use
- Postcode - a search based on a property’s postcode
- UPRN - a search that takes a UPRN as the search parameter


GeoSearch category:

- Nearest - finds the closest address to a given point
- Bounding box - finds all addresses inside a bounding box
- Radius - finds all addresses that intersect a given circle
- Polygon - finds all addresses in a polygon or multi-polygon object

For more information, see the Technical Specification. ",https://digital.nhs.uk/developer/api-catalogue/ordnance-survey-places-api,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir,Organisation Data Service - FHIR API,"Use this API to access a reduced dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using the Organisation Data Service (ODS).

This FHIR API contains a reduced dataset, most useful for  transactions. To access the full ODS dataset, including data about succession (history) or relationships, use the ODS ORD API.

You can search for information about an organisation using one or more of their:

- ODS code
- last updated date
- name
- active or inactive status
- postcode or city
- organisation's role or primary role, such as trusts or GP practices

You can also limit the number of results returned, or just request a count of the number of search results.

You cannot:

- access the full dataset from ODS, specifically no information about succession (history) or relationships
- search for an organisation using an address

An ODS code is a unique identification code for an organisation that interacts with any area of the NHS. For a full list of the organisation types available, see CSV downloads.

This API returns the following reduced dataset of an organisation, when searched with an ODS code:

- organisation - ODS code, name, open date, close date, last change date and status if active or inactive
- address - house or flat number, line 1, line 2, line 3, town, postcode and country
- contacts - email, website, telephone and fax
- roles - primary and non-primary roles

To access the full ODS dataset, use the ODS ORD API. ",https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-ord,Organisation Data Service - ORD API,"Use this API to access details of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS). 

This ORD-compatible API contains the full dataset from ODS, including information on succession (history) and relationships.

We also have an ODS FHIR API which contains a reduced dataset, most useful for transactions.

You can:

- search for organisations
- get the organisation details for a given ODS code
- get a list of recently modified organisations
- get metadata for roles, relationships and record classes
- get a list of organisations that have been modified since a specific date to synchronise data locally

An ODS code is a unique identification code for an organisation that interacts with any area of the NHS. For a full list of the organisation types available, see CSV downloads. 

This API returns the following full dataset for an organisation, when searched with an ODS code:

- organisation - ODS code, name, open date, close  date, last change date and status if active or inactive
- address - house or flat number, line 1, line 2, line 3, town, postcode and country
- contacts - email, website, telephone and fax
- roles - primary and non-primary roles
- relationships - legal and operational relationships including history where it was captured by ODS
- succession - history of legal succession following reconfiguration or mergers
- additional attributes - data items included to support policy and pragmatic change

For an alternative API that returns a reduced dataset, use the ODS FHIR API. ",https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-ord,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/out-of-hours,Out Of Hours,"Use this message integration to send details of an out of hours (OOH) assessment from an out of hours GP system to the patient's registered GP.  

It uses MESH to send and receive messages.

The message payload is actually not that standard, as explained below. 

",https://digital.nhs.uk/developer/api-catalogue/out-of-hours,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-edifact,Pathology Messaging - EDIFACT,"Use this integration to receive structured pathology test results in GP practices from pathology laboratories.

This integration uses MESH to send and receive UN/EDIFACT based messages. 

For more details, see the Pathology EDIFACT v1.003 Standard.

If you are building a system to receive pathology test results, you can use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format. 

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-edifact,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-fhir,Pathology Messaging - FHIR,"Use this integration to share pathology results from a Laboratory Information Management System (LIMS) to the requestor, typically a healthcare worker in NHS primary or secondary care.

Initially it focuses on haematology and clinical biochemistry test reporting - also known as chemical pathology.

This integration uses MESH to send and receive pathology results.

It is intended to replace the current Pathology Messaging - EDIFACT API and supersedes Laboratory HL7 V3 (see the Message Implementation Manual under Domains -> Health and Clinical Management -> Laboratory). 

",https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-hl7-v3,Pathology Messaging - HL7 V3,"Use this integration to request laboratory tests and send the results back to the requester, usually the patient's GP or consultant. Results can also be copied to other healthcare providers for information.

One request can lead to several results reports and each report is complete in its own right. If incomplete reports are issued, a final report carries all the reported information, replacing the originals entirely.

This integration is not widely adopted - it is only used as part of the NHS Newborn Blood Spot (NBS) Screening Programme which involves a limited number of pathology laboratories. Pathology Messaging - EDIFACT API supports most of the pathology interactions.

This integration will be superseded by the Pathology Messaging - FHIR API. ",https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/patient-care-aggregator-fhir,Patient Care Aggregator - FHIR API," Use this API to get an aggregated list of referrals and bookings for a patient from secondary care providers. The API aggregates details of referrals and bookings from a number of systems. For details, see status and roadmap. We might add other providers in the future. This API is only for use in patient-facing applications, not point-of-care applications. For more details, see Patient access to referrals and bookings via the Patient Care Aggregator. ",https://digital.nhs.uk/developer/api-catalogue/patient-care-aggregator-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/patient-care-aggregator-record-service/patient-care-aggregator-record-service-api,Patient Care Aggregator Record Service API,"Use this API, as a secondary care provider, to let the Patient Care Aggregator know which patients you have bookings for. The Patient Care Aggregator needs this information in advance so it knows which secondary care providers to ask for a list of bookings when a patient requests the list using the NHS App. As a secondary care provider, you’ll also need to: 

- build an API using the Patient Care Aggregator Get Applications API standard that the Patient Care Aggregator can use to get a list of bookings for a patient
- build a ‘patient portal’ web application that the patient can access via a hyperlink from the NHS App

For more details, see Patient access to referrals and bookings via the Patient Care Aggregator. ",https://digital.nhs.uk/developer/api-catalogue/patient-care-aggregator-record-service/patient-care-aggregator-record-service-api,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir,Personal Demographics Service - FHIR API,"Use this API to access the Personal Demographics Service (PDS) - the national electronic database of NHS patient details such as name, address, date of birth, related people, registered GP and NHS number. You can: 

- search for patients
- get patient details
- update patient details
- verify an NHS number for a patient

You cannot currently use this API to: 

- create a new record for a birth - use PDS HL7 V3 API
- receive birth notifications - use PDS HL7 V3 API or PDS Notifications FHIR API
- create a record for a new patient - use PDS HL7 V3 API
- register a new patient at a GP Practice - use NHAIS GP Links API
- receive patient death notifications - use PDS Notifications FHIR API
- receive notifications about a patient's change of address - use PDS Notifications FHIR API
- receive notifications about a patient's change of GP - use PDS Notifications FHIR API
- receive notifications about any PDS record change - use PDS Notifications FHIR API

You can read and update the following data: 

- NHS number (read only)
- name
- gender
- addresses and contact details
- birth information
- death information
- registered GP
- nominated pharmacy
- dispensing doctor pharmacy
- medical appliance supplier pharmacy
- related people, such as next of kin (read only - update coming soon)

Patients included in PDS Regardless of nationality, or where they live now, PDS includes all patients who have ever been registered with a GP practice, or treated by a health or care organisation (even as a visitor or migrant) in England, Wales, the Isle of Man, or in a UK Defence Medical Services unit anywhere in the world. All patients in PDS have an NHS number which is unique. The 10-digit NHS number is used in England, Wales, the Isle of Man, Scotland and Northern Ireland, but not the Channel Islands. Scotland and Northern Ireland have their own distinct number ranges. Access modes This API has three access modes: 

### Application-restricted access

- Search for a patient (single result).Get patient details.
- Available in production (stable)

### Healthcare worker access

- Search for patients (multiple results).Get patient details.Update patient details.
- Available in production (beta)

### Patient access

- Get own details.Update own details (limited).
- Available in production (beta)

For further details about the access modes for this API, see Security and authorisation below. ",https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3,Personal Demographics Service - HL7 V3 API,"Use this API to access the Personal Demographics Service (PDS), the national electronic database of NHS patient details such as name, address, date of birth, related people, registered GP and NHS number.

You can:

- search for patients
- check that you have the correct NHS number for a patient
- get patient details
- create a new record for a birth
- receive birth notifications - although another option is PDS Notifications FHIR API
- create a record for a new patient (except for GPs - see below)

You should not use this API to create a new record when registering a new patient at a GP Practice. Instead, use National Health Application and Infrastructure Services (NHAIS).

You can retrieve current and historical demographic information for a patient including:

- NHS number
- name
- gender
- birth information
- address
- contact details
- registered GP
- preferred pharmacy
- consent information
- related people, such as next of kin
- death information

### Spine Mini Service Provider (SMSP) options

There are also commercially available products which give easier access to PDS, known as Spine Mini Service Providers (SMSPs).

These and other conforming software products are listed in our Conformance Catalogue.

If you are interested in becoming a provider of one of these products, see Personal Demographics Service - SMSP API standards.

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/personal-demographic-service-mesh,Personal Demographics Service MESH,"Use this message integration to search the Personal Demographics Service (PDS) for patient details, using the MESH UI.

The PDS MESH service - formerly known as Master Patient Trace (MPT) - is provided for organisations that do not want to write their own software - typically NHS trusts or local authorities.

It is not intended for software integration - use the PDS FHIR API instead.

It is a batch message integration.  It does not expect an immediate response from PDS.

It requires PDS access approval and a MESH mailbox set up before you can use it.

You can:

- create a file containing a trace request
- send the trace request to PDS
- check for replies and download the response

For how to use PDS MESH, see Using the PDS MESH service with the MESH user interface. 

",https://digital.nhs.uk/developer/api-catalogue/personal-demographic-service-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-notifications-fhir,Personal Demographics Service Notifications - FHIR,"Use this integration to receive notifications about changes to a patient's demographic details, including:

- birth notifications - although another option is PDS HL7 V3 API
- death notifications
- change of address
- change of GP
- any record change (beta) - to notify subscribers to synchronise their local PDS patient database

We share information about these events with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities.

This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via Message Exchange for Social Care and Health (MESH).

For example, when we update Personal Demographics Service (PDS) with a birth, PDS sends a birth notification event containing information about the birth to NEMS. NEMS then sends the event to all healthcare workers who have subscribed to receive birth notifications. 

",https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-notifications-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-smsp,Personal Demographics Service - SMSP API,"Use this API to access the Personal Demographics Service (PDS) - the national electronic database of NHS patient details such as name, address, date of birth, related people, registered GP and NHS number.

You can:

- verify a patient's NHS number
- retrieve a patient's details
- search for patient details

You cannot use this API to:

- update patient details
- create a new record for a birth
- receive birth notifications 
- create a new record for a new patient
- register a new patient at a GP Practice - use National Health Application and Infrastructure Services (NHAIS) instead

This API:

- does not require the end user to be strongly authenticated with a smartcard
- only returns a result from a search if there is a single, unique match - it does not return multiple matches

### Spine Mini Service Provider (SMSP) options

There are also commercially available products which give easier access to PDS, known as Spine Mini Service Providers (SMSPs).

These and other conforming software products are listed in our Conformance Catalogue.

If you are interested in becoming a provider of one of these products, see Personal Demographics Service - SMSP API standards. ",https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-smsp,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/query-accredited-system-information-soap,Query Accredited System Information - SOAP API,"Use this API to search for details about accredited systems and the processes they support, known as interactions, which are held in the Spine Directory Service (SDS) repository. 

This API provides reference information on these accredited systems, along with details of how to interact with these systems. For example, use this API to retrieve the details of the API endpoint to which a PDS update message can be sent.

Use this API to:

- search for and obtain information on accredited systems such as their accredited system identifier (ASID) and associated messaging endpoint information.
- verify whether a specific accredited system is able to handle a specified interaction.

For more details, see the Spine External Interface Specification (EIS) Part 5 - Spine Directory Services (SDS). ",https://digital.nhs.uk/developer/api-catalogue/query-accredited-system-information-soap,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/radiology-mesh,Radiology MESH,"Use this message integration to send radiology messages from a radiology department to a GP system over MESH.  

It uses MESH to send and receive messages. 

",https://digital.nhs.uk/developer/api-catalogue/radiology-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/reasonable-adjustment-flag-fhir,Reasonable Adjustment Flag - FHIR API,"Use this API to access and update the Reasonable Adjustment Flag - a national record which indicates that a patient requires reasonable adjustments and optionally includes details of impairments and adjustments to be considered. You can: 

- check if a Reasonable Adjustment Flag exists
- read a Reasonable Adjustment Flag
- create a Reasonable Adjustment Flag
- update a Reasonable Adjustment Flag
- remove a Reasonable Adjustment Flag

The flag consists of three parts: 

- details of consent to share the Flag and how this was obtained. Consent may have been given by the patient or via a 'best interest decision' under the Mental Capacity Act (2005). In some cases consent can also be obtained from a lasting power of attorney for health and welfare or a court appointed deputy.
- details of impairments, which enable clinicians to understand the range of adjustments the patient may require. Note that the patient may decline to say what their impairments are.
- details of reasonable adjustments to services which are needed by the patient when providing their care.

This API can only be used by relevant health and care staff providing direct care, authenticated with an NHS smartcard or equivalent. The existance of a flag is intended to be visible to all staff who have access to the patient record.  The contents of the Flag may only be visible to clinical staff - as determined by role-based access controls (RBAC). For more details see Registration authorities and smartcards. To find out more about how the flag works, categories and types of adjustments and the recording of impairments see How the Reasonable Adjustment Flag works. To watch a video of a Reasonable Adjustment Flag being created in SCRa see Creating a Reasonable Adjustment Flag on the NHS Spine. ",https://digital.nhs.uk/developer/api-catalogue/reasonable-adjustment-flag-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/signing-service,Signing Service API,"Use this API to digitally sign one or more prescriptions from an application that cannot communicate directly with an NHS smartcard reader. You cannot currently use this API to: 

- produce signatures using an algorithm other than RS1 (RSASSA-PKCS1-v1_5 with SHA-1)

End users of this API must be authenticated with an NHS smartcard or modern alternative. ",https://digital.nhs.uk/developer/api-catalogue/signing-service,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-fhir,Spine Directory Service - FHIR API,"Use this API to access details of systems registered in the Spine Directory Service (SDS). You can: 

- get accredited system details

You cannot currently use this API to: 

- search for organisations
- search for people

Accredited system records Every system that connects to the Spine has one or more “Accredited System” (AS) records in SDS, identified by an Accredited System Identifier (ASID).

This ASID is unique to a system deployed in a specific organisation, so the same application deployed into three NHS organisations would typically be represented as three unique ASIDs. MHS records and endpoints Every GP Connect system also has one or more “MHS” records (or message handling server record), identified by Party Key and Interaction ID.

MHS records of GP Connect provider systems contain the endpoint of the target practice, as defined by the FHIR service root URL.

Please see System topologies for more details on the allocation of ASIDs and Party Keys. 

For all intermediary messaging endpoint lookups, this API returns the NHS Digital Spine MHS endpoint address.

 ",https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-ldap,Spine Directory Service - LDAP API,"Use this API to access details from the Spine Directory Service (SDS) relating to:

- organisations - NHS organisations, their sites and departments
- people - healthcare workers who are Spine users, including their organisation and role
- systems registered with Spine

 ",https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-ldap,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/summary-care-record-fhir,Summary Care Record - FHIR API,"Use this API to access or update a patient's Summary Care Record (SCR) - an electronic record of important patient information, created from GP medical records. SCRs can be seen and used by authorised staff in other areas of the health and care system involved in the patient's direct care. This API is currently only approved for use in primary care software, specifically GP software. We hope to make it available for secondary care in the future. You can vote for this on our interactive product backlog. Also use this API to update a patient's consent to share their SCR, and to raise a privacy alert where you have to override a patient's dissent to share their SCR in certain circumstances. You can: 

- get a patient's SCR identifier
- get a patient's SCR
- upload a patient's SCR
- send a privacy alert message, if you have to override a patient's dissent to view their SCR
- update a patient's consent to share their SCR

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/summary-care-record-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/summary-care-record-hl7-v3,Summary Care Record - HL7 V3 API,"Use this API to access a patient's Summary Care Record (SCR) - a national electronic record of important patient information, created from GP summaries of medical records. SCRs can be seen and used by authorised staff in other areas of the health and care system involved in the patient's direct care.

Summary Care Record was previously known as Personal Spine Information Service (PSIS).

Also use this API to access the Access Control Service (ACS) - which manages consent to share information for SCR. GP systems must check consent to share before sharing a patient's Summary Care Record.

You can:

- create or add to a patient's Summary Care Record - as a GP system capable of uploading GP summaries
- retrieve a patient's Summary Care Record
- set and check consent to share information - via the Access Control Service (ACS)

You cannot use this API to update GP medical records.

### Spine Mini Service Provider (SMSP) options

There are also commercially available products which give easier access to SCR, known as Spine Mini Service Providers (SMSPs). 

These and other conforming software products are listed in our Conformance Catalogue.

If you are interested in becoming a provider of one of these products, see Summary Care Record - SMSP API standards.

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API. ",https://digital.nhs.uk/developer/api-catalogue/summary-care-record-hl7-v3,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/technology-reference-update-distribution-api,Technology Reference Update Distribution API,"Use this API to automate the download of Technology Reference Update Distribution (TRUD) release files.

These include:

- classification products, including NHS Information Standards ICD and OPCS-4 in the UK, as well as other products to support the implementation of these clinical classifications and derivative products
- the NHS Data Model and Dictionary, which provides a reference point for approved Information Standards and Collections (including Extractions) (ISCEs) to support health care activities within the NHS in England
- terminology products such as SNOMED CT, the Read Codes and other products to support the implementation of terminology, including tools and derivative products

You can:

- request release information for an item
- request a release file once you have its release information

You must have a TRUD account before you can use this API. ",https://digital.nhs.uk/developer/api-catalogue/technology-reference-update-distribution-api,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/terminology-server-fhir,Terminology Server - FHIR APIs,"Use these APIs to retrieve content from the NHS England Terminology Server, including:

- international terminologies and classifications - such as SNOMED-CT and ICD-10
- national terminologies - such as NHS Data Model and Dictionary codes

You can:

- directly query the terminology server in real time, using a number of FHIR APIs, as defined by the HL7 FHIR-compliant terminology module standard
- access a syndicated feed of terminology and classifications content in a machine-readable format, via an API
- syndicate content across a group of terminology servers
- share your own terminologies with others

Some content in the Terminology Server is freely available for read access, such as Data Dictionary. Other content is subject to access controls appropriate to the license, such as SNOMED-CT.

To see what terminologies and classifications you can retrieve, see content in the NHS England Terminology Server.

As well as these APIs, there are a number of end user terminology browsing tools available.

For more information, see terminology servers. ",https://digital.nhs.uk/developer/api-catalogue/terminology-server-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-emergency-care-discharge-fhir,Transfer of Care Emergency Care Discharge - FHIR,"Use this integration to send discharge information from an emergency care provider to a GP practice.

For example, a patient attends A&E due to abdominal pain. After diagnosis and treatment the patient is discharged by an emergency care specialist who completes and sends an Emergency Care Discharge document to the patient’s GP.

This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care message specifications.

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-emergency-care-discharge-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-inpatient-discharge-fhir,Transfer of Care Inpatient Discharge - FHIR,"Use this integration to create and transmit documents containing Transfer of Care information supporting an inpatient and day case discharge.

An Inpatient and Day Case Discharge Summary Document (also known as an ITK3 eDischarge) is an ITK3 FHIR document containing Transfer of Care information supporting inpatient and day case discharges typically between an acute hospital and a GP practice.

For example, a patient attends hospital for elective hip replacement surgery and is discharged by her consultant after a couple of days. The consultant completes and sends an eDischarge document to her GP.

This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR message specifications.

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-inpatient-discharge-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-mental-health-discharge-fhir,Transfer of Care Mental Health Discharge - FHIR,"Use this integration to create and transmit documents containing Transfer of Care information supporting a mental health discharge.

An Inpatient and Day Case Discharge Summary (Mental Health) Document (also known as an ITK3 Mental Health Discharge) is an ITK3 FHIR document containing Transfer of Care information supporting a mental health adult discharge summary to a GP practice.

For example, following an apparent overdose, a patient is admitted to a psychiatric ward for evaluation and treatment which is successful. He is discharged and the consultant sends a copy of the Mental Health Discharge to his GP.

This API is a messaging API which uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR message specifications.

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-mental-health-discharge-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-mesh,Transfer of Care - MESH,"Use this message integration to send transfer of care information from an emergency care provider to a GP practice.  

It uses MESH to send and receive messages. 

",https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-mesh,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-outpatient-clinic-letter-fhir,Transfer of Care Outpatient Clinic Letter - FHIR,"Use this integration to create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic.

An Outpatient Clinic Letter (also known as an ITK3 Outpatient Letter) is an ITK3 FHIR document containing Transfer of Care information from the hospital to the patient's GP and other relevant parties following a consultation in a clinic.

For example, a patient suffering from double vision is referred to an eye hospital and subsequently attends their outpatient appointment. Investigations indicate hypertropia, and the ophthalmologist recommends glasses fitted with prisms for treatment. The ophthalmologist completes and sends an Outpatient Clinic Letter to her GP.

This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR specifications.

Before you begin any development work using this integration, contact us to discuss your best options. 

",https://digital.nhs.uk/developer/api-catalogue/transfer-of-care-outpatient-clinic-letter-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/urgent-and-emergency-care-continuous-quality-improvement-api,Urgent and Emergency Care Continuous Quality Improvement API,"Use this API to submit 111 or 999 call triage data to us for quality monitoring purposes, following an NHS Pathways patient phone assessment.

As a 111 or 999 telephony provider's host system developer, you must submit triage data to us in real time following an NHS Pathways patient phone assessment. This is to comply with the Continuous Quality Improvement (CQI) requirement of the Pathways licence agreement.

Providers and their regional commissioning groups can also log in to view this data using the Intelligent Data Tool (IDT) dashboard.

Because of the dashboard name, this API is sometimes referred to as the Intelligent Data Tool (IDT) web service.

You need a valid account to use this API to submit data. ",https://digital.nhs.uk/developer/api-catalogue/urgent-and-emergency-care-continuous-quality-improvement-api,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/vaccination,Vaccination,"Use these integrations to provide vaccination information to us at NHS Digital.

You can send us information relating to:

- coronavirus (COVID-19) vaccinations
- COVID-19 extended data attributes
- COVID-19 hourly vaccination aggregate data for the NHS Foundry
- seasonal flu vaccinations
- measles, mumps and rubella (MMR) vaccinations

These integrations specify the flow of vaccination-related information from healthcare settings including:

- hospital hubs - NHS providers vaccinating on site 
- local vaccine services – community or primary care led services which could include primary care facilities, retail, community facilities, temporary structures or roving teams 
- vaccination centres – large sites such as sports and conference venues set up for high volumes of people 

These integrations use MESH to send and receive pipe-delimited (|) and not-sign-delimited (¬) files.

For more details on how to interact with end users to collect COVID-19 information safely, see the functional specifications under 'Additional guidance'.

For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR.

For FHIR standards relating to the flow of information to other care providers such as Child Health, see Vaccination Events - FHIR. 

",https://digital.nhs.uk/developer/api-catalogue/vaccination,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/vaccination-adverse-reactions-covid-19,Vaccination Adverse Reactions COVID-19,"Use this integration to provide information to us at NHS Digital on adverse reactions.

You can send us information on adverse reactions relating to: 

- coronavirus (COVID-19) vaccinations.

This integration specifies the flow of information relating to vaccination-related adverse reactions from any healthcare setting including:

- hospital hubs - NHS providers vaccinating on site 
- local vaccine services – community or primary care led services which could include primary care facilities, retail, community facilities, temporary structures or roving teams 
- vaccination centres – large sites such as sports and conference venues set up for high volumes of people 

This integration uses MESH to send pipe-delimited files to us.

For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR.

Regulatory reporting

This information flow captures any adverse reactions which occur within the first fifteen minutes after administration of the coronavirus (COVID-19) vaccination. 

At NHS Digital, we must share this information with the Medicines and Healthcare products Regulatory Agency (MHRA) Yellow Card scheme. This scheme is the UK system for collecting and monitoring information on suspected safety concerns or incidents involving medicines and medical devices, including vaccines. 

The information we share with MHRA as part of this scheme is anonymised. 

",https://digital.nhs.uk/developer/api-catalogue/vaccination-adverse-reactions-covid-19,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital
2024-04-23,2024-04-23,https://digital.nhs.uk/developer/api-catalogue/vaccination-events-fhir,Vaccination Events - FHIR,"Use this integration to publish or receive messages about changes to a patient's vaccination details, including:

- new vaccinations
- updated vaccination details
- deleted vaccination details

This service currently covers childhood vaccinations up to the age of 19, and for direct care purposes only, in the context of Digital Child Health. If you'd like to use this API to publish or consume other vaccination types across all age groups, contact [email protected].

Using a publish-subscribe model, we share information about these events with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities.

This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via MESH.

For example, when a GP system records a vaccination, it sends an event message containing the vaccination details to NEMS. NEMS then sends the message to all healthcare workers who have subscribed to receive vaccination event messages. 

",https://digital.nhs.uk/developer/api-catalogue/vaccination-events-fhir,,https://digital.nhs.uk/developer/help-and-support,,,,nhs-digital