🗝️Keywords
Short words or phrases assigned to works using AI
Works in OpenAlex are tagged with Keywords using an automated system based on Topics.
To learn more about how OpenAlex Keywords work in general, see the Keywords page at OpenAlex help pages.
Keyword object
These are the fields in a keyword object. When you use the API to get a single keyword or lists of keywords, this is what's returned.
cited_by_count
cited_by_count
Integer: The number of citations to works that have been tagged with this keyword. Or less formally: the number of citations to this keyword.
For example, if there are just two works tagged with this keyword and one of them has been cited 10 times, and the other has been cited 1 time, cited_by_count
for this keyword would be 11
.
created_date
created_date
String: The date this Keyword
object was created in the OpenAlex dataset, expressed as an ISO 8601 date string.
display_name
display_name
String: The English-language label of the keyword.
id
id
String: The OpenAlex ID for this keyword.
updated_date
updated_date
String: The last time anything in this keyword object changed, expressed as an ISO 8601 date string. This date is updated for any change at all, including increases in various counts.
works_count
works_count
Integer: The number of works tagged with this keyword.
Get a single keyword
It's easy to get a keyword from the API with: /keyword/<entity_id>
. Here's an example:
Get the keyword with the ID
cardiac-imaging
:https://api.openalex.org/keywords/cardiac-imaging
That will return a Keyword
object, describing everything OpenAlex knows about the keyword with that ID:
You can make up to 50 of these queries at once by requesting a list of entities and filtering on IDs using OR syntax.
Select fields
You can use select
to limit the fields that are returned in a keyword object. More details are here.
Display only the
id
anddisplay_name
for a keyword objecthttps://api.openalex.org/keywords/cardiac-imaging?select=id,display_name
Get a list of keywords
You can get lists of keywords:
Get all keywords in OpenAlex
https://api.openalex.org/keywords
Which returns a response like this:
Filter keywords
You can filter keywords with the filter
parameter:
Get keywords that are in the subfield "Epidemiology" (id: 2713)
https://api.openalex.org/keywords?filter=subfield.id:2713
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
/keywords
attribute filters
/keywords
attribute filtersYou can filter using these attributes of the Keyword
object:
/keywords
convenience filters
/keywords
convenience filtersThese filters aren't attributes of the Keyword
object, but they're included to address some common use cases:
default.search
default.search
Value: a search string
This works the same as using the search
parameter for Keywords.
display_name.search
display_name.search
Value: a search string
Returns: keywords with a display_name
containing the given string.
Get keywords with
display_name
containing "artificial" and "intelligence":https://api.openalex.org/keywords?filter=display_name.search:artificial+intelligence
Search keywords
You can search for keywords using the search
query parameter, which searches the display_name
fileds. For example:
Search keywords'
display_name
"artificial intelligence": https://api.openalex.org/keywords?search=artificial intelligence
You can read more about search here. It will show you how relevance score is calculated, how words are stemmed to improve search results, and how to do complex boolean searches.
Group keywords
You can group keywords with the group_by
parameter:
Get counts of keywords by
cited_by_count
:https://api.openalex.org/keywords?group_by=cited_by_count
Or you can group using one the attributes below.
It's best to read about group by before trying these out. It will show you how results are formatted, the number of results returned, and how to sort results.
Keywords group_by attributes
Last updated