Institution

Institutions are universities and other organizations to which authors claim affiliations.

Info

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

Institutions models from OpenAlex API Schema definition.

InstitutionOpenAlexID module-attribute

InstitutionOpenAlexID: TypeAlias = HttpUrl

OpenAlex ID for Institution Objects with the format https://openalex.org/I000000000

InstitutionOpenAlexKey module-attribute

InstitutionOpenAlexKey: TypeAlias = str

OpenAlex Institution entity Key with the format I000000000

InstitutionIDs

Bases: BaseModel

IDs from an Institution.

openalex instance-attribute

openalex: InstitutionOpenAlexID

grid class-attribute instance-attribute

grid: str | None = None

ror class-attribute instance-attribute

ror: HttpUrl | None = None

wikipedia class-attribute instance-attribute

wikipedia: HttpUrl | None = None

wikidata class-attribute instance-attribute

wikidata: HttpUrl | None = None

InstitutionType

Bases: str, Enum

The institution's primary type, using the ROR "type" controlled vocabulary.

Education class-attribute instance-attribute

Education = 'education'

Healthcare class-attribute instance-attribute

Healthcare = 'healthcare'

Company class-attribute instance-attribute

Company = 'company'

Archive class-attribute instance-attribute

Archive = 'archive'

Nonprofit class-attribute instance-attribute

Nonprofit = 'nonprofit'

Government class-attribute instance-attribute

Government = 'government'

Facility class-attribute instance-attribute

Facility = 'facility'

Funder class-attribute instance-attribute

Funder = 'funder'

Other class-attribute instance-attribute

Other = 'other'

InstitutionSummaryStats

Bases: BaseModel

Citation metrics for this Institution.

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

InstitutionYearCount

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

InstitutionGeo

Bases: BaseModel

Location of the institution.

city instance-attribute

city: str

geonames_city_id instance-attribute

geonames_city_id: str

region class-attribute instance-attribute

region: str | None = None

country_code instance-attribute

country_code: str

country instance-attribute

country: str

latitude instance-attribute

latitude: float

longitude instance-attribute

longitude: float

InstitutionRoleType

Bases: str, Enum

Possible institution roles.

funder class-attribute instance-attribute

funder = 'funder'

publisher class-attribute instance-attribute

publisher = 'publisher'

institution class-attribute instance-attribute

institution = 'institution'

InstitutionRole

Bases: BaseModel

Institution role.

role instance-attribute

role: InstitutionRoleType

id instance-attribute

id: HttpUrl

works_count instance-attribute

works_count: int

International

Bases: BaseModel

The institution's display name in different languages.

display_name instance-attribute

display_name: dict[str, str]

Institution

Bases: BaseModel

Universities and other organizations to which authors claim affiliations.

id instance-attribute

id: InstitutionOpenAlexID

ids instance-attribute

ids: InstitutionIDs

display_name instance-attribute

display_name: str

country_code instance-attribute

country_code: str

type instance-attribute

type: InstitutionType

homepage_url class-attribute instance-attribute

homepage_url: HttpUrl | None = None

image_url class-attribute instance-attribute

image_url: HttpUrl | None = None

display_name_acronyms instance-attribute

display_name_acronyms: list[str]

international instance-attribute

international: International

works_count instance-attribute

works_count: int

cited_by_count instance-attribute

cited_by_count: int

summary_stats instance-attribute

summary_stats: InstitutionSummaryStats

counts_by_year instance-attribute

counts_by_year: list[InstitutionYearCount]

geo instance-attribute

geo: InstitutionGeo

roles instance-attribute

roles: list[InstitutionRole]

works_api_url instance-attribute

works_api_url: str

DehydratedInstitution

Bases: BaseModel

Stripped-down Institution Model.

id instance-attribute

id: InstitutionOpenAlexID

ror instance-attribute

ror: str

display_name instance-attribute

display_name: str

country_code instance-attribute

country_code: str

type instance-attribute

type: InstitutionType

InstitutionResult

Bases: BaseModel

Institution result Model resulting from a search in OpenAlex.

id instance-attribute

id: InstitutionOpenAlexID

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