pybliometrics.sciencedirect.ArticleRetrieval

ArticleRetrieval() implements the ScienceDirect Article (Full Text) Retrieval API.

It accepts any identifier as the main argument. Most commonly, this will be a Scopus EID, but DOI, Scopus ID (the last part of the EID), PubMed identifier or Publisher Item Identifier (PII) work as well. ArticleRetrieval tries to infer the class itself - to speed this up you can tell the ID type via id_type.

The Article (Full Text) API allows a differing information depth via views, some of which are restricted. The ‘META_ABS’ view is the most comprehensive among unrestricted views, encompassing all information from other unrestricted views. It is therefore the default view. The view with the most information content is ‘FULL’, which includes all information available with ‘META’, but is restricted. Generally, you should always try to use view=’FULL’ when downloading an abstract and fall back to the default otherwise.

In addition, the ‘ENTITLED’ view lets you check you whether you have access to this class.

Documentation

class pybliometrics.sciencedirect.ArticleRetrieval(identifier, refresh=False, view='META', id_type=None, **kwds)[source]

Interaction with the Article Retrieval API.

Parameters:

  • identifier (int | str) – The indentifier of an article.

  • refresh (bool | int, optional) – 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.

    Default: False

  • view (str, optional) – The view of the file that should be downloaded. Allowed values: ‘META’, ‘META_ABS’, ‘META_ABS_REF’, ‘FULL’, ‘ENTITLED’. Default: ‘META’.

    Default: 'META'

  • id_type (str | None, optional) – The type of used ID. Allowed values: None, ‘eid’, ‘pii’, ‘scopus_id’, ‘pubmed_id’ and ‘doi’. If the value is None, pybliometrics tries to infer the ID type itself.

    Default: None

  • kwds (str)

property abstract: str | None

The abstract of a document.

property aggregationType: str | None

The aggregation type of a document.

property authors: list[Author] | None

The authors of a document.

property copyright: str | None

The copyright of a document.

property coverDate: str | None

The date of the cover the document is in.

property coverDisplayDate: str | None

The cover display date of a document.

property document_entitlement_status: str | None

Returns the document entitlement status, i.e. tells if the requestor is entitled to the requested resource. Note: Only works with ENTITLED view.

property doi: str

The doi of a document.

property eid: str | None

The eid of a document.

property endingPage: str | None

The ending page of a document.

property issn: int

The issn of a document.

property openaccess: bool

The document is open access.

property openaccessSponsorName: str | None

The open access sponsor name of a document.

property openaccessSponsorType: str | None

The open access sponsor type of a document.

property openaccessType: str | None

The open access type of a document.

property openaccessUserLicense: str | None

The open access user license of a document.

property openArchiveArticle: bool

The document is an open archive article.

property originalText: str | None

Complete document text.

property pageRange: str | None

pageRange of a document.

Type:

The prism

property publicationName: str

The publication name of a document (e.g. Journal of Economy and Technology).

property publisher: str | None

The publisher of a document.

property pubType: str | None

The publication type of a document.

property pii: str

The pii of a document.

The ScienceDirect link of a document.

The API link of a document.

property startingPage: str | None

The starting page of a document.

property subjects: list[str] | None

The subjects of a document.

property title: str

The title of a document.

property url: str

The url of a document.

property volume: int | None

volume of a document.

Type:

The prism

get_cache_file_age()

Return the age of the cached file in days.

Return type:

int

get_cache_file_mdate()

Return the modification date of the cached file.

Return type:

str

get_key_remaining_quota()

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

Return type:

str | None

get_key_reset_time()

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

Return type:

str | None

Examples

You initialize the class with an ID that ScienceDirect uses, e.g. the EID:

>>> from pybliometrics.sciencedirect import ArticleRetrieval, init
>>> init()
>>> ar = ArticleRetrieval('S2949948823000112', view='FULL')

ArticleRetrieval has 34 properties to interact with, including the abstract and the complete originalText:

>>> ar.abstract
'Artificial Neural Networks (ANNs) are a type of machine learning algorithm inspired by the structure and function of the human brain...'
>>> ar.originalText
'serial JL 783536 291210 291861 291871 291876 291884 31 90 Journal of Economy and Technology ...'

In addition to metadata such as authors, coverDate and pubType, ArticleRetrieval contains information about the subjects of the document:

>>> ar.subjects
['Artificial neural networks', 'Supply chain management']