194 lines
12 KiB
HTML
194 lines
12 KiB
HTML
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=8;" />
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:site" content="@NLM_NIH">
|
|
<meta name="twitter:title" content="ClinicalTrials.gov API Version 2.0 Now Available. NLM Technical Bulletin. 2024 Mar–Apr">
|
|
<meta name="twitter:description" content=" The NLM Technical Bulletin is your source to stay informed about NLM products and services.">
|
|
<meta name="twitter:image" content="https://www.nlm.nih.gov/pubs/techbull/images/nlm_tech_bulletin_graphic_twitter.jpg">
|
|
<meta property="og:url" content="https://www.nlm.nih.gov/pubs/techbull/tb.html" />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:title" content="ClinicalTrials.gov API Version 2.0 Now Available. NLM Technical Bulletin. 2024 Mar–Apr" />
|
|
<meta property="og:description" content="The NLM Technical Bulletin is your source to stay informed about NLM products and services." />
|
|
<meta property="og:image" content="https://www.nlm.nih.gov/pubs/techbull/images/nlm_tech_bulletin_graphic_facebook.jpg" />
|
|
<link type="text/css" href="/pubs/techbull/styles/reset.css" rel="stylesheet" />
|
|
|
|
<link type="text/css" href="/pubs/techbull/styles/technicalBulletin.css" rel="stylesheet" />
|
|
<!--Call jQuery-->
|
|
<script src="//assets.nlm.nih.gov/jquery/jquery-latest.min.js"></script>
|
|
<script src="//assets.nlm.nih.gov/jquery/jquery-migrate-latest.min.js"></script>
|
|
<script src="/pubs/techbull/scripts/techbull.js" type="text/javascript" language="javascript"></script>
|
|
<!--[if lte IE 8]>
|
|
<script type="text/javascript" src="/scripts/PIE.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" href="/pubs/techbull/styles/print.css" rel="stylesheet" media="print"/>
|
|
<title>ClinicalTrials.gov API Version 2.0 Now Available. NLM Technical Bulletin. 2024 Mar–Apr</title>
|
|
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" title="The Dublin Core metadata Element Set" />
|
|
<meta name="DC.Title" content="ClinicalTrials.gov API Version 2.0 Now Available" />
|
|
|
|
<meta name="DC.Publisher" content="U.S. National Library of Medicine" />
|
|
<meta name="DC.Date.Issued" content="2024-03-14" />
|
|
<meta name="DC.Date.Modified" content="2024-03-19" />
|
|
<meta name="NLMDC.Date.LastReviewed" content="2024-03-19" />
|
|
<meta name="NLM.Contact.Email" content="nlmtechbull@mail.nlm.nih.gov" />
|
|
<meta name="DC.Type" content="Newsletters" />
|
|
<meta name="NLM.Permanence.Level" content="Permanent: Stable Content" />
|
|
<meta name="DC.Rights" content="Public Domain" />
|
|
<meta name="DC.Language" content="eng" />
|
|
|
|
|
|
<meta name="DC.Subject.Keyword" content="Application Programming Interface" />
|
|
<meta name="DC.Subject.Keyword" content="Update" />
|
|
<meta name="DC.Subject.Keyword" content="ClinicalTrials.gov" />
|
|
|
|
<!-- Google Tag Manager -->
|
|
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-MT6MLL');</script>
|
|
<!-- End Google Tag Manager -->
|
|
</head>
|
|
<body>
|
|
<!-- Google Tag Manager -->
|
|
<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-MT6MLL" height="0" width="0" style="display:none;visibility:hidden" title="googletagmanager"></iframe></noscript>
|
|
<!-- End Google Tag Manager -->
|
|
<div class="skipnavigation"><a title="Skip the navigation on this page" href="#skipnav" class="skipnavigation">Skip Navigation Bar</a></div>
|
|
|
|
<div>
|
|
|
|
<div class="header">
|
|
<img src="/pubs/techbull/images/tb_logo_113.jpg" alt="National Library of Medicine Technical Bulletin" title="National Library of Medicine Technical Bulletin" /><img src="/pubs/techbull/images/nlm_masthead_113.jpg" alt="National Library of Medicine Technical Bulletin" title="National Library of Medicine Technical Bulletin" usemap="#nlm_masthead_113" />
|
|
</div>
|
|
|
|
<div class="search_box">
|
|
<form method="get" action="//vsearch.nlm.nih.gov/vivisimo/cgi-bin/query-meta" target="_self" name="searchForm" class="searchForm">
|
|
<label class="displaynone" for="search">Search</label>
|
|
<input name="query" id="search" type="text" class="search-input inactive" size="50" onfocus="this.value=''" value="Search here for NLM Technical Bulletin articles" aria-label="Search NLM Technical Bulletin">
|
|
<input type="hidden" name="v:project" value="technical-bulletin">
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="nav">
|
|
<!--Open drop-->
|
|
<ul class="topnav">
|
|
<li class="currentissue"><a href="//www.nlm.nih.gov/pubs/techbull/current_issue.html">Current Issue</a> <img class="separator" src="/pubs/techbull/images/whitelinetransparentbackground.gif " alt=""/></li>
|
|
<li class="archive"><a href="//www.nlm.nih.gov/pubs/techbull/back_issues.html">Previous Issues</a> <img class="separator" src="/pubs/techbull/images/whitelinetransparentbackground.gif " alt=""/></li>
|
|
<li class="about"><a href="//www.nlm.nih.gov/pubs/techbull/about.html">About</a> <img class="separator" src="/pubs/techbull/images/whitelinetransparentbackground.gif " alt=""/></li>
|
|
<li class="staycurrent"><a href="//www.nlm.nih.gov/pubs/techbull/stay_current.html">Stay Current <img class="emaillogo" src="/pubs/techbull/images/email_20px.gif" alt="E-Mail Sign Up" style="margin-top: -4px;"/> <img class="rsslogo" src="/pubs/techbull/images/rss_20px.gif" alt="RSS Feed" style="margin-top: -4px;"/></a></li>
|
|
</ul>
|
|
<!--Close drop-->
|
|
</div>
|
|
<div class="body">
|
|
<a id="skipnav" name="skipnav"></a>
|
|
<div class="syndicate">
|
|
<p class="tableOfContents"><strong>Table of Contents: <a href="/pubs/techbull/ma24/ma24_issue_cover.html">2024 MARCH–APRIL No. 457</a></strong></p>
|
|
<p class="prevnext"><span class="buttons">
|
|
<span class="previous"><a href="ma24_pmc_updates.html">Previous</a></span> <span class="next"><a href="ma24_leiter_nlm_mla_lecture.html">Next</a></span>
|
|
|
|
</span></p>
|
|
<hr class="hr1" />
|
|
<h1 class="articleH1">ClinicalTrials.gov API Version 2.0 Now Available</h1>
|
|
<p class="tbyearmonth">ClinicalTrials.gov API Version 2.0 Now Available. 2024 Mar-Apr;(457):e2.</p>
|
|
<div class="articleactions">2024 March 19 <span class="status">[posted]</span>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="articleParagraph">
|
|
|
|
<p>The ClinicalTrials.gov <a href="https://www.clinicaltrials.gov/data-api/api">API version 2.0</a> is now available on the modernized <a href="https://clinicaltrials.gov/">ClinicalTrials.gov</a> website. The API, or application programming interface, is a tool to help researchers and developers access the data in ClinicalTrials.gov study records. This new version differs from the legacy API on the classic ClinicalTrials.gov website in important ways, some of which we highlight below.</p>
|
|
<p>The ClinicalTrials.gov API version 2.0 is a REST API and uses the <a href="https://spec.openapis.org/oas/v3.0.3">OpenAPI Specification 3.0</a> to describe its meta information. This approach has the following benefits:
|
|
<ul>
|
|
<li>Allows the support of third-party OpenAPI 3.0 libraries and applications that rely on the ClinicalTrials.gov API to build customized interfaces and workflows.</li>
|
|
<li>Aligns with standard expectations for publicly accessible modern APIs.</li></ul></p>
|
|
<p>Specific differences in how data are handled by the new ClinicalTrials.gov API include:
|
|
<ul>
|
|
<li>Standardizing and changing the data type of certain fields (e.g., Intervention Type) from text to enumurated values, meaning users can choose from a set of values.</li>
|
|
<li>Standardizing number fields.</li>
|
|
<li>Using the ISO 8601 format for dates.</li>
|
|
<li>Using the <a href="https://commonmark.org">CommonMark Markdown</a> format for rich-text data.</li>
|
|
<li>Using JSON as the primary response data.</li></ul></p>
|
|
<p>The benefits of these changes for ClinicalTrials.gov API users include:
|
|
<ul>
|
|
<li>Reducing the data transformation burden.</li>
|
|
<li>Reducing the validation burden.</li>
|
|
<li>Allowing users to more readily predict, consume, and use rich-text data.</li>
|
|
<li>Meeting users' expectations for data from publicly accessible, modern APIs.</li></ul></p>
|
|
<p>To support users as they transition to the modernized API, we have provided support documentation such as a <a href="https://clinicaltrials.gov/data-api/about-api/api-migration">Migration Guide</a>, which discusses the differences between the classic ClinicalTrials.gov API and the ClinicalTrials.gov API version 2.0. It also covers how legacy endpoints are supported through the modernized API. Additional documentation includes:
|
|
<ul>
|
|
<li>Study Data Structure.</li>
|
|
<li>Search Areas.</li>
|
|
<li>CSV Download.</li></ul></p>
|
|
<p>Beginning in April, users may experience brief disruptions in legacy API services during a series of planned outages. Users are strongly encouraged to migrate to the new API as soon as possible. The classic ClinicalTrials.gov API will be retired in June 2024. For more information on the new ClinicalTrials.gov API, please see <a href="https://clinicaltrials.gov/data-api/about-api">About the API</a> on the modernized ClinicalTrials.gov website.</p>
|
|
<p><a name="fig1"></a>
|
|
<div class="figure"><br />
|
|
<img src="/pubs/techbull/ma24/graphics/ctg_fig1.png" alt="screenshot of API Migration Guide including left-hand navigation menu listing Introduction, Info API Endpoints, Qurey API Endpoints, Other Endpoints, and Study Data Model." /><br />
|
|
<strong>Figure 1: An API Migration Guide is available on the ClinicalTrials.gov website for additional support.</strong></div></p>
|
|
<p><a name="fig2"></a>
|
|
<div class="figure"><br />
|
|
<img src="/pubs/techbull/ma24/graphics/ctg_fig2.png" alt="screenshot of the About the API webpage, including the link to the API Migration Guide at the top of the page." /><br />
|
|
<strong>Figure 2: Additional information about the new ClinicalTrials.gov API is available on the modernized ClinicalTrials.gov website.</strong></div></p>
|
|
</div>
|
|
<p class="articleParagraph">
|
|
|
|
|
|
|
|
|
|
</p>
|
|
</div>
|
|
<div class="footer">
|
|
<p class="footerLeft"><span class="footerissn"><strong>ISSN 2161-2986 (Online)</strong> Content not copyrighted; freely reproducible.</span><br/>
|
|
<a href="/">National Library of Medicine</a> 8600 Rockville Pike, Bethesda, MD 20894
|
|
<br/>
|
|
<a href="//www.nlm.nih.gov/socialmedia/index.html">Connect with NLM</a>,
|
|
<a href="//www.nlm.nih.gov/web_policies.html">Web Policies</a>,
|
|
<a href="//www.nlm.nih.gov/careers/jobopenings.html">Careers</a>,
|
|
<a href="//www.nlm.nih.gov/accessibility.html">Accessibility</a>,
|
|
<a href="//www.usa.gov/" id="anch_34">USA.gov</a>,
|
|
<a href="//www.hhs.gov/vulnerability-disclosure-policy/index.html">HHS Vulnerability Disclosure</a>
|
|
<br/>
|
|
|
|
<a href="//www.nih.gov/">NIH</a>,
|
|
<a href="https://www.hhs.gov/">HHS</a>,
|
|
<a href="//www.nih.gov/institutes-nih/nih-office-director/office-communications-public-liaison/freedom-information-act-office">FOIA</a>,
|
|
<a class="supportLink" href="//support.nlm.nih.gov?from=" target="_blank">NLM Support Center</a>
|
|
|
|
</p>
|
|
|
|
<p class="footerRight">
|
|
<strong>Last updated:</strong> 19 March 2024</p>
|
|
</div>
|
|
</div>
|
|
<map id="nlm_masthead_113" name="nlm_masthead_113">
|
|
<area shape="rect" alt="NLM Technical Bulletin" coords="1,15,396,45" href="//www.nlm.nih.gov/pubs/techbull/tb.html" title="NLM Technical Bulletin" />
|
|
<area shape="rect" alt="National Library of Medicine" coords="0,47,203,62" href="//www.nlm.nih.gov/" title="National Library of Medicine" />
|
|
<area shape="rect" coords="207,47,396,62" href="//www.nih.gov/" alt="National Institutes of Health" title="" />
|
|
</map>
|
|
<!--*****************************Content end*******************************-->
|
|
<script src="/scripts/support.js"></script>
|
|
<script src="/core/nlm-notifyExternal/1.0/nlm-notifyExternal.min.js"></script>
|
|
</body>
|
|
</html>
|
|
|