scopus.ScopusSearch

class scopus.ScopusSearch(query, fields='eid', count=200, start=0, max_entries=5000, refresh=False)[source]

Class to search a query, and retrieve a list of EIDs as results.

Parameters:
  • query (str) – A string of the query.
  • fields (str (optional, default='eid')) – The list of fields you want returned.
  • count (int (optional, default=200)) – The number of entries to be displayed at once. A smaller number means more queries with each query having less results.
  • start (int (optional, default=0)) – The entry number of the first search item to start with.
  • refresh (bool (optional, default=False)) – Whether to refresh the cached file if it exists or not.
  • max_entries (int (optional, default=5000)) – Raise error when the number of results is beyond this number. The Scopus Search Engine does not allow more than 5000 entries.
Raises:

Exception – If the number of search results exceeds max_entries.

Notes

XML results are cached in ~/.scopus/search/{query}.

The EIDs are stored as a property named EIDS.

Attributes

EIDS List of EIDs retrieved.
org_summary Summary of search results.