- Home
- API & Resources
- Selective Access
Selective Access
The OpenAIRE HTTP API allows developers to access metadata records of the OpenAIRE Research Graph by performing queries over publications, datasets, and projects.
The API is intended for metadata discovery and exploration only, that is it does not give direct access to publication files and it does not provide access to
the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole graph, developers are
encouraged to use the OpenAIRE Research Graph dumps.
Terms of Use and SLA
For more details on this, please check here
Common Parameters
Parameters included in this section can always be specified, for both research products and projects.
For research products: https://api.openaire.eu/search/researchProducts. By specific type:
- publications: https://api.openaire.eu/search/publications
- research data: https://api.openaire.eu/search/datasets
- research software: https://api.openaire.eu/search/software
- other research products: http://api.openaire.eu/search/other
Parameter | Option | Description |
---|---|---|
page | integer | Page number of the search results. |
size | integer | Number of results per page. |
format | json | xml | csv | tsv | The format of the response. The default is xml. |
model | openaire | sygma | The data model of the response. Default is openaire. Model sygma is a simplified version of the openaire model. For sygma, only the xml format is available. The relative XML schema is available here. |
sortBy | sortBy=field,[ascending|descending] |
The sorting order of the specified field. For the list of sortable fields, please refer to the documentation relative to the specific type of entity you are querying for. |
hasECFunding | true | false | If hasECFunding is true gets the entities funded by the EC. If hasECFunding is false gets the entities related to projects not funded by the EC. |
hasWTFunding | true | false | If hasWTFunding is true gets the entities funded by Wellcome Trust. The results are the same as those obtained with funder=wt . If hasWTFunding is false gets the entities related to projects not funded by Wellcome Trust. |
funder | WT | EC | ARC | ANDS | NSF | FCT | NHMRC | Search for entities by funder. |
fundingStream | ... | Search for entities by funding stream. |
FP7scientificArea | ... | Search for FP7 entities by scientific area. |
keywords | White-space separated list of keywords. | N/A |
Reasearch Products Common Parameters
Endpoint: http://api.openaire.eu/search/researchProducts
Parameter | Option | Description |
---|---|---|
sortBy | sortBy=field,[ascending|descending] ; 'field' is one of: dateofcollection , resultstoragedate , resultstoragedate , resultembargoenddate , resultembargoendyear , resultdateofacceptance , resultacceptanceyear |
The sorting order of the specified field. |
doi | Comma separated list of DOIs. Alternatively, it is possible to repeat the parameter for each requested doi. |
Gets the research products with the given DOIs, if any. |
orcid | Comma separated list of ORCID iDs of authors. Alternatively, it is possible to repeat the parameter for each author ORCID iD. |
Gets the research products linked to the given ORCID iD of an author, if any. |
fromDateAccepted | Date formatted as YYYY-MM-DD |
Gets the research products whose date of acceptance is greater than or equal the given date. |
toDateAccepted | Date formatted as YYYY-MM-DD |
Gets the research products whose date of acceptance is less than or equal the given date. |
title | White-space separated list of keywords. | Gets the research products whose titles contain the given list of keywords. |
author | White-space separated list of names and/or surnames. | Search for research products by authors. |
openaireProviderID | Comma separated list of identifiers. | Search for research products by openaire data provider identifier. Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
openaireProjectID | Comma separated list of identifiers. Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
Search for research products by openaire project identifier. Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
hasProject | true | false | If hasProject is true gets the research products that have a link to a project. If hasProject is false gets the publications with no links to projects. |
projectID | ... | The given grant identifier of the project. |
FP7ProjectID | ... | Search for research products associated to a FP7 project with the given grant number. It is equivalent to a query by funder=FP7&projectID=grantID |
OA | true | false | If OA is true gets Open Access research products. If OA is false gets the non Open Access research products |
country | 2 letter country code | Search for research products associated to the country code |
Publication parameters
Endpoint: http://api.openaire.eu/search/publications
You can use all the research products parameters and the ones available in the following table.Parameter | Option | Description |
---|---|---|
openairePublicationID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the parameter for each requested identifier. |
Gets the publication with the given openaire identifier, if any. |
originalId | Comma separated list of original identifiers as we get them from the content provider. Alternatively, it is possible to repeat the parameter for each requested identifier. |
Gets the publication with the given openaire identifier, if any. |
sdg | The number of the Sustainable Development Goals [1-17] .Check here to see the Sustainable Developemnt Goals. |
Gets the publications that are classified with the respective Sustainable Development Goal number. |
fos | The Field of Science classification value. Check here to see the Field of Science classification values |
Gets the publications that are classified with the respective Field of Science classification value. |
Research Data specific parameters
Endpoint: http://api.openaire.eu/search/datasets
You can use all the research products parameters and the ones available in the following table.Parameter | Option | Description |
---|---|---|
openaireDatasetID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the parameter for each requested identifier. |
Gets the dataset with the given openaire identifier, if any. |
Research Software specific parameters
Endpoint: http://api.openaire.eu/search/software
You can use all the research products parameters and the ones available in the following table.Parameter | Option | Description |
---|---|---|
openaireSoftwareID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the parameter for each requested identifier. |
Gets the software with the given openaire identifier, if any. |
Other Research Products specific parameters
Endpoint: http://api.openaire.eu/search/other
You can use all the research products parameters and the ones available in the following table.Parameter | Option | Description |
---|---|---|
openaireOtherID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the parameter for each requested identifier. |
Gets the other research products with the given openaire identifier, if any. |
Project specific parameters
Endpoint: http://api.openaire.eu/search/projects
Parameter | Option | Description |
---|---|---|
sortBy | sortBy=field,[ascending|descending] ; 'field' is one of: projectstartdate , projectstartyear , projectenddate , projectendyear , projectduration |
The sorting order of the specified field. |
grantID | Comma separated list of grant identifiers. | Gets the project with the given grant identifier, if any. |
openairePublicationID | Comma separated list of OpenAIRE identifiers. | Gets the publication with the given openaire identifier, if any. |
name | White-space separated list of keywords. | Gets the projects whose names contain the given list of keywords. |
acronym | N/A | Gets the project with the given acronym, if any. |
callID | N/A | Search for projects by call identifier. |
startYear | Year formatted as YYYY |
Gets the projects that started in the given year. |
endYear | Year formatted as YYYY . |
Gets the projects that ended in the given year. |
participantCountries | Comma separeted list of 2 letter country codes. | Search for projects by participant countries. |
participantAcronyms | White space separeted list of acronyms of institutions. | Search for projects by participant institutions. |