get_author

s2.api.get_author(authorId, api_key=None, session=None, return_json=False, retries=2, wait=150, **kwargs)

Look up information about an author in Semantic Scholar. Returns a S2Author object describing the author.

Parameters

  • authorId (str) – Semantic Scholar author identifier.

  • api_key (str, optional) – A Data Partners API key. Temporarily overwrites API key passed through session. Defaults to None

  • session (requests.Session, optional) – A requests.Session object, can be used to store an API key (see Using an API Key). Note that api_key will overwrite this value temporarily if it is provided. Defaults to None

  • return_json (bool, optional) – Return original json from get request (e.g. in case of PyS2-breaking changes to the S2 API). Defaults to False

  • retries (int, optional) – Number of retry attempts after rate limit is exceeded. Defaults to 2

  • wait (int, optional) –

    Number of seconds to wait between retries if rate limit is exceeded (100 per 5 minute window for public API). Defaults to 150. This can be safely lowered with access to the Data Partners API (see Using an API Key)

  • **kwargs (Dict[str, any], optional) –

    Keyword Args for requests.Session.get().

    Defaults to {}

Returns

A S2Author or dict object describing the author

Return type

dict or S2Author