As part of our commitment to continuous improvement, we are excited to announce a significant upgrade to our REST API service. This upgrade aims to unify API endpoints and boost overall performance, offering you a more streamlined and efficient experience.
Here are some key points to look forward to with this upgrade.
Unifying API endpoints
We have significantly improved our API endpoints by reorganising and consolidating them for better clarity and ease of use. The URLs are now more intuitive, and users will have a smoother experience interacting with our services. However, these changes have introduced a few breaking changes, which we will discuss in detail in the breaking changes section.
Updated Swagger-Style Documentation
Our updated Swagger-style documentation is readily available to assist you in understanding and integrating the new API. You can access it at https://www.ebi.ac.uk/pdbe/api/v2/ now, and this will be available at this URL until we transition entirely. The documentation provides a comprehensive and interactive guide to our new API, making the transition more straightforward for developers.
Performance Improvement
The new framework underpinning our API has been optimised for enhanced performance. Expect improved response times, reduced latency, and a more responsive service overall.
Deprecation Timeline: Ensuring a Smooth Transition
We understand that transitioning to a new API can be a significant step for our users, and we want to make the process as seamless as possible. We have developed a carefully planned API Deprecation Timeline to facilitate this transition, guide you through the changes and ensure a smooth migration.
-
Deprecation Notification
Start Date: 04-07-2025 (DD-MM-YYYY)
We will officially announce the deprecation of the old API on this date. This is the beginning of the transition period, during which both the old and new APIs will be available for use.
-
Dual Support Period
Duration: 6 months
The old and new APIs will be supported during this phase, allowing users to migrate at their own pace. This period is designed to provide you with ample time to update your applications.
Current Entry-based API: https://www.ebi.ac.uk/pdbe/api/
Current Aggregated API: https://www.ebi.ac.uk/pdbe/graph-api/pdbe_doc/
New API: https://www.ebi.ac.uk/pdbe/api/v2/
-
Sunset Date
End Date: 12-01-2026 (DD-MM-YYYY)
The sunset date marks the end of support for the old APIs. After this date, the old APIs will be replaced by the new API and will be served as usual from https://www.ebi.ac.uk/pdbe/api/
Breaking Changes
As part of this transition, there are three main types of breaking changes:
- Updated URLs – We have revised the list of URLs, which are categorised below for your convenience. Please update them on your end as soon as possible.
- Response Format Changes – Modifications have been made to the response format. We encourage you to review the updated API documentation and adjust your logic accordingly.
- API Deprecations – Some APIs have been deprecated, and we recommend transitioning to their alternatives. Please review the list of deprecated APIs and their suggested replacements to ensure a smooth migration.
URL Changes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Deprecations
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Feedback
We are eager to receive your feedback!!
Please send us your feedback and comments regarding these updates to the PDBe API services to pdbehelp@ebi.ac.uk.
