Filtering research products
Filters narrow down the search results based on specific criteria. Each filter is provided as its own query parameter in the request URL:
param1=value1¶m2=value2&...¶mN=valueN
By default, different filters are combined using the logical AND operator. To combine multiple values for a single filter, use the AND / OR / NOT operators inside the filter's value. See Using logical operators for full details.
Available parameters
Identity and content
| Parameter | Description |
|---|---|
search | Search in the content of the research product. |
mainTitle | Search in the research product's main title. |
description | Search in the research product's description. |
id | The OpenAIRE id of the research product. |
pid | The persistent identifier of the research product. |
originalId | The identifier of the record at the original sources. |
Classification
| Parameter | Description |
|---|---|
type | The type of the research product. One of publication, dataset, software, other. |
subjects | List of subjects associated with the research product. |
countryCode | The country code for the country associated with the research product. |
language | The language of the research product (e.g. English, German). |
instanceType [publications] | The instance type. See all values here. |
sdgLabel [publications] | Sustainable Development Goals. List of values. |
fos [publications] | Field of Science classification. List of values. |
eoscIfGuidelines | The EOSC Interoperability Framework guidelines. |
Dates
| Parameter | Description |
|---|---|
fromPublicationDate | Publication date greater than or equal to the given date (YYYY or YYYY-MM-DD). |
toPublicationDate | Publication date less than or equal to the given date (YYYY or YYYY-MM-DD). |
fromPublicationYear | Publication year greater than or equal to the given year (YYYY). |
toPublicationYear | Publication year less than or equal to the given year (YYYY). |
publicationYear | The publication year(s). Mutually exclusive with fromPublicationYear / toPublicationYear. |
excludePubDateRange | When true, negates the publication date range filter. Requires fromPublicationDate or toPublicationDate. (Boolean) |
Authors, affiliation, and publisher
| Parameter | Description |
|---|---|
authorFullName | The full name of an author involved in producing the research product. |
authorId | The author identifier. |
rorId | Research products affiliated with the organization that has the given ROR identifier. |
publisher | The name of the entity that publishes, distributes, releases, issues, or produces the resource. |
Access, peer review, and impact
| Parameter | Description |
|---|---|
accessRightLabel | The best open access rights among the product's instances. One of Open Access, Closed Access, Restricted, Open Source, Embargo, Unknown. |
openAccessColor [publications] | The Open Access color. One of bronze, gold, hybrid. |
isGreen [publications] | Whether the publication follows the green open access model. (Boolean) |
isPeerReviewed [publications] | Whether the publication is peer reviewed. (Boolean) |
isInDiamondJournal [publications] | Whether the publication was published in a diamond journal. (Boolean) |
isPubliclyFunded [publications] | Whether the publication was publicly funded. (Boolean) |
hasLicense | Whether the research product has a license. (Boolean) |
influenceClass | Influence impact class. One of C1, C2, C3, C4, C5 (top 0.01%, 0.1%, 1%, 10%, and average respectively). |
popularityClass | Popularity impact class (C1–C5). |
impulseClass | Impulse impact class (C1–C5). |
citationCountClass | Citation count impact class (C1–C5). |
Related projects and funding
| Parameter | Description |
|---|---|
relProjectId | Research products connected to the project (with OpenAIRE id). |
relProjectCode | Research products connected to the project with the given code. |
relProject | Research products connected to the project (by name/acronym). |
hasProjectRel | Research products that are connected to a project. (Boolean) |
relProjectFundingShortName | Research products connected to a project whose funder has the given short name. |
relProjectFundingStreamId | Research products connected to a project with the given funding stream id. |
relFunder | Research products connected to the given funder. |
relFundingLevel0Id | Research products connected to funding level 0 identifier. |
relFundingLevel1Id | Research products connected to funding level 1 identifier. |
relFundingLevel2Id | Research products connected to funding level 2 identifier. |
Related organizations, communities, and data sources
| Parameter | Description |
|---|---|
relOrganizationId | Research products connected to the organization (with OpenAIRE id). |
relOrganization | Research products connected to the organization name. |
relCommunityId | Research products connected to the community (with OpenAIRE id). |
relCommunityName | Research products connected to the community name. |
subCommunity | The sub-community or concept name. |
relHostingDataSourceId | Research products hosted by the data source (with OpenAIRE id). |
relHostingDataSource | Research products hosted by the data source name. |
relCollectedFromDatasourceId | Research products collected from the data source (with OpenAIRE id). |
source | Research products by data source (collected from or hosted by). |
Using logical operators
The API supports the logical operators AND, OR, and NOT to refine your queries. These operators help you combine or exclude one or more values for a specific filter.
AND operator
Use AND to retrieve results that include all specified values. This narrows your search.
Get research products that contain both
"climate"and"change":
When using the logical operators AND, OR, or NOT, each value must be wrapped in double quotes — for example fos="03 medical and health sciences" AND "0502 economics and business". Bare (unquoted) values are only allowed when no operator is present.
OR operator
Use OR to retrieve results that include any of the specified values. This broadens your search.
Get research products of type
publicationordataset:
NOT operator
Use NOT to exclude specific values from your results.
Get research products that contain
"semantic"but not"web":
All operators can be combined, along with parentheses and quotes, to build complex queries. For example, to get research products with the phrase "semantic web" but not "ontology" or "linked data":
/v3/research-products?search="semantic web" AND NOT ("ontology" OR "linked data")
See also the full list of examples.