CINXE.COM

Using data :: Technical Documentation

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Using data :: Technical Documentation</title> <link rel="canonical" href="https://techdocs.gbif.org/en/data-use/"> <link rel="next" href="download-formats"> <meta name="generator" content="Antora 3.1.2"> <link rel="stylesheet" href="../_/css/site.css"> <link rel="stylesheet" href="../_/css/special-pages.css"> <script>var uiRootPath = '../_'</script> </head> <body class="article"> <header class="header"> <nav class="navbar"> <div class="navbar-brand"> <a class="navbar-item" href="https://techdocs.gbif.org/en"> <svg class="logo" viewBox="90 239.1 539.7 523.9" xmlns="http://www.w3.org/2000/svg"> <path class="gbif-logo-svg" d="M325.5,495.4c0-89.7,43.8-167.4,174.2-167.4C499.6,417.9,440.5,495.4,325.5,495.4"></path> <path class="gbif-logo-svg" d="M534.3,731c24.4,0,43.2-3.5,62.4-10.5c0-71-42.4-121.8-117.2-158.4c-57.2-28.7-127.7-43.6-192.1-43.6c28.2-84.6,7.6-189.7-19.7-247.4c-30.3,60.4-49.2,164-20.1,248.3c-57.1,4.2-102.4,29.1-121.6,61.9c-1.4,2.5-4.4,7.8-2.6,8.8c1.4,0.7,3.6-1.5,4.9-2.7c20.6-19.1,47.9-28.4,74.2-28.4c60.7,0,103.4,50.3,133.7,80.5C401.3,704.3,464.8,731.2,534.3,731"></path> </svg> <div class="nav-brand__name-area"> <span>Technical Documentation</span> </div> </a> <button class="navbar-burger" data-target="topbar-nav"> <span></span> <span></span> <span></span> </button> </div> <div id="topbar-nav" class="navbar-menu"> <div class="navbar-end"> <div class="navbar-item has-dropdown is-hoverable"> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="../data-processing/">Data processing</a> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="./">Data use</a> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="../openapi/">API</a> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="../cloud-services/">Cloud services</a> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="../system-components/">System components</a> </div> </div> <div class="navbar-end"> <div class="navbar-item search hide-for-print"> <div id="search-field" class="field"> <input id="search-input" type="text" placeholder="Search docs"> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <!-- Current: en --> <a class="navbar-link" href="en"> <svg class="navbar-languages" fill="#fcfcfc" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"> <path d="M0 0h24v24H0z" fill="none"/> <path d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="../../en/data-use/">English</a> <!--a class="navbar-item" href="../../es/data-use/">español</a--> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link"> <svg class="navbar-feedback" fill="#fcfcfc" height="24" viewBox="0 0 100 100" width="24" xmlns="http://www.w3.org/2000/svg" > <path d="M15.5,15.498h69v51.754H67.253v17.25L50,67.252H15.5V15.498z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="https://github.com/gbif/tech-docs/issues/new?labels=Feedback&body=Feedback+on+[Using data](https://techdocs.gbif.org/en/data-use/) ([Github source for this page](../blob/main/./en/data-use/modules/ROOT/pages/index.adoc))%0A%0AWrite+your+feedback+here.">Leave feedback on GitHub</a> <a class="navbar-item" href="mailto:helpdesk@gbif.org?subject=Feedback on technical documentation 'Using data'&body=Feedback on https://techdocs.gbif.org/en/data-use/">Send feedback by email</a> <a class="navbar-item" href="https://github.com/gbif/tech-docs/edit/main/en/data-use/modules/ROOT/pages/index.adoc">Edit this page on GitHub</a> </div> </div> </div> </div> </nav> </header> <div class="body"> <div class="nav-container" data-component="data-use" data-version=""> <aside class="nav"> <div class="panels"> <div class="nav-panel-menu is-active" data-panel="menu"> <nav class="nav-menu"> <h3 class="title"><a href="./">Data Use</a></h3> <ul class="nav-list"> <li class="nav-item" data-depth="0"> <ul class="nav-list"> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">Data downloads</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="download-formats">Occurrence download formats</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">Issues and flags</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="occurrence-issues-and-flags">Occurrence issues and flags</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="checklist-issues-and-flags">Checklist issues and flags</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">API Usage</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="api-introduction">API Introduction</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="rgbif">rgbif</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="pygbif">pygbif</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">API Downloads</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="api-downloads">API Downloads</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="api-sql-downloads">API SQL Downloads</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="api-sql-download-functions">API SQL Downloads – Functions</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="data-cubes">Species occurrence cubes</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="../cloud-services/">Cloud computing services</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="citation">Citation</a> </li> </ul> </li> </ul> </nav> </div> </div> </aside> </div> <main class="article"> <div class="toolbar" role="navigation"> <button class="nav-toggle"></button> <a href="../" class="home-link"></a> <nav class="breadcrumbs" aria-label="breadcrumbs"> <ul> <li><a href="./">Data Use</a></li> <li><a href="./">Using data</a></li> </ul> </nav> </div> <div class="content"> <aside class="toc sidebar" data-title="Page contents" data-levels="-1"> <div class="toc-menu"></div> </aside> <article class="doc"> <h1 class="page">Using data</h1> <div id="preamble"> <div class="sectionbody"> <div class="imageblock text-center"> <div class="content"> <img src="_images/data-use.png" alt="data use" width="320" height="192"> </div> </div> <div class="paragraph"> <p>GBIF users can access the data they need in several ways, and each method generally offers data in a choice of formats.</p> </div> <div class="paragraph"> <p>The easiest option is to use the <a href="https://www.gbif.org/">GBIF website</a>, which allows searching and browsing individual records, as well as requesting data downloads in the most common formats.</p> </div> <div class="paragraph"> <p>For more structured access, consider using the GBIF API, either directly or using the <strong>rgbif</strong> or <strong>pygbif</strong> libraries.</p> </div> <div class="paragraph"> <p>Some workflows are best served using cloud computing systems, and GBIF data is available on Amazon AWS, Google GCS and Microsoft Azure for this purpose.</p> </div> </div> </div> <div class="sect1"> <h2 id="data-downloads"><a class="anchor" href="#data-downloads"></a>Data downloads</h2> <div class="sectionbody"> <div class="paragraph"> <p>Downloads can be requested in three main formats: Simple, Darwin Core Archive and Species List. Registered users may create them using the website or through the API, or using rgbif or pygbif.</p> </div> <div class="paragraph"> <p>See <a href="api-downloads" class="xref page">API Downloads</a> for creating a download directly through the API. See <a href="rgbif" class="xref page">rgbif</a> and <a href="pygbif" class="xref page">pygbif</a> for creating downloads using R or Python.</p> </div> <div class="paragraph"> <p>See <a href="download-formats" class="xref page">Occurrence download formats</a> for details on the structure of each download format, regardless of how it was created.</p> </div> </div> </div> <div class="sect1"> <h2 id="api-usage"><a class="anchor" href="#api-usage"></a>API usage</h2> <div class="sectionbody"> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> Complete documentation on the API is available in the <a href="../openapi/" class="xref page">API Reference</a> section. </td> </tr> </table> </div> <div class="paragraph"> <p>The GBIF API provides a programmatic way to query and publish data on GBIF.org. It can be useful or necessary to use the API to</p> </div> <div class="ulist"> <ul> <li> <p>make advanced queries, not supported by the website,</p> </li> <li> <p>include the results of GBIF queries in scripts, workflows or analyses, which can then be repeated reliably and automatically,</p> </li> <li> <p>embed GBIF data into other websites.</p> </li> </ul> </div> <div class="paragraph"> <p>It can be accessed by any programming language, from a command-line terminal interface, or in some cases using a web browser.</p> </div> <div class="sect2"> <h3 id="rgbif"><a class="anchor" href="#rgbif"></a>rgbif</h3> <div class="paragraph"> <p><strong>rgbif</strong> is a library maintained by GBIF for the R statistical programming language. See <a href="rgbif" class="xref page">rgbif</a>.</p> </div> </div> <div class="sect2"> <h3 id="pygbif"><a class="anchor" href="#pygbif"></a>pygbif</h3> <div class="paragraph"> <p><strong>pygbif</strong> is a library maintained by GBIF for the Python programming language. See <a href="pygbif" class="xref page">pygbif</a>.</p> </div> </div> <div class="sect2"> <h3 id="other-programming-languages"><a class="anchor" href="#other-programming-languages"></a>Other programming languages</h3> <div class="paragraph"> <p><strong>Java</strong> clients for the APIs are maintained by GBIF and linked in the <a href="../openapi/" class="xref page">API reference documentation</a>.</p> </div> <div class="paragraph"> <p>There are also clients for <strong>Ruby</strong> (<a href="https://www.rubydoc.info/gems/gbifrb">gbifrb</a>) and <strong>PHP</strong> (<a href="https://gitlab.res-telae.cat/restelae/php-gbif">php-gbif</a>). These clients are not maintained by GBIF.</p> </div> </div> </div> </div> <div class="sect1"> <h2 id="cloud-computing-services"><a class="anchor" href="#cloud-computing-services"></a>Cloud computing services</h2> <div class="sectionbody"> <div class="paragraph"> <p>Each month, an export of GBIF occurrence data is uploaded to various cloud computing services. These services allow users to query the data, integrate it into workflows running on cloud or local systems and make more complex queries than are possible using the GBIF API. See <a href="../cloud-services/" class="xref page">Cloud computing services</a> for more information.</p> </div> </div> </div> <div class="sect1"> <h2 id="citation"><a class="anchor" href="#citation"></a>Citation</h2> <div class="sectionbody"> <div class="paragraph"> <p>Under the terms of the GBIF data user agreement, users who download data agree to cite a DOI. Please see GBIF’s <a href="https://www.gbif.org/citation-guidelines">citation guidelines</a>.</p> </div> </div> </div> <nav class="pagination"> <span class="next"><a href="download-formats">Occurrence download formats</a></span> </nav> </article> </div> </main> </div> <footer class="footer"> <div class="horizontal-stripe light-background"> <div class="footer-container"> <nav class="site-footer__menu"> <div> <a href="https://www.gbif.org/">GBIF.org</a> <a href="https://data-blog.gbif.org/">Data blog</a> <a href="https://www.gbif.org/terms">Terms and agreements</a> <a href="https://www.gbif.org/contact-us">Contact</a> </div> <div> <strong>GBIF Secretariat</strong> • Universitetsparken 15 • DK-2100 Copenhagen Ø • Denmark </div> </nav> </div> </div> <div class="horizontal-stripe"> <div class="footer-container"> <a href="https://www.gbif.org/"><img src="https://www.gbif.org/img/full_logo_white.svg" alt="GBIF"></a> </div> </div> </footer> <script id="site-script" src="../_/js/site.js" data-ui-root-path="../_"></script> <script async src="../_/js/vendor/highlight.js"></script> <script src="../_/js/vendor/lunr.js"></script> <script src="../_/js/search-ui.js" id="search-ui-script" data-site-root-path=".." data-snippet-length="100" data-stylesheet="../_/css/search.css"></script> <script async src="../search-index.js"></script> <script defer data-domain="techdocs.gbif.org" src="https://plausible.io/js/script.file-downloads.js"></script> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10