GtR APIs Explained

NOTE: the endpoints for the GtR API (version 1) have changed as follows:

  • Schema endpoint - has not changed and is still available at https://gtr.ukri.org/api
  • Projects endpoint - is now at https://gtr.ukri.org/api/projects
  • Organisations endpoint - is now at https://gtr.ukri.org/api/organisation
  • People endpoint - is now at https://gtr.ukri.org/api/person
  • Publication endpoint - is now at https://gtr.ukri.org/api/publication
  • Search projects endpoint - is now at https://gtr.ukri.org/api/search/project
  • Search people endpoint - is now at https://gtr.ukri.org/api/search/person
  • Search organisation endpoint - is now at https://gtr.ukri.org/api/organisation
The documentation still has the old endpoints in it, but we are working on creating new documentation with the new endpoints.

What is an API?

  • An Application Programming Interface (API) is a set of programming instructions and standards for accessing a web-based software application.
  • GtR has made two APIs available which allow developers to create applications that are able to extract information, about research, directly from the GtR website; such applications might typically be created to analyse the data in ways that add value for users.

Who can use the APIs?

  • The APIs are for use by people with technical experience of APIs. Further information can be found in the documentation below.

Which APIs are supported on GtR?

  • The GtR API is developed around the requirements of the website and is linked directly to each of the screens.
  • The GtR-2 API accesses the data in a form that provides greater independence from the current User Interface, and provides versioning to allow clients to progress to later versions at their choosing.

How do I access the APIs?

  • Further information can be found in the documentation below.
    GtR API
    GtR-2 API