Skip to content

Work

Works are scholarly documents like journal articles, books, datasets, and theses.

Info

For further details about Works objects, consult the OpenAlex documentation.

Works models from OpenAlex API Schema definition.

WorkIDs

Bases: BaseModel

IDs from a Work.

openalex instance-attribute 

openalex: HttpUrl

doi class-attribute instance-attribute 

doi: HttpUrl | None = None

pmid class-attribute instance-attribute 

pmid: str | None = None

pmcid class-attribute instance-attribute 

pmcid: str | None = None

WorkDrivenVersion

Bases: str, Enum

The version of the work, based on the Driver Guidelines versioning scheme.

submitted class-attribute instance-attribute 

submitted = 'submittedVersion'

accepted class-attribute instance-attribute 

accepted = 'acceptedVersion'

published class-attribute instance-attribute 

published = 'publishedVersion'

Location

Bases: BaseModel

Describes the location of a given work.

is_oa instance-attribute 

is_oa: bool

landing_page_url instance-attribute 

landing_page_url: str

license instance-attribute 

license: str | None

pdf_url instance-attribute 

pdf_url: str | None

version instance-attribute 

version: WorkDrivenVersion | None

source class-attribute instance-attribute 

source: DehydratedSource | None = None

OpenAccessStatus

Bases: str, Enum

The Open Access (OA) status of this work.

diamond class-attribute instance-attribute 

diamond = 'diamond'

gold class-attribute instance-attribute 

gold = 'gold'

green class-attribute instance-attribute 

green = 'green'

hybrid class-attribute instance-attribute 

hybrid = 'hybrid'

bronze class-attribute instance-attribute 

bronze = 'bronze'

closed class-attribute instance-attribute 

closed = 'closed'

WorkAccessInfo

Bases: BaseModel

Information about the access status of this work.

is_oa instance-attribute 

is_oa: bool

oa_status instance-attribute 

oa_status: OpenAccessStatus

oa_url class-attribute instance-attribute 

oa_url: HttpUrl | None = None

any_repository_has_fulltext instance-attribute 

any_repository_has_fulltext: bool

Authorship

Bases: BaseModel

Information of author and her institutional affiliations in the context of work.

author_position instance-attribute 

author_position: str

author instance-attribute 

author: DehydratedAuthor

ArticleProcessingCharge

Bases: BaseModel

Information about the paid APC for this work.

value instance-attribute 

value: int

currency instance-attribute 

currency: str

provenance class-attribute instance-attribute 

provenance: str | None = None

value_usd instance-attribute 

value_usd: int | None

Grant

Bases: BaseModel

Grant Model Object from OpenAlex API definition.

funder instance-attribute 

funder: HttpUrl

funder_display_name instance-attribute 

funder_display_name: str

award_id class-attribute instance-attribute 

award_id: str | None = None

Keyword

Bases: BaseModel

Keyword extracted from the work's title and confidence score.

id instance-attribute 

id: HttpUrl

display_name instance-attribute 

display_name: str

score instance-attribute 

score: float

Work

Bases: BaseModel

Work Model Object from OpenAlex API definition.

id instance-attribute 

id: HttpUrl

ids instance-attribute 

ids: WorkIDs

title instance-attribute 

title: str

abstract class-attribute instance-attribute 

abstract: str | None = None

publication_year instance-attribute 

publication_year: int

publication_date instance-attribute 

publication_date: str

language class-attribute instance-attribute 

language: str | None = None

type instance-attribute 

type: str

primary_location class-attribute instance-attribute 

primary_location: Location | None = None

best_oa_location class-attribute instance-attribute 

best_oa_location: Location | None = None

locations instance-attribute 

locations: list[Location]

open_access instance-attribute 

open_access: WorkAccessInfo

authorships instance-attribute 

authorships: list[Authorship]

cited_by_count instance-attribute 

cited_by_count: int

This number comes from the OpenAlex API, represents ALL citations to this work, and may not always be correct. To use a verified number that respects the applied filters use WorkReport.

grants instance-attribute 

grants: list[Grant]

keywords instance-attribute 

keywords: list[Keyword]

concepts instance-attribute 

concepts: list[DehydratedConcept]

topics instance-attribute 

topics: list[DehydratedTopic]

referenced_works instance-attribute 

referenced_works: list[HttpUrl]

cited_by_api_url instance-attribute 

cited_by_api_url: HttpUrl

apc_list class-attribute instance-attribute 

apc_list: ArticleProcessingCharge | None = None

The price as listed by the journal's publisher.

apc_paid class-attribute instance-attribute 

apc_paid: ArticleProcessingCharge | None = None

APC actually paid by authors.

valid_locations 

def valid_locations(
    locations: list[dict[str, Any]],
) -> list[dict[str, Any]]

Skip locations that do not contain enough data.

valid_location 

def valid_location(
    location: dict[str, Any],
) -> dict[str, Any] | None

Skip location that do not contain enough data.

valid_authorships 

def valid_authorships(
    authorships: list[dict[str, Any]],
) -> list[dict[str, Any]]

Skip authorship's that do not contain enough data.