scopus.ScopusSearch

class scopus.ScopusSearch(query, refresh=False, subscriber=True, view=None, download=True, **kwds)[source]

Class to perform a query against the Scopus Search API.

Parameters:
  • query (str) – A string of the query.
  • refresh (bool (optional, default=False)) – Whether to refresh the cached file if it exists or not.
  • subscriber (bool (optional, default=True)) – Whether the user accesses Scopus with a subscription or not. For subscribers, Scopus’s cursor navigation will be used. Sets the number of entries in each query iteration to the maximum number allowed by the corresponding view.
  • view (str (optional, default=None)) – Which view to use for the query, see https://dev.elsevier.com/guides/ScopusSearchViews.htm. Allowed values: STANDARD, COMPLETE. If None, defaults to COMPLETE if subscriber=True and to STANDARD if subscriber=False.
  • cursor (bool (optional, default=True)) – Whether to use Scopus’s cursor navigation to obtain results. Using the cursor allows to download an unlimited results set. Non-subscribers should set this to False.
  • download (bool (optional, default=True)) – Whether to download results (if they have not been cached).
  • kwds (key-value parings, optional) – Keywords passed on as query parameters. Must contain fields and values listed mentioned in the API specification (https://dev.elsevier.com/documentation/SCOPUSSearchAPI.wadl), such as “field” or “date”.
Raises:
  • ScopusQueryError – For non-subscribers, if the number of search results exceeds 5000.
  • ValueError – If the view parameter is not one of the allowed ones.

Notes

Json results are cached in ~/.scopus/scopus_search/{fname}, where fname is the md5-hashed version of query.

get_eids()[source]

EIDs of retrieved documents.

get_results_size()

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

EIDS

Outdated property, will be removed in a future release. Please use get_eids() instead. For details see https://scopus.readthedocs.io/en/latest/tips.html#migration-guide-to-0-x-to-1-x.

results

A list of namedtuples in the form (eid doi pii pubmed_id title subtype creator afid affilname affiliation_city affiliation_country author_count author_names author_ids author_afids coverDate coverDisplayDate publicationName issn source_id eIssn aggregationType volume issueIdentifier article_number pageRange description authkeywords citedby_count openaccess fund_acr fund_no fund_sponsor). Field definitions correspond to https://dev.elsevier.com/guides/ScopusSearchViews.htm, except for afid, affilname, affiliation_city, affiliation_country, author_count, author_names, author_ids and author_afids: These information are joined on “;”. In case an author has multiple affiliations, they are joined on “-” (e.g. Author1Aff;Author2Aff1-Author2Aff2).

Notes

The list of authors and the list of affiliations per author are deduplicated.