Old OpenAlex API documentation
  • Overview
  • Quickstart tutorial
  • API Entities
    • Entities overview
    • 📄Works
      • Work object
        • Authorship object
        • Location object
      • Get a single work
      • Get lists of works
      • Filter works
      • Search works
      • Group works
      • Get N-grams
    • 👩Authors
      • Author object
      • Get a single author
      • Get lists of authors
      • Filter authors
      • Search authors
      • Group authors
      • Limitations
      • Author disambiguation
    • 📚Sources
      • Source object
      • Get a single source
      • Get lists of sources
      • Filter sources
      • Search sources
      • Group sources
    • 🏫Institutions
      • Institution object
      • Get a single institution
      • Get lists of institutions
      • Filter institutions
      • Search institutions
      • Group institutions
    • 💡Topics
      • Topic object
      • Get a single topic
      • Get lists of topics
      • Filter topics
      • Search topics
      • Group topics
    • 🗝️Keywords
    • 🏢Publishers
      • Publisher object
      • Get a single publisher
      • Get lists of publishers
      • Filter publishers
      • Search publishers
      • Group publishers
    • 💰Funders
      • Funder object
      • Get a single funder
      • Get lists of funders
      • Filter funders
      • Search funders
      • Group funders
    • 🌎Geo
      • Continents
      • Regions
    • 💡Concepts
      • Concept object
      • Get a single concept
      • Get lists of concepts
      • Filter concepts
      • Search concepts
      • Group concepts
    • Aboutness endpoint (/text)
  • How to use the API
    • API Overview
    • Get single entities
      • Random result
      • Select fields
    • Get lists of entities
      • Paging
      • Filter entity lists
      • Search entities
      • Sort entity lists
      • Select fields
      • Sample entity lists
      • Autocomplete entities
    • Get groups of entities
    • Rate limits and authentication
  • Download all data
    • OpenAlex snapshot
    • Snapshot data format
    • Download to your machine
    • Upload to your database
      • Load to a data warehouse
      • Load to a relational database
        • Postgres schema diagram
  • Additional Help
    • Tutorials
    • Report bugs
    • FAQ
Powered by GitBook
On this page
  • Keyword object
  • cited_by_count
  • created_date
  • display_name
  • id
  • updated_date
  • works_count
  • Get a single keyword
  • Select fields
  • Get a list of keywords
  • Filter keywords
  • /keywords attribute filters
  • /keywords convenience filters
  • Search keywords
  • Group keywords
  • Keywords group_by attributes
  1. API Entities

Keywords

Short words or phrases assigned to works using AI

PreviousGroup topicsNextPublishers

Last updated 1 year ago

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 .

Keyword object

These are the fields in a keyword object. When you use the API to get a or , this is what's returned.

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.

cited_by_count: 4347000 

created_date

String: The date this Keyword object was created in the OpenAlex dataset, expressed as an date string.

created_date: "2024-04-10"

display_name

String: The English-language label of the keyword.

display_name: "Cardiac Imaging"

id

String: The OpenAlex ID for this keyword.

id: "https://openalex.org/keywords/cardiac-imaging"

updated_date

updated_date: "2024-05-09T05:00:03.798420"

works_count

Integer: The number of works tagged with this keyword.

works_count: 21737 

Get a single keyword

It's easy to get a keyword from the API with: /keyword/<entity_id>. Here's an example:

{
    "id": "https://openalex.org/keywords/cardiac-imaging",
    "display_name": "Cardiac Imaging",
    // other fields removed for brevity
}

Select fields

Get a list of keywords

You can get lists of keywords:

Which returns a response like this:

{
    "meta": {
        "count": 4516,
        "db_response_time_ms": 10,
        "page": 1,
        "per_page": 25,
        "groups_count": null
    },
    "results": [
        {
            "id": "https://openalex.org/T11475",
            "display_name": "Territorial Governance and Environmental Participation",
            // more fields (removed to save space)
        },
        {
            "id": "https://openalex.org/T13445",
            "display_name": "American Political Thought and History",
            // more fields (removed to save space)
        },
        // more results (removed to save space)
    ],
    "group_by": []
}

Filter keywords

You can filter keywords with the filter parameter:

/keywords attribute filters

/keywords convenience filters

default.search

Value: a search string

display_name.search

Value: a search string

Search keywords

Group keywords

You can group keywords with the group_by parameter:

Or you can group using one the attributes below.

Keywords group_by attributes

String: The last time anything in this keyword object changed, expressed as an date string. This date is updated for any change at all, including increases in various counts.

Get the keyword with the ID cardiac-imaging:

That will return a object, describing everything OpenAlex knows about the keyword with that ID:

You can make up to 50 of these queries at once by .

You can use select to limit the fields that are returned in a keyword object. More details are .

Display only the id and display_name for a keyword object

Get all keywords in OpenAlex

Get keywords that are in the subfield "Epidemiology" (id: 2713)

It's best to before trying these out. It will show you how to combine filters and build an AND, OR, or negation query

You can filter using these attributes of the object:

These filters aren't attributes of the object, but they're included to address some common use cases:

This works the same as using the for Keywords.

Returns: keywords with a containing the given string.

Get keywords with display_name containing "artificial" and "intelligence":

You can search for keywords using the search query parameter, which searches the fileds. For example:

Search keywords' display_name "artificial intelligence":

You can read more about search . It will show you how relevance score is calculated, how words are stemmed to improve search results, and how to do complex boolean searches.

Get counts of keywords by :

It's best to before trying these out. It will show you how results are formatted, the number of results returned, and how to sort results.

🗝️
ISO 8601
https://api.openalex.org/keywords/cardiac-imaging
here
https://api.openalex.org/keywords/cardiac-imaging?select=id,display_name
https://api.openalex.org/keywords
https://api.openalex.org/keywords?filter=subfield.id:2713
read about filters
https://api.openalex.org/keywords?filter=display_name.search:artificial+intelligence
https://api.openalex.org/keywords?search=artificial intelligence
here
read about group by
the Keywords page at OpenAlex help pages
ISO 8601
single keyword
lists of keywords
Keyword
Keyword
cited_by_count
id
works_count
Keyword
search parameter
display_name
display_name
https://api.openalex.org/keywords?group_by=cited_by_count
cited_by_count
cited_by_count
works_count
requesting a list of entities and filtering on IDs using OR syntax