Skip to main content

openalex

This is an UNOFFICIAL client library designed to make it easy to interact with the OpenAlex API. The OpenAlex API is a free, open-source API that provides access to a wide range of data on academic publications, including metadata, citation data, and full-text content.

Installation

To install this OpenAlex client library, you can use pip or uv. (I am choosing not to use the pypi openalex name to make it clear that this is an unofficial client library, but in the meantime the openalex name is not taken.)

uv add "git+https://github.com/j6k4m8/openalex"

Usage

Here's a simple example of how you can use this library to search for publications on a particular topic:

from openalex import OpenAlex

# Create a new OpenAlex client
client = OpenAlex(mailto="provide-an-email-for-better-service@example.com")

# Search for publications on a particular topic
author_uri = client.get_author_uri_by_search("jordan matelsky")

# Get author institutions:
client.get_author_institutions(author_uri)

Here, all objects are defined as Pydantic types, so you can access, for example, "deep" attributes like this:

paper = client.get_work_by_search("dotmotif")
print(paper.title)
print(paper.authorships[0].author.id)

See also

This work is used by the following projects:

Project Description
http://bib.experiments.kordinglab.com/nsf-coa A simple NSF COA generator and collaborator-finder
https://github.com/j6k4m8/scholarversary milestone-finder for academic careers through the (limited!) lens of publishing
https://github.com/j6k4m8/remarkabib Emerging bibliography and reference manager for the reMarkable tablet.

Metadata

Release files for openalex 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openalex 0.1.0
File Size Uploaded
openalex-0.1.0.tar.gz 4.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openalex 0.1.0
File Interpreter ABI Platform
openalex-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 9.0 kB

Release files / openalex-0.1.0.tar.gz

Download URL openalex-0.1.0.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
5644574eac91c6285535498988eb03c57f7a88c5eaf03897e8f5ee6802215cba
BLAKE2b-256 checksum
How to use checksums
1daf3c488682093d4e791e43615de44bb699982c852a5204956b7e627ff5f2a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Release files / openalex-0.1.0-py3-none-any.whl

Download URL openalex-0.1.0-py3-none-any.whl
Size 4.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c0b7c23c4c4627b01834627112212176d853f6115f5b032564e3252f8bec3428
BLAKE2b-256 checksum
How to use checksums
69551c9bd5f95cca09355cf25661332cf078c6c29f8c6cbd96c0b17a59578bb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page