Skip to content

Author

Authors are people who create works.

Info

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

Authors models from OpenAlex API Schema definition.

AuthorOpenAlexID module-attribute 

AuthorOpenAlexID: TypeAlias = HttpUrl

OpenAlex ID for Author Objects with the format https://openalex.org/A000000000

AuthorOpenAlexKey module-attribute 

AuthorOpenAlexKey: TypeAlias = str

OpenAlex author entity Key with the format A000000000

AuthorIDs

Bases: BaseModel

IDs from an Author.

openalex instance-attribute 

openalex: AuthorOpenAlexID

orcid class-attribute instance-attribute 

orcid: HttpUrl | None = None

scopus class-attribute instance-attribute 

scopus: HttpUrl | None = None

twitter class-attribute instance-attribute 

twitter: HttpUrl | None = None

wikipedia class-attribute instance-attribute 

wikipedia: HttpUrl | None = None

AuthorYearCount

Bases: BaseModel

Summary of published papers and number of citations in a year.

year instance-attribute 

year: int

works_count instance-attribute 

works_count: int

cited_by_count instance-attribute 

cited_by_count: int

AuthorSummaryStats

Bases: BaseModel

Citation metrics for this author.

two_yr_mean_citedness class-attribute instance-attribute 

two_yr_mean_citedness: float = Field(
    ..., alias="2yr_mean_citedness"
)

h_index instance-attribute 

h_index: int

i10_index instance-attribute 

i10_index: int

AuthorAffiliation

Bases: BaseModel

List of affiliations this author has claimed in their publications.

institution instance-attribute 

institution: DehydratedInstitution

years instance-attribute 

years: list[int]

Author

Bases: BaseModel

Author Model Object from OpenAlex API definition.

id instance-attribute 

id: AuthorOpenAlexID

ids instance-attribute 

ids: AuthorIDs

orcid class-attribute instance-attribute 

orcid: str | None = ''

display_name instance-attribute 

display_name: str

display_name_alternatives instance-attribute 

display_name_alternatives: list[str]

last_known_institutions instance-attribute 

last_known_institutions: list[DehydratedInstitution]

affiliations instance-attribute 

affiliations: list[AuthorAffiliation]

works_count instance-attribute 

works_count: int

cited_by_count instance-attribute 

cited_by_count: int

counts_by_year instance-attribute 

counts_by_year: list[AuthorYearCount]

summary_stats instance-attribute 

summary_stats: AuthorSummaryStats

works_api_url instance-attribute 

works_api_url: str

DehydratedAuthor

Bases: BaseModel

Stripped-down Author Model.

id instance-attribute 

id: AuthorOpenAlexID

display_name class-attribute instance-attribute 

display_name: str | None = None

orcid class-attribute instance-attribute 

orcid: HttpUrl | None = None

AuthorResult

Bases: BaseModel

Author result Model resulting from a search in OpenAlex.

id instance-attribute 

id: AuthorOpenAlexID

display_name instance-attribute 

display_name: str

hint class-attribute instance-attribute 

hint: str | None = None

cited_by_count instance-attribute 

cited_by_count: int

works_count instance-attribute 

works_count: int

entity_type instance-attribute 

entity_type: str

external_id class-attribute instance-attribute 

external_id: str | None = None