pybliometrics.scopus.SerialSearch

class pybliometrics.scopus.SerialSearch(query, refresh=False, view='ENHANCED')[source]

Interaction with the Serial Title API.

Parameters:
  • query (dict) – Query parameters and corresponding fields. Allowed keys ‘title’, ‘issn’, ‘pub’, ‘subj’, ‘subjCode’, ‘content’, ‘oa’. For examples on possible values, please refer to https://dev.elsevier.com/documentation/SerialTitleAPI.wadl#d1e22.
  • 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="ENHANCED")) – The view of the file that should be downloaded. Allowed values: STANDARD, ENHANCED, CITESCORE. For details see https://dev.elsevier.com/sc_serial_title_views.html.
Raises:
  • Scopus400Error – If provided value for a query key is invalid or if for non-subscribers the number of search results exceeds 5000.
  • ValueError – If view parameter is not one of allowed ones or if query contains invalid fields.

Examples

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

Notes

The directory for cached results is {path}/{view}/{fname}, where path is specified in ~/.scopus/config.ini and fname is the md5-hashed version of query dict turned into string in format of ‘key=value’ delimited by ‘&’.

results

A list of OrderedDicts representing results of serial search. The number of keys may vary from one search result to another depending on the length of yearly data. Note: Can be empty.

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

get_results_size()

Return the number of results (works even if download=False).