pybliometrics.scopus.CitationOverview

class pybliometrics.scopus.CitationOverview(eid, start, end=2021, citation=None, refresh=False)[source]

Interaction witht the Citation Overview API.

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.
  • citation (str (optional, default=None)) – Allows for the exclusion of self-citations or those by books. If None, will count all citations. Allowed values: None, exclude-self, exclude-books
  • refresh (bool or int (optional, default=False)) – Whether to refresh the cached file if it exists or not. If int is passed, cached file will be refreshed if the number of days since last modification exceeds that value.

Examples

See https://pybliometrics.readthedocs.io/en/stable/examples/CitationOverview.html.

Notes

The directory for cached results is {path}/STANDARD/{eid}, where path is specified in ~/.scopus/config.ini.

Your API Key needs to be approved by Elsevier to access this API.

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).

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.

rangeCount

Number of citations for specified years.

rowTotal

Number of citations (specified and omitted years).

title

Abstract title.

url

URL to Citation Overview API view of the abstract.

volume

Volume for the abstract.

get_cache_file_age()

Return the age of the cached file in days.

get_cache_file_mdate()

Return the modification date of the cached file.

get_key_remaining_quota()

Return number of remaining requests for the current key and the current API (relative on last actual request).

get_key_reset_time()

Return time when current key is reset (relative on last actual request).