Skip to main content
Version: 7.2.0

Filtering search results

Filters can be used to narrow down the search results based on specific criteria. Filters are provided as query parameters in the request URL (see here for the available search entpoints).

Multiple filters can be provided in a single request; they should be formatted as follows: param1=value1&param2=value2&...&paramN=valueN.

note

Filters are combined using the logical AND operator. If a filter is provided multiple times, its values are combined using the logical OR operator. For more information on how to use logical operators when searching and filtering, see Using logical operators.

Examples:

Available parameters

This section provides an overview of the available parameters for each entity type.

Research products

The following query parameters are available for research products:

ParameterDescription
searchSearch in the content of the research product.
mainTitleSearch in the research product's main title.
descriptionSearch in the research product's description.
idThe OpenAIRE id of the research product.
pidThe persistent identifier of the research product.
originalIdThe identifier of the record at the original sources.
typeThe type of the research product. One of publication, dataset, software, or other
fromPublicationDateGets the research products whose publication date is greater than or equal to the given date. A date formatted as YYYY-MM-DD
toPublicationDateGets the research products whose publication date is less than or equal to the given date. A date formatted as YYYY-MM-DD
subjectsList of subjects associated to the research product.
countryCodeThe country code for the country associated with the research product.
authorFullNameThe full name of the authors involved in producing this research product.
authorOrcidThe ORCiD of the authors involved in producing this research product.
publisherThe name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
bestOpenAccessRightLabelThe best open access rights among the research product's instances. One of OPEN SOURCE, OPEN, EMBARGO, RESTRICTED, CLOSED, UNKNOWN
influenceClassCitation-based indicator that reflects the overall impact of a research product. Please, choose a class among C1, C2, C3, C4, or C5 for top 0.01%, top 0.1%, top 1%, top 10%, and average in terms of influence respectively.
impulseClassCitation-based indicator that reflects the initial momentum of a research product directly after its publication. Please, choose a class among C1, C2, C3, C4, or C5 for top 0.01%, top 0.1%, top 1%, top 10%, and average in terms of impulse respectively
popularityClassCitation-based indicator that reflects current impact or attention of a research product. Please, choose a class among C1, C2, C3, C4, or C5 for top 0.01%, top 0.1%, top 1%, top 10%, and average in terms of popularity respectively.
citationCountClassCitation-based indicator that reflects the overall impact of a research product by summing all its citations. Please, choose a class among C1, C2, C3, C4, or C5 for top 0.01%, top 0.1%, top 1%, top 10%, and average in terms of citation count respectively.
instanceType [Only for publications]Retrieve publications of the given instance type. Check here for all possible instance type values.
sdg [Only for publications]Retrieves publications classified with the respective Sustainable Development Goal number. Integer in the range [1, 17]
fos [Only for publications]Retrieves publications classified with a given Field of Science (FOS). A FOS classification identifier (see here for details).
isPeerReviewed [Only for publications]Indicates whether the publications are peerReviewed or not. (Boolean)
isInDiamondJournal [Only for publications]Indicates whether the publication was published in a diamond journal or not. (Boolean)
isPubliclyFunded [Only for publications]Indicates whether the publication was publicly funded or not. (Boolean)
isGreen [Only for publications]Indicates whether the publication was published following the green open access model. (Boolean)
openAccessColor [Only for publications]Specifies the Open Access color of the publication. One of bronze, gold, or hybrid
relOrganizationIdRetrieve research products connected to the organization (with OpenAIRE id).
relCommunityIdRetrieve research products connected to the community (with OpenAIRE id).
relProjectIdRetrieve research products connected to the project (with OpenAIRE id).
relProjectCodeRetrieve research products connected to the project with code.
hasProjectRelRetrieve research products that are connected to a project. (Boolean)
relProjectFundingShortNameRetrieve research products connected to a project that has a funder with the given short name.
relProjectFundingStreamIdRetrieve research products connected to a project that has the given funding identifier.
relHostingDataSourceIdRetrieve research products hosted by the data source (with OpenAIRE id).
relCollectedFromDatasourceIdRetrieve research products collected from the data source (with OpenAIRE id).
debugQueryRetrieve debug information for the search query. (Boolean)
pagePage number of the results. (Integer)
pageSizeNumber of results per page. Integer in the range [1, 100]
sortByThe field to set the sorting order of the results. Should be provided in the format fieldname sortDirection, where the sortDirection can be either ASC for ascending order or DESC for descending order and fielaname is one of relevance, publicationDate, dateOfCollection, influence, popularity, citationCount, impulse. Multiple sorting parameters should be comma-separated.

Organizations

The following query parameters are available for organizations:

ParameterDescription
searchSearch in the content of the organization.
legalNameThe legal name of the organization.
legalShortNameThe legal name of the organization in short form.
idThe OpenAIRE id of the organization.
pidThe persistent identifier of the organization.
countryCodeThe country code of the organization.
relCommunityIdRetrieve organizations connected to the community (with OpenAIRE id).
relCollectedFromDatasourceIdRetrieve organizations collected from the data source (with OpenAIRE id).
debugQueryRetrieve debug information for the search query.
pagePage number of the results.
pageSizeNumber of results per page.
sortByThe field to set the sorting order of the results. Should be provided in the format fieldname sortDirection, where the sortDirection can be either ASC for ascending order or DESC for descending order - organizations can only be sorted by relevance.

Data sources

The following query parameters are available for data sources:

ParameterDescription
searchSearch in the content of the data source.
officialNameThe official name of the data source.
englishNameThe English name of the data source.
legalShortNameThe legal name of the organization in short form.
idThe OpenAIRE id of the data source.
pidThe persistent identifier of the data source.
subjectsList of subjects associated to the datasource.
dataSourceTypeNameThe data source type; see all possible values here .
contentTypesTypes of content in the data source, as defined by OpenDOAR.
relOrganizationIdRetrieve data sources connected to the organization (with OpenAIRE id).
relCommunityIdRetrieve data sources connected to the community (with OpenAIRE id).
relCollectedFromDatasourceIdRetrieve data sources collected from the data source (with OpenAIRE id).
debugQueryRetrieve debug information for the search query.
pagePage number of the results.
pageSizeNumber of results per page.
sortByThe field to set the sorting order of the results. Should be provided in the format fieldname sortDirection, where the sortDirection can be either ASC for ascending order or DESC for descending order - data sources can only be sorted by relevance.

Projects

The following query parameters are available for projects:

ParameterDescription
searchSearch in the content of the projects.
titleSearch in the project's title.
keywordsThe project's keywords.
idThe OpenAIRE id of the project.
codeThe grant agreement (GA) code of the project.
acronymProject's acronym.
callIdentifierThe identifier of the research call.
fundingShortNameThe short name of the funder.
fundingStreamIdThe identifier of the funding stream.
fromStartDateGets the projects with start date greater than or equal to the given date. Please provide a date formatted as YYYY-MM-DD.
toStartDateGets the projects with start date less than or equal to the given date. Please provide a date formatted as YYYY-MM-DD.
fromEndDateGets the projects with end date greater than or equal to the given date. Please provide a date formatted as YYYY-MM-DD.
toEndDateGets the projects with end date less than or equal to the given date. Please provide a date formatted as YYYY-MM-DD.
relOrganizationNameThe name or short name of the related organization.
relOrganizationIdThe organization identifier of the related organization.
relCommunityIdRetrieve projects connected to the community (with OpenAIRE id).
relOrganizationCountryCodeThe country code of the related organizations.
relCollectedFromDatasourceIdRetrieve projects collected from the data source (with OpenAIRE id).
debugQueryRetrieve debug information for the search query.
pagePage number of the results.
pageSizeNumber of results per page.
sortByThe field to set the sorting order of the results. Should be provided in the format fieldname sortDirection, where the sortDirection can be either ASC for ascending order or DESC for descending order and fielaname is one of relevance, startDate, endDate. Multiple sorting parameters should be comma-separated.

Using logical operators

The API supports the use of logical operators AND, OR, and NOT to refine your search queries. These operators help you combine or exclude one or more values for a specific filter.

AND operator

Use the AND operator to retrieve results that include all specified values. This narrows your search.

Examples:

note

Note that when multiple tokens denote a single filter value, you should enclose them in double quotes, as in the FOS example above.

OR operator

Use the OR operator to retrieve results that include any of the specified terms. This broadens your search. The same functionality can be achieved by providing multiple times the same query parameter or using a comma to separate the values.

Examples:

NOT operator

Use the NOT operator to exclude specific terms from your search results. This refines your search by filtering out unwanted results.

Examples:

note

All the above operators can be combined, along with parentheses, and quotes to create more complex queries. For example, to get research products that contain the phrase "semantic web" but not "ontology" or "linked data":

https://api-beta.openaire.eu/graph/researchProducts?search="semantic web" AND NOT (ontology OR "linked data")