Skip to main content

A python library that aims to retrieve data from Semantic Scholar API

Project description

semanticscholar

Latest version GitHub license

A python library that aims to retrieve data from Semantic Scholar API.

How to install

pip install semanticscholar

Usage

Programmatically access paper and author data. Can be used to access both the public API or the S2 Data Partner's API using a private key.

Paper Lookup (Public API)

To access paper data:

>>> from semanticscholar import SemanticScholar
>>> sch = SemanticScholar(timeout=2)
>>> paper = sch.paper('10.1093/mind/lix.236.433')
>>> paper.keys()
dict_keys(['abstract', 'arxivId', 'authors', 'citationVelocity', 'citations', 'doi',
'influentialCitationCount', 'paperId', 'references', 'title', 'topics', 'url', 'venue', 'year'])
>>> paper['title']
'Computing Machinery and Intelligence'
>>> for author in paper['authors']:
...     print(author['name'])
...     print(author['authorId'])
...
'Alan M. Turing'
2262347

Author Lookup (Public API)

To access author data:

>>> from semanticscholar import SemanticScholar
>>> sch = SemanticScholar(timeout=2)
>>> author = sch.author(2262347)
>>> author.keys()
dict_keys(['aliases', 'authorId', 'citationVelocity', 'influentialCitationCount', 'name', 'papers', 'url'])
>>> author['name']
'Alan M. Turing'
>>> len(author['papers'])
77

Accessing the Data Partner's API

If you are a Semantic Scholar Data Partner you can provide the private key as an optional argument:

>>> from semanticscholar import SemanticScholar
>>> s2_api_key = '40-CharacterPrivateKeyProvidedToPartners'
>>> sch = SemanticScholar(api_key=s2_api_key)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

semanticscholar-0.2.1.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

semanticscholar-0.2.1-py3-none-any.whl (5.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page