openaire-api-http-doc/api.html

518 lines
30 KiB
HTML
Executable File

<!DOCTYPE html>
<html lang="en-gb">
<head>
<!--link href="http://demo.openaire.eu" rel="canonical" /-->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission, EC, FP7, ERC,
Horizon 2020, H2020, search, projects, publications, research data, datasets, HTTP, funders "/>
<link href="./assets/favicon.ico" rel="shortcut icon" />
<title>OpenAIRE API documentation - Selective access</title>
<script src="./assets/jquery.js"></script>
<script src="./assets/uikit.js"></script>
<script src="./assets/uikit-icon-max.js"></script>
<link rel="stylesheet" type="text/css" href="./assets/theme.css">
<link rel="stylesheet" type="text/css" href="./assets/custom.css">
<link rel="stylesheet" type="text/css" href="./assets/custom.css.1">
</head>
<body class="" style="">
<div class="uk-offcanvas-content uk-height-viewport">
<!-- MENU STARTS HERE-->
<!-- MAIN MENU STARTS HERE-->
<div class="tm-header-mobile uk-hidden@m">
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" uk-sticky="">
<nav class="uk-navbar-container uk-navbar" uk-navbar="">
<div class="uk-navbar-left">
<a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="" style="z-index:1000;">
<div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon custom-navbar-toggle-icon"> </div>
</a>
</div>
<div class="uk-navbar-center uk-margin-left">
<img src="./assets/apple-icon-72x72.png" alt="OpenAIRE" class="uk-responsive-height">
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-visible@m" routerLinkActive="uk-link" routerLink="/" >
OpenAIRE API Documentation</a>
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-hidden@m" routerLinkActive="uk-link" routerLink="/" >
API Documentation</a>
</div>
</nav>
<div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
<div class="uk-offcanvas-bar">
<button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close=""></button>
<div class="uk-child-width-1-1 uk-grid" uk-grid="">
<div>
<div class="uk-panel" id="module-0">
<ul class="uk-nav uk-nav-default">
<li class="uk-nav-header uk-parent">
<a href="./overview.html"> Overview </a>
</li>
<li class="uk-nav-header uk-parent">
Bulk access
<ul class="uk-nav-sub">
<li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH</a></li>
<li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
</ul>
</li>
<li class="uk-nav-header uk-parent uk-active">
<a href="./api.html">Selective access</a>
<ul class="uk-nav-sub">
<li><a href="./api.html#pubs" >Publications</a></li>
<li><a href="./api.html#datasets" >Research Data</a></li>
<li><a href="./api.html#projects" >Projects</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="tm-header uk-visible@m tm-header-transparent" uk-header=""><!-- top=".tm-header" + [class*=&quot;uk-section&quot;] -->
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" media="768" uk-sticky="">
<div class="uk-container uk-container-expand">
<nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}" style="background-color:white !important;">
<div class="uk-navbar-center">
<div class="uk-logo uk-navbar-item uk-margin-small-top">
<img alt="OpenAIRE" class="uk-responsive-height" src="./assets/Logo_Horizontal.png">
</div>
<div class="uk-logo uk-navbar-item uk-margin-medium-top">
<h3 style="color: #767779 !important;"> API Documentation </h3>
</div>
</div>
<div class="uk-navbar-right">
<ul class="uk-navbar-nav uk-margin-small-top">
<li>
<a href="./overview.html"><span class="uk-icon" uk-icon="icon: home"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" ratio="1"> <polygon points="18.65 11.35 10 2.71 1.35 11.35 0.65 10.65 10 1.29 19.35 10.65"></polygon> <polygon points="15 4 18 4 18 7 17 7 17 5 15 5"></polygon> <polygon points="3 11 4 11 4 18 7 18 7 12 12 12 12 18 16 18 16 11 17 11 17 19 11 19 11 13 8 13 8 19 3 19"></polygon></svg></span></a>
</li>
<li>
<a href="#">Bulk access</a>
<div class="uk-navbar-dropdown">
<ul class="uk-nav uk-navbar-dropdown-nav">
<li><a href="./oai-pmh.html">OAI-PMH</a></li>
<li><a href="./bulk-projects.html">Bulk access to projects</a></li>
</ul>
</div>
</li>
<li class="uk-active">
<a href="#">Selective access</a>
<div class="uk-navbar-dropdown">
<ul class="uk-nav uk-navbar-dropdown-nav">
<li><a href="./api.html#pubs">Publications</a></li>
<li><a href="./api.html#datasets">Datasets</a></li>
<li><a href="./api.html#projects">Projects</a></li>
</ul>
</div>
</li>
</ul>
</div>
</nav>
</div>
</div>
</div>
<!-- MENU ENDS HERE-->
<div class=" first_page_section uk-section-default uk-section uk-padding-remove-vertical">
<div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
</div>
</div>
<div class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
<div class="uk-container">
<div class="uk-grid">
<div class="uk-width-1-3@s uk-width-1-4@m uk-width-1-4@l uk-visible@m" >
<ul class="uk-nav-default uk-nav-parent-icon" uk-nav="multiple: false" uk-sticky="offset: 100; media:@s" >
<li class="uk-parent uk-open">
<a href="#">HTTP API Documentation</a>
<ul class="uk-nav-sub">
<li><a href="#common" uk-scroll>Common Parameters</a></li>
<li><a href="#pubs" uk-scroll>Publications</a></li>
<li><a href="#datasets" uk-scroll>Datasets</a></li>
<li><a href="#projects" uk-scroll>Projects</a></li>
</ul>
</li>
</ul>
</div>
<div class="tm-main uk-width-expand uk-row-first uk-first-column">
<!--div class="uk-text-right" uk-sticky="offset:100; animation: uk-animation-slide-bottom; bottom: #bottom">
<a class="uk-totop" href="#" uk-scroll="" uk-totop="">
</a>
</div-->
<!--div class="uk-card uk-margin-remove uk-padding-remove uk-card-default uk-card-body" style="z-index: 980;" uk-sticky="offset:100; bottom: #bottom">
<a class="uk-totop" href="#" uk-scroll="" uk-totop="">
</a></div-->
<p>
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 <a href="http://api.openaire.eu/#cha_oai_pmh" target="_blank">OAI-PMH</a>.<br>
</p>
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
To query for datasets metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
</p>
<h2 id="common">Common Parameters</h2>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small">
<thead>
<tr>
<th>Parameter</th>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>page</td>
<td>integer</td>
<td>Page number of the search results.</td>
</tr>
<tr>
<td>size</td>
<td>integer</td>
<td>Number of results per page.</td>
</tr>
<tr>
<td>format</td>
<td>json | xml | csv | tsv</td>
<td>The format of the response. The default is xml.</td>
</tr>
<tr>
<td>model</td>
<td>openaire | sygma</td>
<td>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 <a href="https://www.openaire.eu/schema/sygma/oaf_sygma_v2.1.xsd" target="_blank">here</a>.</td>
</tr>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code></td>
<td>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.</td>
</tr>
<tr>
<td>hasECFunding</td>
<td>true | false</td>
<td>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.</td>
</tr>
<tr>
<td>hasWTFunding</td>
<td>true | false</td>
<td>If hasWTFunding is true gets the entities funded by Wellcome Trust. The results are the same as those obtained with <code>funder=wt</code>. If hasWTFunding is false gets the entities related to projects not funded by Wellcome Trust.</td>
</tr>
<tr>
<td>funder</td>
<td>WT | EC | ARC | ANDS | NSF | FCT | NHMRC</td>
<td>Search for entities by funder.</td>
</tr>
<tr>
<td>fundingStream</td>
<td>...</td>
<td>Search for entities by funding stream.</td>
</tr>
<tr>
<td>FP7scientificArea</td>
<td>...</td>
<td>Search for FP7 entities by scientific area.</td>
</tr>
<tr>
<td>keywords</td>
<td>White-space separated list of keywords.</td>
<td>N/A</td>
</tr>
</tbody>
</table>
<h2 id="pubs">Publication specific parameters</h2>
<p>Endpoint: <strong>http://api.openaire.eu/search/publications</strong></p>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
<th>Parameter</th>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>doi</td>
<td>Comma separated list of DOIs. <br>
Alternatevely, it is possible to repeat the paramater for each requested doi.
</td>
<td>Gets the publications with the given DOIs, if any.</td>
</tr>
<tr>
<td>openairePublicationID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
Alternatevely, it is possible to repeat the paramater for each requested identifier.
</td>
<td>Gets the publication with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the publications whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the publications whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the publications whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>White-space separated list of names and/or surnames.</td>
<td>Search for publications by authors.</td>
</tr>
<tr>
<td>openaireAuthorID</td>
<td>Comma separated list of identifiers. <br>
Alternatevely, it is possible to repeat the paramater for each author id. In both cases, author identifiers will form a query with OR semantics.
</td>
<td>Search for publications by openaire author identifier. Alternatevely, it is possible to repeat the parameter for each author id. In both cases, author identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for publications by openaire data provider identifier. <br>
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>Comma separated list of identifiers. <br>
Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
<td>Search for publications by openaire project identifier. Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>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.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for publications associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access publications. If OA is false gets the non Open Access publications</td>
</tr>
</tbody>
</table>
<h2 id="datasets">Dataset specific parameters</h2>
<p>Endpoint: <strong>http://api.openaire.eu/search/datasets</strong></p>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
<th>Parameter</th>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>doi</td>
<td>Comma separated list of DOIs. <br>
Alternatevely, it is possible to repeat the paramater for each requested doi.
</td>
<td>Gets the publications with the given DOIs, if any.</td>
</tr>
<tr>
<td>openaireDatasetID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
Alternatevely, it is possible to repeat the paramater for each requested identifier.</td>
<td>Gets the publication with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>openaireDatasetID</td>
<td>Comma separated list of openaire identifiers</td>
<td>Gets the publication with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the datasets whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>A white-space separated list of names and/or surnames</td>
<td>Search for datasets by authors.</td>
</tr>
<tr>
<td>openaireAuthorID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for datasets by openaire author identifier. <br>
Alternatevely, it is possible to repeat the parameter for each author id. In both cases, author identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for datasets by openaire data provider identifier. <br>
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>Comma separated list of identifiers. </td>
<td>Search for publications by openaire project identifier. <br>
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>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.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for datasets associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
</tr>
</tbody>
</table>
<h2 id="projects">Project specific parameters</h2>
<p>Endpoint: <strong>http://api.openaire.eu/search/projects</strong></p>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
<th>Parameter</th>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>projectstartdate</code>, <code>projectstartyear</code>, <code>projectenddate</code>, <code>projectendyear</code>, <code> projectduration</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>grantID</td>
<td>Comma separated list of DOIs.</td>
<td>Gets the project with the given grant identifier, if any.</td>
</tr>
<tr>
<td>openairePublicationID</td>
<td>Comma separated list of OpenAIRE identifiers.</td>
<td>Gets the publication with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>name</td>
<td>White-space separated list of keywords.</td>
<td>Gets the projects whose names contain the given list of keywords.</td>
</tr>
<tr>
<td>acronym</td>
<td>N/A</td>
<td>Gets the project with the given acronym, if any.</td>
</tr>
<tr>
<td>callID</td>
<td>N/A</td>
<td>Search for projects by call identifier.</td>
</tr>
<tr>
<td>startYear</td>
<td>Year formatted as <code>YYYY</code></td>
<td>Gets the projects that started in the given year.</td>
</tr>
<tr>
<td>endYear</td>
<td>Year formatted as <code>YYYY</code>.</td>
<td>Gets the projects that ended in the given year.</td>
</tr>
<tr>
<td>participantCountries</td>
<td>Comma separeted list of 2 letter country codes.</td>
<td>Search for projects by participant countries.</td>
</tr>
<tr>
<td>participantAcronyms</td>
<td>White space separeted list of acronyms of institutions.</td>
<td>Search for projects by participant institutions.</td>
</tr>
</tbody>
</table>
<div class="uk-card uk-margin-remove uk-padding-small uk-card-default uk-card-body uk-width-1-1@s uk-width-3-4@m uk-width-1-2@l" style="z-index: 100; bottom: 0px; position: fixed;" >
<a href="#" uk-scroll="" uk-totop="" class=" uk-align-right uk-totop uk-icon uk-margin-right">
</a>
</div>
</div>
</div>
</div>
</div>
<!-- FOOTER STARTS HERE-->
<div class="custom-footer" style="z-index: 200;">
<div class="uk-section-primary uk-section uk-section-small">
<div class="uk-container">
<div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
<div class="uk-width-1-1@m uk-first-column">
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
<img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
</div>
<div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
<div><a href="http://creativecommons.org/licenses/by/4.0/" rel="license"><img alt="Creative" src="./assets/80x15.png" style="height: auto; max-width: 100%; vertical-align: middle;"></a>&nbsp;UNLESS OTHERWISE INDICATED, ALL MATERIALS CREATED BY THE OPENAIRE CONSORTIUM ARE LICENSED UNDER A&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.</div>
<div>OPENAIRE IS POWERED BY&nbsp;<a href="http://www.d-net.research-infrastructures.eu/">D-NET</a>.</div>
</div>
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
<a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop="">
</a>
</div>
</div>
</div>
</div>
</div>
</div>
<!--/div-->
</div>
</body>
</html>