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. 

 

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

 

Counts Only or Full Access

 

Altmetric offers two types of access for the Details Page APIs:

 

  • The Counts Only provides information about individual research outputs. More information can be found here. This can also be accessed with a key for unlimited rates.

 

  • The Full Access includes the 'fetch' call that allows users to view detailed information about research outputs such as mentions, mentions URLs, X data etc. You can learn more about this API here.

 

Type

 

Conditions of use

 

What can I do with it? 

 

Counts Only

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

  • Must give attribution to Altmetric when using data

  • Run queries and retrieve counts of mentions from each source tracked by Altmetric.

  • Rate limited.

Counts Only 

with a key

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

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

  • Run queries and retrieve counts of mentions from each source tracked by Altmetric.

  • No rate limits.

Full Access

  • Paid, contract access

  • Display the data as and where you choose

  • Run queries and retrieve full text of mentions (excluding X posts due to licensing restrictions).

  • Display data publicly (as agreed in contract), with no rate limits.