API Reference

Each class in pybliometrics corresponds to one of the Product Specific APIs for Scopus, ScienceDirect and SciVal. See below links for class reference and examples.

Scopus

Search APIs

• pybliometrics.scopus.AffiliationSearch
• pybliometrics.scopus.AuthorSearch
• pybliometrics.scopus.ScopusSearch

Retrieval APIs

• pybliometrics.scopus.AbstractRetrieval
• pybliometrics.scopus.AffiliationRetrieval
• pybliometrics.scopus.AuthorRetrieval

Metadata APIs

• pybliometrics.scopus.CitationOverview
• pybliometrics.scopus.PlumXMetrics
• pybliometrics.scopus.SerialTitleSearch
• pybliometrics.scopus.SerialTitleISSN
• pybliometrics.scopus.SubjectClassifications

One other Metadata API, the Citations Count Metadata API, is not implemented yet.

ScienceDirect

Search APIs

• pybliometrics.sciencedirect.ScienceDirectSearch
• pybliometrics.sciencedirect.ArticleMetadata

Retrieval APIs

• pybliometrics.sciencedirect.ArticleEntitlement
• pybliometrics.sciencedirect.ArticleRetrieval
• pybliometrics.sciencedirect.NonserialTitle
• pybliometrics.sciencedirect.ObjectMetadata
• pybliometrics.sciencedirect.ObjectRetrieval
• pybliometrics.sciencedirect.SerialTitleISSN

One other Retrieval API, the Article Hosting Permission API, is not implemented yet.

Metadata APIs

• pybliometrics.sciencedirect.SubjectClassifications

Two other Metadata APIs, Serial Title Metadata API and Nonserial Title Metadata API, are not implemented yet.

SciVal

• pybliometrics.scival.AuthorMetrics
• pybliometrics.scival.InstitutionLookupMetrics
• pybliometrics.scival.PublicationLookup
• pybliometrics.scival.TopicLookupMetrics

Several other APIs are not implemented yet.

Initialization

class pybliometrics.utils.init(config_path=None, keys=None, inst_tokens=None, config_dir=None)

Function to initialize the pybliometrics library. For more information refer to the official documentation.

Parameters:

• config_path (str | Path | None, optional) – Path to the configuration file. If None, defaults to pybliometrics.utils.constants.CONFIG_FILE.

  Default: None

• keys (list[str] | None, optional) – List of API keys.

  Default: None

• inst_tokens (list[str] | None, optional) – List of corresponding InstTokens. The order must match that of keys to avoid errors.

  Default: None

• config_dir (str | Path | None, optional) – (Deprecated) Path to the configuration file. Use config_path instead.

  Default: None

Raises:

• NoSectionError – If the required sections (Directories, Authentication, Request) do not exist.

• ValueError – If there are no or fewer API keys than InstTokens present.