Openaire XML Schema has been changed! Please click here to learn more!
The OpenAIRE HTTP API allows developers to access the metadata information space of OpenAIRE 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 information space, developers are
encouraged to use the OAI-PMH.
TERMS OF USE AND SLA
OpenAIRE HTTP API: the APIs are free-to-use (no sign-up needed) by any third-party service. Note that:
- The HTTP API limits each query to 10,000 paged results; for unlimited access to the APIs please contact the service administrators.
- Since 2015 an RDF dump of the LOD is made available in Zenodo.org
Metadata license is CC-BY: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as content provider.
Quality of Service: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the data center facilities of the Interdisciplinary Centre for Mathematical and Computational Modelling (ICM).
APIs rate limits
- no more than 30 concurrent connections from single IP to any APIs
- no more than 67 concurrent requests in total
- no more then 37 concurrent request in total (max 30 per single IP) to the HTTP API for selective access
- no more than 15 requests/second to the HTTP API for selective access (in total, not per IP. If this limit is reached, requests will be delayed).
Common Parameters
Parameters included in this section can always be specified, regardless the type of entities (metadata about publications,
datasets, or projects) you want to retrieve.
To query for publications metadata: http://api.openaire.eu/search/publications
To query for datasets metadata: http://api.openaire.eu/search/datasets
To query for projects metadata: http://api.openaire.eu/search/projects
| 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 |
Publication specific parameters
Endpoint: http://api.openaire.eu/search/publications
| 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 paramater for each requested doi. |
Gets the publications with the given DOIs, if any. |
| openairePublicationID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the paramater for each requested identifier. |
Gets the publication with the given openaire identifier, if any. |
| fromDateAccepted | Date formatted as YYYY-MM-DD |
Gets the publications whose date of acceptance is greater than or equal the given date. |
| toDateAccepted | Date formatted as YYYY-MM-DD |
Gets the publications whose date of acceptance is less than or equal the given date. |
| title | White-space separated list of keywords. | Gets the publications whose titles contain the given list of keywords. |
| author | White-space separated list of names and/or surnames. | Search for publications by authors. |
| openaireProviderID | Comma separated list of identifiers. | Search for publications 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 paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
Search for publications 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 publications 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 publications 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 publications. If OA is false gets the non Open Access publications |
Dataset specific parameters
Endpoint: http://api.openaire.eu/search/datasets
| 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 paramater for each requested doi. |
Gets the datasets with the given DOIs, if any. |
| openaireDatasetID | Comma separated list of OpenAIRE identifiers. Alternatively, it is possible to repeat the paramater for each requested identifier. |
Gets the dataset with the given openaire identifier, if any. |
| fromDateAccepted | Date formatted as YYYY-MM-DD |
Gets the datasets whose date of acceptance is greater than or equal the given date. |
| toDateAccepted | Date formatted as YYYY-MM-DD |
Gets the datasets whose date of acceptance is less than or equal the given date. |
| title | White-space separated list of keywords. | Gets the datasets whose titles contain the given list of keywords. |
| author | A white-space separated list of names and/or surnames | Search for datasets by authors. |
| openaireProviderID | Comma separated list of identifiers. | Search for datasets 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. | Search for datasets 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 datasets that have a link to a project. If hasProject is false gets the datasets with no links to projects. |
| FP7ProjectID | ... | Search for datasets 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 datasets. If OA is false gets the non Open Access datasets |
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 DOIs. | 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. |
