reference.rst

API Reference

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

Scopus

Search APIs

.. toctree::
    :maxdepth: 1

    reference/scopus/AffiliationSearch.rst
    reference/scopus/AuthorSearch.rst
    reference/scopus/ScopusSearch.rst

Retrieval APIs

.. toctree::
    :maxdepth: 1

    reference/scopus/AbstractRetrieval.rst
    reference/scopus/AffiliationRetrieval.rst
    reference/scopus/AuthorRetrieval.rst

Metadata APIs

.. toctree::
    :maxdepth: 1

    reference/scopus/CitationOverview.rst
    reference/scopus/PlumXMetrics.rst
    reference/scopus/SerialSearch.rst
    reference/scopus/SerialTitle.rst
    reference/scopus/SubjectClassifications.rst

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

ScienceDirect

Search APIs

.. toctree::
    :maxdepth: 1

    reference/sciencedirect/ScienceDirectSearch.rst
    reference/sciencedirect/ArticleMetadata.rst

Retrieval APIs

.. toctree::
    :maxdepth: 1

    reference/sciencedirect/ArticleRetrieval.rst
    reference/sciencedirect/ObjectRetrieval.rst
    reference/sciencedirect/ArticleEntitlement.rst
    reference/sciencedirect/ObjectMetadata.rst

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

Metadata APIs

.. toctree::
    :maxdepth: 1

    reference/sciencedirect/SubjectClassifications.rst

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

Initialization

.. currentmodule:: pybliometrics.utils

.. autoclass:: init
   :members:
   :inherited-members: