Filter works
It's easy to filter works with the
filter parameter:- Get works where the publication year is 2020 https://api.openalex.org/works?filter=publication_year:2020
In this example the filter is
publication_year and the value is 2020. 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.
You can filter using these attributes of the
Work object (click each one to view their documentation on the Work object page):These filters aren't attributes of the
Work object, but they're handy for solving some common use cases:Value: a search string
Returns: works whose abstract includes the given string. See the search page for details on the search algorithm used.
- Get works with abstracts that mention "artificial intelligence":
https://api.openalex.org/works?filter=abstract.search:artificial%20intelligence
Value: an Integer
Returns: works with the chosen number of
authorships objects (authors). You can use the inequality filter to select a range, such as authors_count:>5.Returns: works where at least one of the author's institutions is in the chosen continent.
- Get works where at least one author's institution in each work is located in Europe https://api.openalex.org/works?filter=authorships.institutions.continent:europe
Value: a Boolean (
true or false)- Get works where at least one author's institution is in the Global South https://api.openalex.org/works?filter=authorships.institutions.is_global_south:true
Returns: works found in the given work's
referenced_works section. You can think of this as outgoing citations. Returns: works that cite the given work. This is works that have the given OpenAlex ID in the
referenced_works section. You can think of this as incoming citations. - Get works that cite https://openalex.org/W2741809807:
https://api.openalex.org/works?filter=cites:W2741809807
The number of results returned by this filter may be slightly higher than the work's
cited_by_countdue to a timing lag in updating that field. Value: an Integer
- Get works with at least three concepts assigned https://api.openalex.org/works?filter=concepts_count:>2
Value: a search string
Returns: works whose
display_name (title) includes the given string; see the search page for details. - Get works with titles that mention the word "wombat":
https://api.openalex.org/works?filter=title.search:wombat
For most cases, you should use the
search parameter instead of this filter, because it uses a better search algorithm and searches over abstracts as well as titles.Value: a date, formatted as
yyyy-mm-ddThis field requires an OpenAlex Premium subscription to access. Please contact us if you are interested.
- Get works created on or after January 12th, 2023 (does not work without valid API key):
https://api.openalex.org/works?filter=from_created_date:2023-01-12&api_key=myapikey
Value: a date, formatted as
yyyy-mm-dd- Get works published on or after March 14th, 2001:
https://api.openalex.org/works?filter=from_publication_date:2001-03-14
Filtering by publication date is not a reliable way to retrieve recently updated and created works, due to the way publishers assign publication dates. Use
from_created_date or from_updated_date to get the latest changes in OpenAlex.Value: a date, formatted as
yyyy-mm-ddThis field requires an OpenAlex Premium subscription to access. Please contact us if you are interested.
- Get works updated on or after January 12th, 2023 (does not work without valid API key):
https://api.openalex.org/works?filter=from_updated_date:2023-01-12&api_key=myapikey
Value: a search string
Returns: works whose fulltext includes the given string. Fulltext search is powered by an index of word sequences called n-grams - see Get N-grams for coverage details.
- Get works with fulltext that mention "climate change":
https://api.openalex.org/works?filter=fulltext.search:climate%20change
We combined some n-grams before storing them in our search database, so querying for an exact phrase using quotes does not always work well.
Value: a Boolean (
true or false)Returns: works that have or lack an abstract, depending on the given value.
Value: a Boolean (
true or false)Returns: works that have or lack a DOI, depending on the given value. It's especially useful for grouping.
Value: a Boolean (
true or false)Returns: works with at least one
host_venue or alternate_host_venue where is_oa= true and version is acceptedVersion or publishedVersion. For Works that undergo peer review, like journal articles, this means there is a peer-reviewed OA copy somewhere. For some items, like books, a published version doesn't imply peer review, so they aren't quite synonymous.- Get works with an OA accepted or published copy
https://api.openalex.org/works?filter=has_oa_accepted_or_published_version:true
Value: a Boolean (
true or false)Returns: works with at least one
host_venue or alternate_host_venue where is_oa= true and version is submittedVersion. This is useful for finding works with preprints deposited somewhere.- Get works with an OA submitted copy:
https://api.openalex.org/works?filter=has_oa_submitted_version:true
Value: a Boolean (
true or false)Returns: if
true it returns works where at least one author or has an ORCID ID. If false, it returns works where no authors have an ORCID ID. This is based on the orcid field within authorships.author.- Get the works where at least one author has an ORCID ID:
https://api.openalex.org/works?filter=has_orcid:true
Value: a Boolean (
true or false)Value: a Boolean (
true or false)Value: a Boolean (
true or false)Returns: works for which n-grams are available or unavailable, depending on the given value. N-grams power fulltext searches through the
fulltext.search filter and the search parameter.Value: a Boolean (
true or false)Value: a search string
Returns: works that have at least one
raw_affiliation_string which includes the given string. See the search page for details on the search algorithm used. - Get works with the words Department of Political Science, University of Amsterdam somewhere in at least one author's
raw_affiliation_string:https://api.openalex.org/works?filter=raw_affiliation_string.search:department%20of%20political%20science%20university%20of%amsterdam
- Get works related to https://openalex.org/W2486144666:
https://api.openalex.org/works?filter=related_to:W2486144666
Returns: works where the chosen venue ID exists within the host_venue or the alternate_host_venues objects.
You can use this to find works where authors are associated with your university, but the work is not part of the university's repository.
👏
- Get works that are available in the University of Michigan Deep Blue repository (OpenAlex ID: https://openalex.org/V4306400393) https://api.openalex.org/works?filter=repository:V4306400393
- Get works where at least one author is associated with the University of Michigan, but the works are not found in the University of Michigan Deep Blue repository https://api.openalex.org/works?filter=institutions.id:I27837315,repository:!V4306400393
Value: a date, formatted as
yyyy-mm-dd- Get works published on or before March 14th, 2001:
https://api.openalex.org/works?filter=to_publication_date:2001-03-14
Value: a String with value
publishedVersion, submittedVersion, acceptedVersion, or nullReturns: works where the chosen version exists within the host_venue or the alternate_host_venues objects. If
null, it returns works where no version is found in either location.- Get works where a published version is available in the host venue or alternate host venues https://api.openalex.org/works?filter=version:publishedVersion
Last modified 1d ago