Table of Contents
The OpenAIRE API allows developers to access the metadata information space of OpenAIRE programmatically.
The default format of delivered records is oaf (OpenAire Format - current version 0.2):
| https://www.openaire.eu/schema/0.2/oaf-0.2.xsd |
| https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html |
The latest versions of the XML schema and documentation are also available at the following links:
| https://www.openaire.eu/schema/latest/oaf.xsd |
| https://www.openaire.eu/schema/latest/doc/oaf.html |
Older versions:
oaf XML schema v0.1 |
oaf XML schema v0.1 documentation |
OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the OAI-PMH protocol please refer to the official documentation at http://www.openarchives.org/OAI/openarchivesprotocol.html
The OpenAIRE OAI-PMH endpoint is http://api.openaire.eu/oai_pmh
For information about the endpoint check http://api.openaire.eu/oai_pmh?verb=Identify
The updated list of OAI sets is always available at: http://api.openaire.eu/oai_pmh?verb=ListSets
For quick reference, we report here the likely more interesting sets:
| publications: the set of all publications |
| datasets: the set of all datasets |
| OpenAccess: the set of all Open Access publications and datasets |
| projects: the set of all projects |
| FP7Projects: the set of projects funded by the EC Seventh Framework Programme |
| WTProjects: the set of projects funded by Wellcome Trust |
| organizations: the set of all organizations |
For the list of available metadata prefix, check: http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats.
Note that records will always be available in the OpenAIRE format (schema, documentation).
The availability of records in oai_dc depends on the typology of records. Currently publications and datasets (records of type 'result') are available in oai_dc.
The APIs offer custom access to FP7 and WT projects information for the DSpace and EPrints platforms:
| DSpace endpoint: http://api.openaire.eu/projects/dspace/$funder/ALL/ALL |
| ePrints endpoint: http://api.openaire.eu/projects/eprints/$funder/ALL/ALL |
The URLs embed the parameters needed to collect sub-portions of the EC projects, where the
pattern is Funder/SpecificProgramme/ScientificArea.
Additional parameters can be concatenated to the URL to refine the results by date (date
must be in the form YYYY-MM-DD):
| startFrom |
| startUntil |
| endFrom |
| endUntil |
Examples:
| Get WT projects EPrints: http://api.openaire.eu/projects/eprints/WT/ALL/ALL |
| Get FP7 projects of the specific programme “SP2-IDEAS” for EPrints: http://api.openaire.eu/projects/eprints/FP7/SP2/ALL |
| Get FP7 projects for DSpace that started after the given date: http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01 |
Table of Contents
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
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
Page number of the search results.
Number of results per page.
Options:json | xml
Select the format of the response. Default is xml.
Options:openaire | sygma
Select 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
Select the sorting order: sortBy=field[,ascending|,descending]
For the list of sortable fields, please refer to the documentation relative to the specific type of entity you are querying for.
Allowed values: true|false. If hasECFunding is true gets the
publications/datasets/projects funded by the EC. If hasECFunding is false gets the
publications/datasets/projects related to projects not funded by the EC.
Allowed values: true|false.If hasUKFunding is true gets the
publications/datasets/projects funded by the UK. If hasUKFunding is false gets the
publications/datasets/projects related to projects not funded by the UK.
Allowed values: wt|fp7|h2020. Search for publications/datasets/projects
by funder.
Search for publications/datasets/projects by funding stream.
Search for FP7 publications/datasets/projects by scientific area.
Allowed values: white-space separated list of keywords.
Endpoint: http://api.openaire.eu/search/publications
Select the sorting order: sortBy=field,[ascending|descending]
where field is one of: dateofcollection, resultstoragedate, resultstoragedate, resultembargoenddate, resultembargoendyear, resultdateofacceptance, resultacceptanceyear
Gets the publications with the given DOIs, if any. Allowed values: comma separated list of DOIs. Alternatevely, it is possible to repeat the paramater for each requested doi.
Gets the publication with the given openaire identifier, if any. Allowed values: comma separated list of openaire identifiers. Alternatevely, it is possible to repeat the paramater for each requested identifier.
Gets the publications whose date of acceptance is greater than or equal the given date. Allowed values: date formatted as YYYY-MM-DD.
Gets the publications whose date of acceptance is less than or equal the given date. Allowed values: date formatted as YYYY-MM-DD.
Gets the publications whose titles contain the given list of keywords. Allowed values: white-space separated list of keywords.
Search for publications by authors. Allowed value is a white-space separated list of names and/or surnames.
Search for publications by openaire author identifier. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each author id. In both cases, author identifiers will form a query with OR semantics.
Search for publications by openaire data provider identifier. Allowed values: comma separated list of identifiers. Alternatevely, 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. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.
Allowed values: 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.
Search for publications associated to a project with the given grant identifier.
Search for publications associated to a FP7 project with the given grant number. It is equivalent to a query by funder=FP7&projectID=grantID
Allowed values: true|false. If OA is true gets Open Access publications.
If OA is false gets the non Open Access publications
Endpoint: http://api.openaire.eu/search/datasets
Select the sorting order: sortBy=field,[ascending|descending]
where field is one of: dateofcollection, resultstoragedate, resultstoragedate, resultembargoenddate, resultembargoendyear, resultdateofacceptance, resultacceptanceyear
Gets the datasets with the given DOIs, if any. Allowed values: comma separated list of DOIs. Alternatevely, it is possible to repeat the paramater for each requested doi.
Gets the publication with the given openaire identifier, if any. Allowed values: comma separated list of openaire identifiers. Alternatevely, it is possible to repeat the paramater for each requested identifier.
Gets the datasets whose date of acceptance is greater than or equal the given
date. Allowed values: date formatted as YYYY-MM-DD.
Gets the datasets whose date of acceptance is less than or equal the given date. Allowed values: date formatted as YYYY-MM-DD.
Gets the datasets whose titles contain the given list of keywords. Allowed values: white-space separated list of keywords.
Search for datasets by authors. Allowed value is a white-space separated list of names and/or surnames.
Search for datasets by openaire author identifier. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each author id. In both cases, author identifiers will form a query with OR semantics.
Search for datasets by openaire data provider identifier. Allowed values: comma separated list of identifiers. Alternatevely, 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. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.
Allowed values: 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.
Search for datasets associated to a FP7 project with the given grant number. It is equivalent to a query by funder=FP7&projectID=grantID
Allowed values: true|false. If OA is true gets Open Access datasets.
If OA is false gets the non Open Access datasets
Endpoint: http://api.openaire.eu/search/projects
Select the sorting order: sortBy=field,[ascending|descending]
where field is one of: projectstartdate, projectstartyear, projectenddate, projectendyear, projectduration
Gets the project with the given grant identifier, if any.
Allowed values: white-space separated list of keywords. Gets the projects whose names contain the given list of keywords.
Gets the project with the given acronym, if any.
Search for projects by call identifier.
Allowed values: year formatted as YYYY. Gets the projects that started in the given year.
Allowed values: year formatted as YYYY. Gets the projects that ended in the given year.
Allowed values: comma separeted list of 2 letter country codes. Search for projects by participant countries.
Allowed values: white space separeted list of acronyms of institutions. Search for projects by participant institutions.