Institution object
Last updated
Last updated
These are the fields in an institution object. When you use the API to get a or , this is what's returned.
associated_institutions
List: Institutions
related to this one. Each associated institution is represented as a object, with one extra property:
relationship
(String): The type of relationship between this institution and the listed institution. Possible values: parent
, child
, and related
.
Institution associations and the relationship vocabulary come from .
cited_by_count
country_code
counts_by_year
Years with zero citations and zero works have been removed so you will need to add those in if you need them.
created_date
display_name
String: The primary name of the institution.
display_name_acronyms
display_name_alternatives
List: Other names people may use for this institution.
geo
Object: A bunch of stuff we know about the location of this institution:
city
(String): The city where this institution lives.
region
(String): The sub-national region (state, province) where this institution lives.
country
(String): The country where this institution lives.
latitude
(Float): Does what it says.
longitude
(Float): Does what it says.
homepage_url
String: The URL for institution's primary homepage.
id
ids
Object: All the external identifiers that we know about for this institution. IDs are expressed as URIs whenever possible. Possible ID types:
wikipedia
(String: this institution's Wikipedia page URL)
image_thumbnail_url
is_super_system
image_url
String: URL where you can get an image representing this institution. Usually this is hosted on Wikipedia, and usually it's a seal or logo.
international
Object: The institution's display name in different languages. Derived from the wikipedia page for the institution in the given language.
display_name
(Object)
value
(String): display_name
in the given language
lineage
repositories
roles
In many cases, a single organization does not fit neatly into one role. For example, Yale University is a single organization that is a research university, funds research studies, and publishes an academic journal. The roles
property links the OpenAlex entities together for a single organization, and includes counts for the works associated with each role.
ror
summary_stats
Object: Citation metrics for this institution
While the h-index and the i-10 index are normally author-level metrics and the 2-year mean citedness is normally a journal-level metric, they can be calculated for any set of papers, so we include them for institutions.
type
Possible values are: Education
, Healthcare
, Company
, Archive
, Nonprofit
, Government
, Facility
, and Other
.
updated_date
works_api_url
We express this as an API URL (instead of just listing the Works
themselves) because most institutions have way too many works to reasonably fit into a single return object.
works_count
x_concepts
score
(Float): The strength of association between this institution and the listed concept, from 0-100.
DehydratedInstitution
objectInteger: The total number that cite a work created by an author affiliated with this institution. Or less formally: the number of citations this institution has collected.
String: The country where this institution is located, represented as an .
List: and for each of the last ten years, binned by year. To put it another way: each year, you can see how many new works this institution put out, and how many times any work affiliated with this institution got cited.
String: The date this Institution
object was created in the OpenAlex dataset, expressed as an date string.
List: Acronyms or initialisms that people sometimes use instead of the full .
geonames_city_id
(String): The city where this institution lives, as a ID.
country_code
(String): The country where this institution lives, represented as an .
String: The for this institution.
grid
(String: this institution's )
mag
(Integer: this institution's ID)
openalex
(String: this institution's . Same as )
ror
(String: this institution's ROR ID. Same as )
wikidata
(String: this institution's )
String: Same as , but it's a smaller image.
Boolean: True if this institution is a "super system". This includes large university systems such as the University of California System (), as well as some governments and multinational companies.
We have this special flag for these institutions so that we can exclude them from other institutions' , which we do because these super systems are not generally relevant in group-by results when you're looking at ranked lists of institutions.
The list of institution IDs marked as super systems can be found in .
key
(String): language code in format. Full list of languages is .
List: of institutions. The list will include this institution's ID, as well as any parent institutions. If this institution has no parent institutions, this list will only contain its own ID.
This information comes from , specifically the Parent/Child relationships.
Super systems are excluded from the lineage. See above.
List: Repositories ( with type: repository
) that have this institution as their
List: List of role objects, which include the role
(one of institution
, funder
, or publisher
), the id
(), and the works_count
.
The roles
list of an entity (, , or ) always includes itself. In the case where an organization only has one role, the roles
will be a list of length one, with itself as the only item.
String: The ID for this institution. This is the for institutions.
The ROR (Research Organization Registry) identifier is a globally unique ID for research organization. , which is no longer being updated.
2yr_mean_citedness
Float: The 2-year mean citedness for this source. Also known as . We use the year prior to the current year for the citations (the numerator) and the two years prior to that for the citation-receiving publications (the denominator).
h_index
Integer: The for this institution.
i10_index
Integer: The for this institution.
String: The institution's primary type, using the .
String: The last time anything in this Institution
changed, expressed as an date string. This date is updated for any change at all, including increases in various counts.
String: A URL that will get you a list of all the affiliated with this institution.
Integer: The number of created by authors affiliated with this institution. Or less formally: the number of works coming out of this institution.
x_concepts
will be deprecated and removed soon. We will be replacing this functionality with instead.
List: The most frequently applied to works affiliated with this institution. Each is represented as a object, with one additional attribute:
The DehydratedInstitution
is a stripped-down object, with most of its properties removed to save weight. Its only remaining properties are: