What is the Altmetric Details Page API?

 

The Altmetric Details Page API is the API that powers the Altmetric details pages and the Altmetric badges. The Details Page API allows users to see the information from the Details Pages and the badges in a machine readable way. The Altmetric Details Page API has two tiers: Counts Only and Full Access. 

 

Who can use the Altmetric Details Page API?

 

The Altmetric Details Page API is available free of charge for scientometric researchers based within universities. For more information about access please visit our  Researcher Data Access page. 

 

Individual researchers may also be able to get access to the Altmetric Details Page API through the institution they are affiliated with, as long as the institution already has a licence in place to use the API. Please contact your librarian or institutional administrator for more information.


For any other uses or projects using the Altmetric Details Page API please contact us. 

 

Access and types of endpoints


Altmetric offers the following endpoints for the Details Page APIs:

  • The Counts Only provides information about individual research outputs. More information can be found here.

 

  • The 'Fetch' call allows users to view detailed information about research outputs such as mentions, mentions URLs, X data etc. You can learn more about this endpoint here.

  • The Citations endpoint returns a list of research outputs with activity in a given timeframe. You can learn more about this endpoint here.

All users will need an API key to access the data from any of the endpoints.


Type

Conditions of use

What can I do with it?

Free access (non-commercial use)

  • For researchers working on a specific academic, one-off project. Apply here.

  • Must give attribution to Altmetric when using data, let Altmetric know what project you’re working on with the data and provide updates.

  • Level of access to endpoints (Counts only, or Counts, Fetch, and Citations) determined at application review stage

  • API key required to access the data.

  • Rate limited.

Paid, commercial access

  • Paid, contract access.

  • Display the data as and where you choose.

  • Range of endpoints (Counts only, or Counts, Fetch, and Citations) included to be agreed as part of contract.

  • Run queries and retrieve full text of mentions with the Fetch endpoint (excluding Tweets due to licensing restrictions).

  • Display data publicly (as agreed in contract).

  • API key required to access the data.

  • No rate limits.