scopus.CitationOverview

class scopus.CitationOverview(eid, start, end=2018, 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) – The first year for which the citation count should be loaded
  • end (str or int (optional, default=datetime.now()year)) – The last year for which the citation count should be loaded. Default is the current year.
  • refresh (bool (optional, default=False)) – 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.

authors

A list of namedtuples storing author information, where each namedtuple corresponds to one author. The information in each namedtuple is (name surname initials id url). All entries are strings.

cc

List of tuples of yearly number of citations for specified years.

citationType_long

Type (long version) of the abstract (e.g. article, review).

citationType_short

Type (short version) of the abstract (e.g. ar, re).

doi

Document Object Identifier (DOI) of the abstract.

endingPage

Ending page.

h_index

h-index of ciations of the abstract (according to Scopus).

issn

ISSN of the publisher. Note: If E-ISSN is known to Scopus, this returns both ISSN and E-ISSN in random order separated by blank space.

issueIdentifier

Issue number for abstract.

lcc

Number of citations the abstract received after 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. the Journal).

rangeCount

Number of citations for specified years.

rowTotal

Number of citations (specified and omitted years).

scopus_id

The Scopus ID of the abstract. It is the second part of an EID. The Scopus ID might differ from the one provided.

startingPage

Starting page.

title

Abstract title.

url

URL to Citation Overview API view of the abstract.

volume

Volume for the abstract.