scopus.CitationOverview

class scopus.CitationOverview(eid, start, end=2017, refresh=False)[source]

Class to represent the results from a Scopus Citation Overview. See https://api.elsevier.com/documentation/guides/AbstractCitationViews.htm.

Parameters:
  • eid (str) – The EID of the abstract.
  • start (str or int (optional, default=)) – The first year for which the citation count should be loaded
  • start – The last year for which the citation count should be loaded. Default is the current year.
  • refresh (bool (optional, default=datetime.now()year)) – Whether to refresh the cached file if it exists or not.

Notes

The files are cached in ~/.scopus/citation_overview/{eid}. Your API Key needs to be approved by Elsevier to access this view.

Attributes

authors A list of namedtuples storing author information, where each namedtuple corresponds to one author.
cc List of tuples of yearly number of citations for specified years.
citationType_long Type (long version) of the abstract (e.g.
citationType_short Type (short version) of the abstract (e.g.
doi Document Object Identifier (DOI) of the abstract.
CitationOverview.eid
endingPage Ending page.
h_index h-index of ciations of the abstract (according to Scopus).
issn ISSN of the publisher.
issueIdentifier Issue number for abstract.
lcc Number of citations the abstract received before the specified end year.
pcc Number of citations the abstract received before the specified start year.
pii The Publication Item Identifier (PII) of the abstract.
publicationName Name of source the abstract is published in (e.g.
rangeCount Number of citations for specified years.
rowTotal Number of citations (specified and omitted years).
startingPage Starting page.
title Abstract title.
url URL to Citation Overview API view of the abstract.
volume Volume for the abstract.