CINXE.COM

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr" xmlns:fb="http://www.facebook.com/2008/fbml" xmlns:og="http://ogp.me/ns#"> <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# inaturalist: http://ogp.me/ns/fb/inaturalist#"> <meta http-equiv="content-type" content="text/html;charset=UTF-8" /> <meta http-equiv="Content-Language" content="en"> <title>Developers · iNaturalist </title> <link rel="shortcut icon" type="image/x-icon" href="https://static.inaturalist.org/sites/1-favicon.png?1573071870" /> <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/blueprint_bundle-84e5f7032f07459227e8dfdaefd2085aa52f78c56a0b4438c1542de31e50d7e2.css" /> <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/font-awesome-2f50fecc97d9114f8339e0a5f68490c63e2b9c94374eeee6c7685856b2d4669d.css" /> <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/application_bundle-cc50e270c3b572bfc54f10217e07454038c5d6fa963d60e9d8fc37133d394d1a.css" /> <link rel="stylesheet" media="screen" href="https://static.inaturalist.org/sites/1-stylesheet.css?1573579729" />  <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/blueprint-inat-90960428ed157d4ae5b0cdd94fabd4e264775f0c57a4524677f35fb678cf1b52.css" /> <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/blueprint-bootstrap-5e05bcf6a280bc7aff903dd078d6ce55dc72ed80ba2b63892febec5fd533e51e.css" /> <script src="https://www.inaturalist.org/assets/jquery/jquery-1.9.1.min-f8ad053fa796cfea51b2a3b04c13e09862e1459faa8967d7e3599b7cfef68f28.js"></script> <script src="https://www.inaturalist.org/assets/jquery/jquery-ui-1.9.1.min-6bd9e79734919acc66fa4b01e619ace2f1d1d543a5295ea2ce7f601105ed25be.js"></script> <script src="https://www.inaturalist.org/assets/bootstrap.min-0600e6a3f5f6fc0fa52ac2829d50e33457db95221882af5b8a04a9c3875477f8.js"></script> <script type="text/javascript"> //<![CDATA[ I18n = { } I18n.defaultLocale = "en"; I18n.locale = "en"; I18n.fallbacks = true; //]]> </script> <script type="text/javascript"> var SITE = { name: "iNaturalist", short_name: "iNat", logo_square: "https://static.inaturalist.org/sites/1-logo_square.png?1573071870" }; var PREFERRED_PLACE; var CONTROLLER_ACTION = "WikiPagesController::show"; var CONFIG = { content_freeze_enabled: false }; </script> <script src="https://www.inaturalist.org/assets/application_bundle-2297fcc3e0fe2f04ec36de03c217341360c2c27c1f3b1f41ac44bbf566f2beba.js"></script> <meta name="csrf-param" content="authenticity_token" /> <meta name="csrf-token" content="UezdrGG9EbpIPj9pUNwVnlvRJv+EkFMAgx12QeDKABFC/fJhy8T6feWIs/Cpiwlp0zHVVuVjlnoax+TtT4a7SQ==" /> <meta name="config:inaturalist_api_url" content="https://api.inaturalist.org/v1"> <meta property="og:type" content="website"/> <meta property="og:site_name" content="iNaturalist"/> <link rel="stylesheet" media="screen" href="https://www.inaturalist.org/assets/wiki-1888928ea4d34193111b67ed1866bf6d2745cdc94332762a7c84913ade0cea0c.css" /> <style> p { font-family: "Lato", sans-serif; font-size: 16px; } </style> <script src="https://maps.google.com/maps/api/js?key=AIzaSyDsHVgl1tZrI_tlyI8Rg6n6SUEvSHQjfkE&language=en&libraries=&region=&v=3.51"></script> <script src="https://www.inaturalist.org/assets/map_bundle-ba642112772e26079937af3b19bc5af0653b7206db9ca6c6e863e7fa3186f871.js"></script> <script type="text/javascript"> //<![CDATA[ $(document).ready(function() { $('#tabs, .tabs').tabs() }) //]]> </script> <meta property="og:image" content="https://static.inaturalist.org/sites/1-shareable_image.png?1573071871"/> </head> <body class="browser"> <div id="bodywrapper"> <div class="bootstrap" id="header"> <div class="navtabs" id="logonav"> <a class="logolink innertab" href="/" title="iNaturalist"> <img alt="iNaturalist" src="https://static.inaturalist.org/sites/1-logo.svg?1573071870" /> </a> </div> <div class="search navtabs form-group" id="headersearch"> <div class="searchwrapper"> <input class="form-control" placeholder="Search" tabindex="-1" type="text" /> </div> <button class="btn btn-default btn-inat btn-focus show-btn"> <i class="fa fa-search"></i> </button> <button class="btn btn-link hide-btn"> <i class="fa fa-times-circle"></i> </button> </div> <ul class="navtabs" id="mainnav"> <li class="navtab"> <a href="/observations">Explore</a> </li> <li class="navtab communitytab menutab"> <div class="dropdown"> <div aria-expanded="false" aria-haspopup="true" class="dropdown-toggle" data-toggle="dropdown" id="header-community-dropdown-toggle"> <a href="/people">Community</a> <i class="fa fa-angle-down"></i> </div> <ul aria-labelledby="header-community-dropdown-toggle" class="dropdown-menu dropdown-menu-left"> <li><a href="/people">People</a></li> <li><a href="/projects">Projects</a></li> <li><a href="/journal">Journal Posts</a></li> <li><a href="https://forum.inaturalist.org">Forum</a></li> </ul> </div> </li> <li class="navtab moretab menutab active"> <div class="dropdown"> <div aria-expanded="false" aria-haspopup="true" class="dropdown-toggle" data-toggle="dropdown" id="header-more-dropdown-toggle"> More <i class="fa fa-angle-down"></i> </div> <ul aria-labelledby="header-more-dropdown-toggle" class="dropdown-menu"> <li><a href="/taxa">Taxa Info</a></li> <li><a href="/guides">Guides</a></li> <li><a href="/places">Places</a></li> <li><a href="/stats">Site Stats</a></li> <li class="divider" role="separator"></li> <li><a href="https://help.inaturalist.org">Help</a></li> <li><a href="https://help.inaturalist.org/en/support/solutions/folders/151000552105">Getting Started</a></li> <li><a href="https://help.inaturalist.org/en/support/solutions/articles/151000176472-understanding-projects-on-inaturalist">Understanding Projects</a></li> <li><a href="https://help.inaturalist.org/en/support/solutions/articles/151000170805-inaturalist-educator-s-guide">Educator's Guide</a></li> <li><a href="https://help.inaturalist.org/en/support/solutions/folders/151000547795">Video Tutorials</a></li> <li><a href="https://www.inaturalist.org/pages/curator+guide">Curator Guide</a></li> </ul> </div> </li> </ul> <ul class="navtabs" id="usernav"> <li class="navtab signedout"> <a class="signin_link" href="/login">Log In</a> or <a class="signup_link" href="https://www.inaturalist.org/signup">Sign Up</a> </li> </ul> </div> <div id="wrapper" class="container clear"> <h2>Developers</h2> <div class="column span-6"> <ul class='leftmenu'><li><a class="active" href="/pages/developers">Developers</a></li><li><a href="/pages/api+reference">API Reference</a></li></ul> </div> <div class="last column span-18"> <p> Welcome developers! iNaturalist has a lot to offer fellow programmers interested in biodiversity, from data to software to infrastructure. </p> <h3>Open Source Software</h3> <p> Almost all of the software we write at iNaturalist is open source: </p> <ul> <li><a href="https://github.com/inaturalist/inaturalist">iNaturalist Rails app on Github</a></li> <li><a href="https://github.com/inaturalist/INaturalistIOS">iNaturalist iOS app on Github</a></li> <li><a href="https://github.com/inaturalist/iNaturalistAndroid">iNaturalist Android app on Github</a></li> </ul> <p> If you're interested in adding new functionality, please <a href="https://forum.inaturalist.org/">search the iNaturalist Forum</a> to see if someone has already requested it, and if not, start a new topic so we can talk about what you want to do and come up with a solution that meets everyone's needs. If iNat staff decides to implement it we will make the relevant Github issues. </p> <p> If you're interested in volunteering code, we have a <a href="https://github.com/inaturalist/inaturalist/blob/main/CONTRIBUTING.md">general guide to contributing</a>, and each repo should have information about getting a development environment running. Check the repo for open issues that have not been assigned. When you find one you want to work on, leave a comment so we can assign you (this helps us avoid duplicating work). </p> <p> If you're considering forking our web app code in order to build something like iNat, <a href="mailto:help@inaturalist.org">please talk to us first</a>! Forking the software is fine, but we don't want to fork our community. If you're thinking of making "iNat for Country X" or "iNat for Lepidopterists" or something, let's discuss ways that we can incorporate your needs into our existing infrastructure. We have a mechanism for localization through our international <a href="https://www.inaturalist.org/pages/network">iNaturalist Network</a>. </p> <h3>API</h3> <p> We maintain an <a href="http://api.inaturalist.org">API</a> that we use internally, but you can use it too! Check out the <a href="http://api.inaturalist.org">API reference</a> for info on how to use it. Please read our <a href="https://www.inaturalist.org/pages/api+recommended+practices">API Recommended Practices</a> for guidance on how to use our APIs without impacting the rest of iNat. </p> <h4>Rate Limits</h4> <p> We throttle API usage to a max of 100 requests per minute, though we ask that you try to keep it to 60 requests per minute or lower. If we notice usage that has serious impact on our performance we may institute blocks without notification. The API is intended to support application development, not data scraping. If you want data, see the datasets below. </p> <p> Downloading over 5 GB of media per hour or 24 GB of media per day may result in a permanent block. </p> <h3>Datasets</h3> <p> In addition to our <a href="https://www.inaturalist.org/observations/export">export tool</a>, these datasets might provide a better source of data than scraping our API. </p> <ul> <li> <p> <strong><a href="http://www.inaturalist.org/observations/gbif-observations-dwca.zip">GBIF DarwinCore Archive</a>:</strong> All the data we share with <a href="https://www.gbif.org/">GBIF</a> in <a href="https://github.com/gbif/ipt/wiki/DwCAHowToGuide">DwC-A</a> format, which is just a zip archive of CSV files. It contains records of all Research Grade observations published under a CC0, CC BY or CC BY-NC license, and links to their associated, licensed photos. It was 1.5 GB in September 2019. Updated weekly. </p> </li> <li> <p> <strong><a href="https://www.kaggle.com/c/inaturalist-challenge-at-fgvc-2017">iNaturalist Challenge at FGVC 2017</a></strong>: links to 675,000 licensed iNaturalist photos of 5,089 species for use in computer vision training. Created June 2017, not updated. </p> </li> <li> <p> <strong><a href="https://github.com/visipedia/inat_comp/tree/master/2021">iNaturalist 2021 Challenge at the FGVC8 workshop</a></strong>: links to 3.3M licensed iNaturalist photos of 10,000 species for use in computer vision training. Created March 2021, not updated. </p> </li> <li> <p> <strong><a href="https://www.inaturalist.org/taxa/inaturalist-taxonomy.dwca.zip">iNaturalist Taxonomy DarwinCore Archive</a></strong>: the entire iNat taxonomic tree and all common names. Updated monthly. </p> </li> <li> <p> <strong><a href="https://github.com/inaturalist/inaturalist-open-data">iNaturalist Licensed Observation Images in the Amazon Open Data Sponsorship Program</a></strong>: read more <a href="https://www.inaturalist.org/blog/49564-inaturalist-licensed-observation-images-in-the-amazon-open-data-sponsorship-program">here</a>. Updated monthly. </p> </li> </ul> <h3>Examples</h3> <p> Here are some projects maintained by collaborators that make use of our API: </p> <ol> <li><a href="https://github.com/synrg/dronefly">Dronefly</a> - A bot for naturalists that gives users access to iNaturalist on Discord</li> <li><a href="http://www.iseahorse.org/">iSeahorse</a></li> <li><a href="http://findapest.nz/index.html">Find-A-Pest (New Zealand)</a></li> <li><a href="https://ifieldnotes.org/">ifieldnotes.org</a></li> <li><a href="http://tatzpiteva.org.il/#/">tatzpiteva.org</a></li> </ol> </div> <div class="meta ui"> <div class="wiki_page_info"> Revised on June 3, 2024 10:23 PM by <a href="/users/1"><img alt="kueda" title="kueda" class="user_image usericon" src="https://static.inaturalist.org/attachments/users/icons/1/mini.jpg?1475527316" /></a> <a class="nickname" missing="deleted user" title="kueda" href="https://www.inaturalist.org/people/kueda">kueda</a> </div> </div> </div> <div id="modal_image_box" class="modalbox" style="display:none"></div> <div id="comment_preview" class="modalbox" style="display: none"></div> </div> <div class="bootstrap" id="footer"> <div class="container"> <div class="row"> <div class="col-xs-3 links-col"> <p> <a href="/pages/about">About</a> </p> <p> <a href="https://help.inaturalist.org">Help</a> </p> <p> <a href="https://forum.inaturalist.org">Forum</a> </p> <p> <a href="/pages/press">Press</a> </p> <p> <a href="/pages/jobs">Jobs</a> </p> <p> <a href="https://www.inaturalist.org/blog">Our Blog</a> </p> <p> <a href="/pages/community+guidelines">Community Guidelines</a> </p> <p> <a href="/pages/terms">Terms of Use</a> </p> <p> <a href="/pages/privacy">Privacy</a> </p> </div> <div class="col-xs-3 buttons-col short-text"> <div class="one-line"> <a class="btn btn-inat btn-primary btn-block btn-donate" title="DONATE" rel="nofollow" href="/donate?utm_campaign=default&utm_content=footer-button&utm_medium=web">DONATE</a> <a class="btn btn-inat btn-primary btn-block btn-donate" title="Store" href="https://store.inaturalist.org">STORE</a> </div> <div class="social-media"> <a class="social-media-link facebook" title="Facebook" href="https://www.facebook.com/inaturalist/"><img src="https://www.inaturalist.org/assets/facebook-f-logo-white-326a0af3f327083d4632b4c26aaeaecd9ec859070097069179d90a689d189c05.svg" /> </a><a class="social-media-link twitter" title="Twitter" href="https://twitter.com/inaturalist">Twitter</a> <a class="social-media-link instagram" title="Instagram" href="https://instagram.com/inaturalistorg">Instagram</a> </div> </div> <div class="col-xs-2"> <a href="https://itunes.apple.com/us/app/inaturalist/id421397028?mt=8" onclick="javascript:window.location = (window.navigator.userAgent.indexOf('Android') >= 0 ? 'https://play.google.com/store/apps/details?id=org.inaturalist.android' : 'https://itunes.apple.com/us/app/inaturalist/id421397028'); return false;"> <img alt="iNaturalist app icon" src="https://static.inaturalist.org/wiki_page_attachments/3154-medium.png" style="display:block; max-height: 95.95px; max-width: 100%; margin: 0 auto; margin-inline-end: 0px;"/> </a> </div> <div class="col-xs-2"> <a href="https://play.google.com/store/apps/details?id=org.inaturalist.android"> <img alt="Android app on Google Play" src="https://static.inaturalist.org/wiki_page_attachments/412-original.png" style="display:block; max-height: 42px; max-width: 100%; margin: 0 auto 18px;"/> </a> <a href="https://itunes.apple.com/us/app/inaturalist/id421397028?mt=8"> <img alt="iPhone app in the Apple App Store" src="https://static.inaturalist.org/wiki_page_attachments/414-original.png" style="display:block; max-height: 42px; max-width: 100%; margin: 0 auto;"/> </a> </div> <div class="col-xs-2"> <a href="https://www.inaturalist.org/pages/seek_app"> <img alt="Seek app icon" src="https://static.inaturalist.org/wiki_page_attachments/3153-medium.png" style="display:block; max-height: 95.95px; max-width: 100%; margin: 0 auto 18px; margin-inline-start: 0px"/> </a> </div> </div> </div> </div> <div class="bootstrap" id="inatnotice"> <div class="container"> <div class="row"> <div class="col-xs-12"> <div class="links inlineblock"> Member of the <a href="/sites/network">iNaturalist Network</a>   |   Powered by <a href="https://github.com/inaturalist/inaturalist" target="_new" >iNaturalist open source software</a> |   Documentation for <a href="/pages/developers">developers</a> </div> <div class="btn-group dropup pull-right" id="footer-locale-chooser"> <button aria-haspopup="aria-haspopup" class="btn btn-default dropdown-toggle" data-toggle="dropdown"> <i class="icon-ios-world"></i> English <span class="caret"></span> <span class="sr-only">Toggle Dropdown</span> </button> <ul class="dropdown-menu"> <li> <a title="Breton" rel="nofollow" href="/set_locale?locale=br">Breton</a> </li> <li> <a title="Catalan" rel="nofollow" href="/set_locale?locale=ca">Català</a> </li> <li> <a title="Danish" rel="nofollow" href="/set_locale?locale=da">Dansk</a> </li> <li> <a title="German" rel="nofollow" href="/set_locale?locale=de">Deutsch</a> </li> <li> <a title="Estonian" rel="nofollow" href="/set_locale?locale=et">Eesti</a> </li> <li> <a title="English" rel="nofollow" href="/set_locale?locale=en">English</a> </li> <li> <a title="English (UK)" rel="nofollow" href="/set_locale?locale=en-GB">English (UK)</a> </li> <li> <a title="Spanish" rel="nofollow" href="/set_locale?locale=es">Español</a> </li> <li> <a title="Spanish (Argentina)" rel="nofollow" href="/set_locale?locale=es-AR">Español (Argentina)</a> </li> <li> <a title="Spanish (Colombia)" rel="nofollow" href="/set_locale?locale=es-CO">Español (Colombia)</a> </li> <li> <a title="Spanish (Costa Rica)" rel="nofollow" href="/set_locale?locale=es-CR">Español (Costa Rica)</a> </li> <li> <a title="Spanish (Mexico)" rel="nofollow" href="/set_locale?locale=es-MX">Español (México)</a> </li> <li> <a title="Esperanto" rel="nofollow" href="/set_locale?locale=eo">Esperanto</a> </li> <li> <a title="Basque" rel="nofollow" href="/set_locale?locale=eu">Euskara</a> </li> <li> <a title="French" rel="nofollow" href="/set_locale?locale=fr">français</a> </li> <li> <a title="French (Canada)" rel="nofollow" href="/set_locale?locale=fr-CA">Français (Canada)</a> </li> <li> <a title="Galician" rel="nofollow" href="/set_locale?locale=gl">Galego</a> </li> <li> <a title="Georgian" rel="nofollow" href="/set_locale?locale=ka">Georgian</a> </li> <li> <a title="Croatian" rel="nofollow" href="/set_locale?locale=hr">Hrvatski</a> </li> <li> <a title="Indonesian" rel="nofollow" href="/set_locale?locale=id">Indonesia</a> </li> <li> <a title="Italian" rel="nofollow" href="/set_locale?locale=it">Italiano</a> </li> <li> <a title="Latvian" rel="nofollow" href="/set_locale?locale=lv">Latviešu</a> </li> <li> <a title="Lithuanian" rel="nofollow" href="/set_locale?locale=lt">Lietuvių</a> </li> <li> <a title="Luxembourgish" rel="nofollow" href="/set_locale?locale=lb">Lëtzebuergesch</a> </li> <li> <a title="Hungarian" rel="nofollow" href="/set_locale?locale=hu">magyar</a> </li> <li> <a title="Malayalam" rel="nofollow" href="/set_locale?locale=ml">Malayalam</a> </li> <li> <a title="Dutch" rel="nofollow" href="/set_locale?locale=nl">Nederlands</a> </li> <li> <a title="Norwegian Bokmål" rel="nofollow" href="/set_locale?locale=nb">Norsk Bokmål</a> </li> <li> <a title="Occitan" rel="nofollow" href="/set_locale?locale=oc">Occitan</a> </li> <li> <a title="Polish" rel="nofollow" href="/set_locale?locale=pl">Polski</a> </li> <li> <a title="Portuguese" rel="nofollow" href="/set_locale?locale=pt">Portuguese</a> </li> <li> <a title="Portuguese (Brazil)" rel="nofollow" href="/set_locale?locale=pt-BR">Português (Brasil)</a> </li> <li> <a title="Santali" rel="nofollow" href="/set_locale?locale=sat">Santali</a> </li> <li> <a title="Albanian" rel="nofollow" href="/set_locale?locale=sq">Shqip</a> </li> <li> <a title="Slovak" rel="nofollow" href="/set_locale?locale=sk">Slovenský</a> </li> <li> <a title="Slovenian" rel="nofollow" href="/set_locale?locale=sl">Slovenščina</a> </li> <li> <a title="Serbian" rel="nofollow" href="/set_locale?locale=sr">srpski</a> </li> <li> <a title="Finnish" rel="nofollow" href="/set_locale?locale=fi">suomi</a> </li> <li> <a title="Swedish" rel="nofollow" href="/set_locale?locale=sv">Svenska</a> </li> <li> <a title="Tamil" rel="nofollow" href="/set_locale?locale=ta">Tamil</a> </li> <li> <a title="Maori" rel="nofollow" href="/set_locale?locale=mi">Te reo Māori</a> </li> <li> <a title="Turkish" rel="nofollow" href="/set_locale?locale=tr">Türkçe</a> </li> <li> <a title="Czech" rel="nofollow" href="/set_locale?locale=cs">česky</a> </li> <li> <a title="Greek" rel="nofollow" href="/set_locale?locale=el">Ελληνικά</a> </li> <li> <a title="Belarusian" rel="nofollow" href="/set_locale?locale=be">Беларуская</a> </li> <li> <a title="Bulgarian" rel="nofollow" href="/set_locale?locale=bg">български</a> </li> <li> <a title="Macedonian" rel="nofollow" href="/set_locale?locale=mk">македонски</a> </li> <li> <a title="Russian" rel="nofollow" href="/set_locale?locale=ru">Русский</a> </li> <li> <a title="Ukrainian" rel="nofollow" href="/set_locale?locale=uk">Українська</a> </li> <li> <a title="Kazakh" rel="nofollow" href="/set_locale?locale=kk">Қазақша</a> </li> <li> <a title="Hebrew" rel="nofollow" href="/set_locale?locale=he">עברית</a> </li> <li> <a title="Arabic" rel="nofollow" href="/set_locale?locale=ar">العربية</a> </li> <li> <a title="Marathi" rel="nofollow" href="/set_locale?locale=mr">मराठी</a> </li> <li> <a title="Kannada" rel="nofollow" href="/set_locale?locale=kn">ಕನ್ನಡ</a> </li> <li> <a title="Thai" rel="nofollow" href="/set_locale?locale=th">ภาษาไทย</a> </li> <li> <a title="Japanese" rel="nofollow" href="/set_locale?locale=ja">日本語</a> </li> <li> <a title="Chinese (simplified)" rel="nofollow" href="/set_locale?locale=zh-CN">简体中文</a> </li> <li> <a title="Chinese (traditional)" rel="nofollow" href="/set_locale?locale=zh-TW">繁體中文</a> </li> <li> <a title="Korean" rel="nofollow" href="/set_locale?locale=ko">한국어</a> </li> <li class="divider" role="separator"></li> <li><a href="/pages/translate">Help Translate!</a></li> </ul> </div> </div> </div> </div> </div> <div id="inat-universal-autocomplete"></div> <script type="text/javascript"> if (typeof(ga) != 'undefined') { ga('set', 'dimension1', 'false'); } </script> <script src="https://www.inaturalist.org/assets/webpack/runtime-webpack-e267e3263c99512b499bca91059e0e18e90c99a2b0b4e771071404c40ef9be45.js"></script> <script src="https://www.inaturalist.org/assets/webpack/react-main-webpack-e06cb5c9b9bd5c7b868f65f6e2da3f24cdfe45a062e570d9321954d281be3035.js"></script> <script src="https://www.inaturalist.org/assets/webpack/users-confirmation-banner-webpack-43fa966ee3a921b33d73a50a968485effb5f1ef164e1937d2d1e5a71b0652b3c.js"></script> </body> </html>