Filter institutions
You can filter institutions with the filter
parameter:
Get institutions that are located in Canada https://api.openalex.org/institutions?filter=country_code:ca
It's best to read about filters before trying these out. It will show you how to combine filters and build an AND, OR, or negation query
/institutions
attribute filters
/institutions
attribute filtersYou can filter using these attributes of the Institution
entity object (click each one to view their documentation on the Institution
object page):
lineage
: OpenAlex ID for anInstitution
openalex
: the OpenAlex ID of the Institutionrepositories.host_organization
: OpenAlex ID for anInstitution
repositories.host_organization_lineage
: OpenAlex ID for anInstitution
repositories.id
: the OpenAlex ID of a repository (aSource
)ror
: the ROR ID of the Institutionsummary_stats.2yr_mean_citedness
(accepts float, null, !null, can use range queries such as < >)summary_stats.h_index
(accepts integer, null, !null, can use range queries)summary_stats.i10_index
(accepts integer, null, !null, can use range queries)x_concepts.id
(alias:concepts.id
orconcept.id
) -- will be deprecated soon
/institutions
convenience filters
/institutions
convenience filtersThese filters aren't attributes of the Institution
object, but they're included to address some common use cases:
continent
continent
Value: a String with a valid continent filter
Returns: institutions that are located in the chosen continent.
Get institutions that are located in South America https://api.openalex.org/institutions?filter=continent:south_america
default.search
default.search
Value: a search string
This works the same as using the search
parameter for Institutions.
display_name.search
display_name.search
Value: a search string
Returns: institutions with a display_name
containing the given string; see the search page for details.
Get institutions with names containing "technology":
https://api.openalex.org/institutions?filter=display_name.search:technology
In most cases, you should use the search
parameter instead of this filter because it uses a better search algorithm.
has_ror
has_ror
Value: a Boolean (true
or false
)
Returns: institutions that have or lack a ROR ID, depending on the given value.
Get institutions without ROR IDs:
https://api.openalex.org/institutions?filter=has_ror:false
is_global_south
is_global_south
Value: a Boolean (true
or false
)
Returns: institutions that are located in the Global South.
Get institutions that are located in the Global South https://api.openalex.org/institutions?filter=is_global_south:true
Last updated