pybliometrics.scopus.AffiliationRetrieval

class pybliometrics.scopus.AffiliationRetrieval(aff_id, refresh=False, view='STANDARD')[source]

Interaction with the Affiliation Retrieval API.

Parameters:
  • aff_id (str or int) – The Scopus Affiliation ID. Optionally expressed as an Elsevier EID (i.e., in the form 10-s2.0-nnnnnnnn).
  • 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.
  • view (str (optional, default=STANDARD)) – The view of the file that should be downloaded. Allowed values: LIGHT, STANDARD, where STANDARD includes all information of the LIGHT view. For details see https://dev.elsevier.com/sc_affil_retrieval_views.html. Note: Neither the BASIC view nor DOCUMENTS or AUTHORS views are active, although documented.

Examples

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

Notes

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

address

The address of the affiliation.

affiliation_name

The name of the affiliation.

author_count

Number of authors associated with the affiliation.

city

The city of the affiliation.

country

The country of the affiliation.

date_created

Date the Scopus record was created.

document_count

Number of documents for the affiliation.

eid

The EID of the affiliation.

identifier

The Scopus ID of the affiliation.

name_variants

A list of namedtuples representing variants of the affiliation name with number of documents referring to this variant.

org_domain

Internet domain of the affiliation. Requires the STANDARD view.

org_type

Type of the affiliation. Requires the STANDARD view and only present if profile is org profile.

org_URL

Website of the affiliation. Requires the STANDARD view.

postal_code

The postal code of the affiliation. Requires the STANDARD view.

Link to the Scopus web view of the affiliation.

Link to the affiliation’s API page.

URL to the API page listing documents of the affiliation.

state

The state (country’s administrative sububunit) of the affiliation. Requires the STANDARD view.

sort_name

The name of the affiliation used for sorting. Requires the STANDARD view.

url

URL to the affiliation’s API page.

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