Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.1.0
info:
title: Altmetric API
version: '2026-11-01'
description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 7 operation(s) read from 7 public documentation page(s) (each operation
names its page in x-source). This is not the provider''s published contract; Altmetric has published no machine-readable contract that the
pipeline could find. Engine: local.'
x-evidence-tiers:
code-example: 1
documentation: 6
pages-with-code: 1
pages-read: 7
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-11-01'
x-generator: generate-contract-from-docs.py
x-engine: local
x-sources:
- https://docs.altmetric.com/explorer-api/endpoints/journals
- https://docs.altmetric.com/explorer-api/endpoints/mentions
- https://docs.altmetric.com/details-page-api/endpoints/fetch
- https://docs.altmetric.com/details-page-api/endpoints/counts
- https://docs.altmetric.com/explorer-api/endpoints/departments
- https://docs.altmetric.com/explorer-api/endpoints/demographics
- https://docs.altmetric.com/details-page-api/endpoints/citations
servers:
- url: https://www.altmetric.com
paths:
/explorer/api/research_outputs/demographics:
get:
operationId: get_explorer_api_research_outputs_demographics
tags:
- Explorer
summary: The Demographics endpoint gives you access to aggregated location data from X tweet , Facebook fbwall , news msm , and policy policy
mentions.
x-source: https://docs.altmetric.com/explorer-api/endpoints/demographics
parameters:
- name: digest
in: query
required: true
schema:
type: string
description: A valid digest. See Authentication.
- name: key
in: query
required: true
schema:
type: string
description: A valid key. See Authentication.
- name: filter[filter]
in: query
required: false
schema:
type: string
description: tweet fbwall msm policy guideline. Defaults to X if not specified.
- name: filter[key]
in: query
required: false
schema:
type: string
description: q, scope, title, published_after, published_before, timeframe, orcid, identifier_list_id, etc. See Filters section.
- name: filter[key][]
in: query
required: false
schema:
type: string
description: author_id, department_id, publisher_id, doi_prefix, journal_id, funders, handle_prefix, affiliations, field_of_research_codes,
sustainable_development_goals, type, open_access_types, researcher_id, grant_id. Supports multiple values.
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetExplorerApiResearchOutputsDemographicsResponse'
x-evidence:
kind: documentation
/explorer/api/research_outputs/journals:
get:
operationId: get_explorer_api_research_outputs_journals
tags:
- Explorer
summary: The Journals endpoint gives you access to aggregated mentions data by journal.
description: Basic GET request to get aggregated journal data. This endpoint is a single‑page endpoint (no pagination).
x-source: https://docs.altmetric.com/explorer-api/endpoints/journals
parameters:
- name: digest
in: query
required: true
schema:
type: string
description: A valid digest. See Authentication.
- name: key
in: query
required: true
schema:
type: string
description: A valid key. See Authentication.
- name: filter[filter]
in: query
required: false
schema:
type: string
description: q scope title published_after published_before timeframe orcid identifier_list_id
- name: filter[key]
in: query
required: false
schema:
type: string
description: order, publication date, source, mention timeframe, publisher_id, department_id, author_id, doi_prefix, journal_id, funders,
handle_prefix, affiliations, field_of_research_codes, q, sustainable_development_goals, title, type, open_access_types, published_after,
published_before, timeframe, orcid, identifier_list_id, researcher_id, grant_id
- name: filter[key][]
in: query
required: false
schema:
type: string
description: author_id, department_id, publisher_id, doi_prefix, journal_id, funders, handle_prefix, affiliations, field_of_research_codes,
sustainable_development_goals, type, open_access_types, researcher_id, grant_id
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetExplorerApiResearchOutputsJournalsResponse'
x-evidence:
kind: documentation
/explorer/api/research_outputs/mentions:
get:
operationId: get_explorer_api_research_outputs_mentions
tags:
- Explorer
summary: The Mentions endpoint gives you access to all of the individual mentions of the research outputs from your search.
x-source: https://docs.altmetric.com/explorer-api/endpoints/mentions
parameters:
- name: digest
in: query
required: true
schema:
type: string
description: A valid digest
- name: key
in: query
required: true
schema:
type: string
description: A valid key
- name: include
in: query
required: false
schema:
type: string
description: journal profile research-output
- name: filter[sentiment][]
in: query
required: false
schema:
type: string
description: A sentiment score from -3 to 3
- name: filter[highlights]
in: query
required: false
schema:
type: string
description: true to return only highlights
- name: filter[mention_types][]
in: query
required: false
schema:
type: string
description: A mention type, e.g., msm, tweet, bluesky, rdt
- name: filter[mention_sources][]
in: query
required: false
schema:
type: string
description: type:{mention type} or the id of a mention source
- name: filter[countries][]
in: query
required: false
schema:
type: string
description: ISO 3166-1 country code
- name: filter[mentioned_after]
in: query
required: false
schema:
type: string
description: Date "YYYY-MM-DD" to filter mentions after
- name: filter[mentioned_before]
in: query
required: false
schema:
type: string
description: Date "YYYY-MM-DD" to filter mentions before
- name: filter[key]
in: query
required: false
schema:
type: string
description: Various filter keys such as q, scope, title, etc.
- name: filter[key][]
in: query
required: false
schema:
type: string
description: Multiple values for filter keys like author_id, department_id, etc.
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetExplorerApiResearchOutputsMentionsResponse'
x-evidence:
kind: documentation
/v1/doi/10.1038/news.2011.490:
get:
operationId: get_v1_doi_10_1038_news_2011_490
tags:
- Doi
summary: Counts - Altmetric Documentation
x-source: https://docs.altmetric.com/details-page-api/endpoints/counts
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v1/fetch/doi/10.1038/news.2011.490:
get:
operationId: get_v1_fetch_doi_10_1038_news_2011_490
tags:
- Fetch
summary: Fetch detailed Altmetric information about a particular article or dataset.
x-source: https://docs.altmetric.com/details-page-api/endpoints/fetch
parameters:
- name: key
in: query
required: true
schema:
type: string
description: Your API key.
- name: include_sources
in: query
required: false
schema:
type: string
description: Comma‑delimited list of post types to include; defaults to all.
- name: exclude_sources
in: query
required: false
schema:
type: string
description: Comma‑delimited list of post types to exclude; defaults to none.
- name: include_sections
in: query
required: false
schema:
type: string
description: Comma‑delimited list of response sections to include.
- name: post_types
in: query
required: false
schema:
type: string
description: Comma‑delimited list of additional filters on post sub‑types.
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetV1FetchDoi101038News2011490Response'
x-evidence:
kind: documentation
/{version}/fetch/{identifierType}/{id}:
get:
operationId: get_version_fetch_identifierType_id
tags:
- Fetch
summary: Fetch detailed Altmetric information about a particular article or dataset.
x-source: https://docs.altmetric.com/details-page-api/endpoints/fetch
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: identifierType
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: key
in: query
required: true
schema:
type: string
description: Your API key.
- name: include_sources
in: query
required: false
schema:
type: string
description: Comma‑delimited list of post types to include; defaults to all.
- name: exclude_sources
in: query
required: false
schema:
type: string
description: Comma‑delimited list of post types to exclude; defaults to none.
- name: include_sections
in: query
required: false
schema:
type: string
description: Comma‑delimited list of response sections to include (counts, citation, altmetric_score, demographics, sentiments, posts,
images).
- name: post_types
in: query
required: false
schema:
type: string
description: Comma‑delimited list of additional filters on post sub‑types (e.g., original_tweets).
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetVersionFetchIdentifiertypeIdResponse'
x-evidence:
kind: documentation
/{version}/{identifierType}/{id}:
get:
operationId: get_version_identifierType_id
tags:
- Api
summary: Counts - Altmetric Documentation
x-source: https://docs.altmetric.com/details-page-api/endpoints/counts
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: identifierType
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetVersionIdentifiertypeIdResponse'
x-evidence:
kind: documentation
components:
schemas:
GetExplorerApiResearchOutputsDemographicsResponse:
type: object
properties:
meta:
type: object
description: Meta information about the query and response.
meta.query.key:
type: string
description: The API key used to make the request.
meta.query.digest:
type: string
description: The digest that was included in the request.
meta.query.page:
type: object
description: Pagination details (number, size).
meta.query.filter:
type: object
description: Provided filter parameters.
response:
type: object
description: Information about the response status.
response.status:
type: string
description: Friendly response status for the request.
response.description:
type: string
description: A description of the query.
response.total-results:
type: number
description: Total number of results matching the query.
response.total-pages:
type: number
description: Total number of pages required.
links:
type: object
description: Page navigation links (self, first, last, next, prev).
data:
type: array
description: Array of country objects.
data[].id:
type: string
description: Two‑letter country code or "unknown".
data[].type:
type: string
description: '"country".'
data[].attributes.name:
type: string
description: Full English name of the country.
data[].meta.mention-count:
type: number
description: Number of mentions.
data[].meta.unique-sources:
type: number
description: Number of unique entities mentioning this.
GetExplorerApiResearchOutputsJournalsResponse:
type: object
properties:
meta:
type: object
description: Response object containing meta information about the query and the response.
meta.query.key:
type: string
description: The API key used to make the request.
meta.query.digest:
type: string
description: The digest that was included in the request.
meta.query.page:
type: object
description: Pagination details (number, size).
meta.query.filter:
type: object
description: Provided filter parameters.
meta.response.status:
type: string
description: Friendly response status for the request.
meta.response.description:
type: string
description: A description of the query.
meta.response.total-results:
type: number
description: The total number of results matching the supplied query parameters.
meta.response.total-pages:
type: number
description: The total number of pages required to iterate in order to consume all matching results.
links:
type: object
description: Object containing page navigation information (self, first, last, next, prev).
data:
type: array
description: Array of journal objects.
data[].id:
type: string
description: Unique Altmetric generated code for this journal.
data[].type:
type: string
description: Always "journal".
data[].attributes.title:
type: string
description: Full journal name.
data[].attributes.issns:
type: array
description: One or more ISSNs associated with this journal.
data[].meta:
type: object
description: Aggregated journal attention metrics.
data[].meta.mentioned-research-outputs:
type: number
description: The number of research outputs mentioned.
data[].meta.total-mentions:
type: number
description: The total number of mentions from any source.
data[].meta.msm:
type: number
description: Number of mainstream news articles mentioning this research output.
data[].meta.bluesky:
type: number
description: Number of Bluesky posts mentioning this research output.
data[].meta.blog:
type: number
description: Number of mentions in blogs.
data[].meta.policy:
type: number
description: Number of policy citations.
data[].meta.guideline:
type: number
description: Number of Clinical Decision Guideline citations.
data[].meta.tweet:
type: number
description: Number of posts on X.
data[].meta.patent:
type: number
description: Number of citations in patent applications.
data[].meta.peer_review:
type: number
description: Number of mentions on Publons or PubPeer.
data[].meta.weibo:
type: number
description: Number of mentions on Sine Weibo.
data[].meta.fbwall:
type: number
description: Number of mentions on tracked Facebook walls.
data[].meta.wikipedia:
type: number
description: Number of Wikipedia pages with mentions.
data[].meta.gplus:
type: number
description: Number of mentions on GooglePlus.
data[].meta.linkedin:
type: number
description: Number of mentions in public LinkedIn posts.
data[].meta.rdt:
type: number
description: Number of mentions on Reddit subreddits.
data[].meta.pinterest:
type: number
description: Number of Pinterest mentions.
data[].meta.f1000:
type: number
description: Number of mentions on H1 (formerly FacultyOpinions).
data[].meta.qna:
type: number
description: Number of mentions in Stack Exchange.
data[].meta.video:
type: number
description: Number of YouTube videos with mentions.
data[].meta.syllabus:
type: number
description: Number of mentions on Open Syllabus.
data[].meta.podcast:
type: number
description: Number of mentions in podcast episodes.
data[].meta.seminar:
type: number
description: Number of mentions in seminars hosted on Cassyni.
GetExplorerApiResearchOutputsMentionsResponse:
type: object
properties:
meta:
type: object
description: Meta information about the query and response
links:
type: object
description: Pagination links
data:
type: array
description: Array of mention objects
included:
type: array
description: Included resources for deduplication
GetV1FetchDoi101038News2011490Response:
type: object
properties:
altmetric_id:
type: number
description: Internal Altmetric ID.
counts:
type: object
description: Mention and reader counts.
citation:
type: object
description: Bibliographic metadata.
altmetric_score:
type: object
description: Score details.
demographics:
type: object
description: User demographic breakdown.
posts:
type: object
description: Mention data by source.
sentiments:
type: object
description: Sentiment analysis (commercial only).
images:
type: object
description: Donut image URLs.
merged_into:
type: object
description: Record of merge if applicable.
GetVersionFetchIdentifiertypeIdResponse:
type: object
properties:
altmetric_id:
type: number
description: Internal Altmetric ID.
counts:
type: object
description: Mention and reader counts.
citation:
type: object
description: Bibliographic metadata.
altmetric_score:
type: object
description: Score details.
demographics:
type: object
description: User demographic breakdown.
posts:
type: object
description: Mention data by source.
sentiments:
type: object
description: Sentiment analysis (commercial only).
images:
type: object
description: Donut image URLs.
merged_into:
type: object
description: Record of merge if applicable.
GetVersionIdentifiertypeIdResponse:
type: object
properties:
title:
type: string
description: Title of the publication
altmetric_id:
type: number
description: Internal ID associated with the research output
doi:
type: string
description: Relevant DOI
pmid:
type: string
description: Relevant Pubmed Id
pmc:
type: string
description: Relevant Pubmed Central Id
uri:
type: string
description: URI for a captured identifier
url:
type: string
description: URL to publication page
isbns:
type: array
description: Relevant ISBN(s)
altmetric_jid:
type: string
description: Internal identifier assigned to each journal or collection
handles:
type: array
description: Relevant Handle(s)
issns:
type: array
description: Relevant ISSN(s)
journal:
type: string
description: Name of publication journal
dimensions_publication_id:
type: string
description: Unique identifier for the publication in the Dimensions publications database
pubdate:
type: number
description: The print date that the publication was published (Unix timestamp)
epubdate:
type: number
description: The date that the publication was published electronically (Unix timestamp)
published_on:
type: number
description: Returns epubdate if present, otherwise pubdate
cohorts:
type: object
description: Cohorts of users who have mentioned the publication
abstract:
type: string
description: Full abstract for the article
abstract_source:
type: string
description: Source for the abstract
authors:
type: array
description: Author names
type:
type: string
description: Dataset, book, article, news, chapter, clinical_trial_study_record
is_oa:
type: boolean
description: Deprecated
context:
type: object
description: Context information
cited_by_fbwalls_count:
type: number
description: Number of Facebook walls mentioning the output
cited_by_feeds_count:
type: number
description: Number of blogs mentioning the publication
cited_by_gplus_count:
type: number
description: Number of Google+ accounts sharing the publication
cited_by_msm_count:
type: number
description: Number of news sources mentioning the publication
cited_by_rdts_count:
type: number
description: Number of Redditors posting about this publication
cited_by_qna_count:
type: number
description: Number of forum/Stack Exchange accounts mentioning the publication
cited_by_tweeters_count:
type: number
description: Number of Twitter accounts tweeting this publication
cited_by_bluesky_count:
type: number
description: Number of Bluesky accounts posting this publication
cited_by_wikipedia_count:
type: number
description: Number of Wikipedia pages citing the publication
cited_by_policies_count:
type: number
description: Number of policy‑issuing organisations mentioning the publication
cited_by_guidelines_count:
type: number
description: Number of guideline‑issuing organisations mentioning the publication
cited_by_patents_count:
type: number
description: Number of patents mentioning the publication
cited_by_videos_count:
type: number
description: Number of YouTube channels mentioning the publication
cited_by_podcasts_count:
type: number
description: Number of podcast shows mentioning the publication
cited_by_seminars_count:
type: number
description: Number of seminar series mentioning the publication
cited_by_accounts_count:
type: number
description: Total unique sources referencing the research output
cited_by_posts_count:
type: number
description: Total number of individual posts for the research output
last_updated:
type: number
description: Last time the score changed (Unix timestamp)
score:
type: number
description: Current Altmetric Attention Score (unrounded)
history:
type: object
description: Score changes over time
added_on:
type: number
description: Date when Altmetric first captured attention (Unix timestamp)
scopus_subjects:
type: array
description: Deprecated
subjects:
type: array
description: Subjects for journal (Deprecated)
publisher_subjects:
type: array
description: Publisher subjects
readers:
type: object
description: Reader counts
readers_count:
type: number
description: Total unique readers across platforms
images:
type: object
description: Links to PNG donut images
details_url:
type: string
description: URL to Altmetric Details Page
authors_or_editors:
type: array
description: Author and editor names
attribution:
type: string
description: Source of data
tags:
- name: Api
- name: Doi
- name: Explorer
- name: Fetch