Examples
A collection of ready-to-use API calls for research products. All URLs point to the production environment:
https://api.openaire.eu/graph/v3/research-products
Common / top-level parameters
| Parameter | Example |
|---|---|
| search | ?search=openaire |
| sortBy | ?type=publication&sortBy=citationCount DESC |
| sortBy (multi) | ?type=publication&sortBy=influence DESC, publicationDate DESC |
| logicalOperator | ?type=publication&countryCode=GR&logicalOperator=OR |
| includeStats | ?search=covid&includeStats=true |
| page + pageSize | ?type=publication&page=3&pageSize=25 |
| cursor | ?type=publication&pageSize=100&cursor=* |
Identity
Title & description
| Parameter | Example |
|---|---|
| mainTitle | ?mainTitle=neural network |
| description | ?description=machine learning |
Classification
| Parameter | Example |
|---|---|
| type | ?type=publication |
| type (OR / NOT) | ?type=("publication" OR "dataset") AND NOT "other" |
| instanceType | ?instanceType=Article |
| subjects | ?subjects=climate |
| sdgLabel | ?sdgLabel="13. Climate action" |
| fos | ?fos="natural sciences" |
| eoscIfGuidelines | ?eoscIfGuidelines=EOSC::Twitter Data |
Dates & years
| Parameter | Example |
|---|---|
| fromPublicationDate | ?fromPublicationDate=2024-01-01 |
| fromPublicationDate + toPublicationDate | ?fromPublicationDate=2024-01-01&toPublicationDate=2024-12-31 |
| excludePubDateRange | ?fromPublicationDate=2024-01-01&toPublicationDate=2024-12-31&excludePubDateRange=true |
| fromPublicationYear | ?fromPublicationYear=2020 |
| year range (from + to) | ?fromPublicationYear=2021&toPublicationYear=2025 |
| publicationYear (OR) | ?publicationYear=("2020" OR "2021" OR "2022") |
Authors & affiliation
| Parameter | Example |
|---|---|
| authorFullName | ?authorFullName="Paolo Manghi" |
| authorId | ?authorId=0000-0002-1825-0097 |
| rorId | ?rorId=https://ror.org/052gg0110 |
| countryCode | ?countryCode=GR |
| countryCode (OR / NOT) | ?countryCode=("GR" OR "IT") AND NOT "DE" |
Access & indicators
| Parameter | Example |
|---|---|
| accessRightLabel | ?accessRightLabel="Open Access" |
| accessRightLabel (OR) | ?accessRightLabel=("Open Access" OR "Embargo") |
| openAccessColor | ?openAccessColor=gold |
| openAccessColor (OR / NOT) | ?openAccessColor=("gold" OR "hybrid") AND NOT "bronze" |
| isGreen | ?isGreen=true |
| isPeerReviewed | ?isPeerReviewed=true |
| isInDiamondJournal | ?isInDiamondJournal=true |
| isPubliclyFunded | ?isPubliclyFunded=true |
| hasLicense | ?hasLicense=true |
Impact classes
| Parameter | Example |
|---|---|
| influenceClass | ?influenceClass=C1 |
| influenceClass (OR / NOT) | ?influenceClass=("C1" OR "C2") AND NOT "C5" |
| popularityClass | ?popularityClass=C1 |
| impulseClass | ?impulseClass=("C1" OR "C2" OR "C3") |
| citationCountClass | ?citationCountClass=C1 |
Language & publisher
| Parameter | Example |
|---|---|
| language | ?language=English |
| language (OR / NOT) | ?language=("German" OR "French") AND NOT "English" |
| publisher | ?publisher=Springer |
| publisher (OR) | ?publisher=("Springer" OR "Elsevier") |
Related — organizations & communities
| Parameter | Example |
|---|---|
| relOrganizationId | ?relOrganizationId=pending_org_::524b09c852b52a2b65302db81c4a98b1 |
| relOrganization | ?relOrganization="University of Athens" |
| relCommunityId | ?relCommunityId=egi |
| relCommunityName | ?relCommunityName="EGI Federation" |
| subCommunity | ?subCommunity=oa-pub |
Related — projects & funding
| Parameter | Example |
|---|---|
| relProjectId | ?relProjectId=corda__h2020::abcdef123456 |
| relProjectCode | ?relProjectCode=101000360 |
| relProject | ?relProject="OpenAIRE" |
| hasProjectRel | ?hasProjectRel=true |
| relProjectFundingShortName | ?relProjectFundingShortName=EC |
| relProjectFundingShortName (OR) | ?relProjectFundingShortName=("EC" OR "NIH" OR "NSF") |
| relProjectFundingStreamId | ?relProjectFundingStreamId=H2020 |
| relFunder | ?relFunder="ec__::EC||European Commission||EC" |
| relFundingLevel0Id | ?relFundingLevel0Id=ec__________::EC::FP7 |
| relFundingLevel1Id | ?relFundingLevel1Id=ec__________::EC::FP7::SP1 |
| relFundingLevel2Id | ?relFundingLevel2Id=ec__________::EC::FP7::SP1::HEALTH |
Related — data sources
| Parameter | Example |
|---|---|
| relHostingDataSourceId | ?relHostingDataSourceId=opendoar____::1234 |
| relHostingDataSource | ?relHostingDataSource="ZENODO" |
| relCollectedFromDatasourceId | ?relCollectedFromDatasourceId=opendoar____::5678 |
| source | ?source=opendoar____::e93028bdc1aacdfb3687181f2031765d |
Combined examples
| Parameter | Example |
|---|---|
| OA publications from 2023+ | ?type=publication&accessRightLabel="Open Access"&fromPublicationYear=2023 |
| EC-funded datasets with license | ?type=dataset&relProjectFundingShortName=EC&hasLicense=true |
| Greek peer-reviewed gold OA | ?type=publication&countryCode=GR&isPeerReviewed=true&openAccessColor=gold |
| High-influence software | ?type=software&influenceClass=C1&sortBy=influence DESC |
| Diamond journal + SDG + publicly funded | ?isInDiamondJournal=true&sdgLabel="13. Climate action"&isPubliclyFunded=true |
| All together | ?search=machine learning&type=publication&fromPublicationYear=2020&isPeerReviewed=true&accessRightLabel="Open Access"&countryCode=("GR" OR "IT")&influenceClass=("C1" OR "C2")&sortBy=citationCount DESC&pageSize=20 |