CINXE.COM

<!doctype html> <html> <head> <title>Develop – BookBrainz</title> <link rel='stylesheet' href='/stylesheets/bundle.css' /> <link rel='stylesheet' href='/stylesheets/style.css' /> <meta charset='utf-8'> <meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'> <link rel='apple-touch-icon' sizes='57x57' href='/images/icons/apple-touch-icon-57x57.png'/> <link rel='apple-touch-icon' sizes='60x60' href='/images/icons/apple-touch-icon-60x60.png'/> <link rel='apple-touch-icon' sizes='72x72' href='/images/icons/apple-touch-icon-72x72.png'/> <link rel='apple-touch-icon' sizes='76x76' href='/images/icons/apple-touch-icon-76x76.png'/> <link rel='apple-touch-icon' sizes='114x114' href='/images/icons/apple-touch-icon-114x114.png'/> <link rel='apple-touch-icon' sizes='120x120' href='/images/icons/apple-touch-icon-120x120.png'/> <link rel='apple-touch-icon' sizes='144x144' href='/images/icons/apple-touch-icon-144x144.png'/> <link rel='apple-touch-icon' sizes='152x152' href='/images/icons/apple-touch-icon-152x152.png'/> <link rel='apple-touch-icon' sizes='180x180' href='/images/icons/apple-touch-icon-180x180.png'/> <link rel='icon' type='image/png' href='/images/icons/favicon-32x32.png' sizes='32x32'/> <link rel='icon' type='image/png' href='/images/icons/android-chrome-192x192.png' sizes='192x192'/> <link rel='icon' type='image/png' href='/images/icons/favicon-96x96.png' sizes='96x96'/> <link rel='icon' type='image/png' href='/images/icons/favicon-16x16.png' sizes='16x16'/> <link rel='manifest' href='/manifest.json'/> <meta name='apple-mobile-web-app-title' content='BookBrainz'/> <meta name='application-name' content='BookBrainz'/> <meta name='msapplication-TileColor' content='#da532c'/> <meta name='msapplication-TileImage' content='/images/icons/mstile-144x144.png'/> <meta name='theme-color' content='#754e37'/> </head> <body> <div id='target'><div data-reactroot=""><a class="sr-only sr-only-focusable" href="#content">Skip to main content</a><nav role="navigation" class="BookBrainz navbar navbar-expand-lg navbar-light fixed-top"><span class="logo navbar-brand"><a href="/"><img alt="BookBrainz icon" src="/images/BookBrainz_logo_mini.svg" title="BookBrainz"/></a></span><button type="button" aria-label="Toggle navigation" class="navbar-toggler collapsed"><span class="navbar-toggler-icon"></span></button><div class="navbar-collapse collapse" id="bs-example-navbar-collapse-1"><form action="/search" role="search" class="ml-auto mr-3 form-inline"><div class="input-group"><input type="text" required="" name="q" placeholder="Search for..." class="form-control"/><div class="input-group-append"><button type="submit" class="btn btn-success"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="magnifying-glass" class="svg-inline--fa fa-magnifying-glass " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352a144 144 0 1 0 0-288 144 144 0 1 0 0 288z"></path></svg></button></div></div></form><div class="navbar-nav"><div class="nav-item"><a href="/revisions" data-rb-event-key="/revisions" class="nav-link"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="list-ul" class="svg-inline--fa fa-list-ul " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M64 144a48 48 0 1 0 0-96 48 48 0 1 0 0 96zM192 64c-17.7 0-32 14.3-32 32s14.3 32 32 32H480c17.7 0 32-14.3 32-32s-14.3-32-32-32H192zm0 160c-17.7 0-32 14.3-32 32s14.3 32 32 32H480c17.7 0 32-14.3 32-32s-14.3-32-32-32H192zm0 160c-17.7 0-32 14.3-32 32s14.3 32 32 32H480c17.7 0 32-14.3 32-32s-14.3-32-32-32H192zM64 464a48 48 0 1 0 0-96 48 48 0 1 0 0 96zm48-208a48 48 0 1 0 -96 0 48 48 0 1 0 96 0z"></path></svg> Revisions </a></div></div><div class="navbar-nav"><div class="nav-item"><a href="/collections" data-rb-event-key="/collections" class="nav-link"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="grip-vertical" class="svg-inline--fa fa-grip-vertical " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><path fill="currentColor" d="M40 352l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-48c0-22.1 17.9-40 40-40zm192 0l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-48c0-22.1 17.9-40 40-40zM40 320c-22.1 0-40-17.9-40-40l0-48c0-22.1 17.9-40 40-40l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0zM232 192l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-48c0-22.1 17.9-40 40-40zM40 160c-22.1 0-40-17.9-40-40L0 72C0 49.9 17.9 32 40 32l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0zM232 32l48 0c22.1 0 40 17.9 40 40l0 48c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-48c0-22.1 17.9-40 40-40z"></path></svg> Collections </a></div></div><div class="navbar-nav"><div class="nav-item"><a href="/statistics" data-rb-event-key="/statistics" class="nav-link"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="chart-line" class="svg-inline--fa fa-chart-line " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M64 64c0-17.7-14.3-32-32-32S0 46.3 0 64V400c0 44.2 35.8 80 80 80H480c17.7 0 32-14.3 32-32s-14.3-32-32-32H80c-8.8 0-16-7.2-16-16V64zm406.6 86.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L320 210.7l-57.4-57.4c-12.5-12.5-32.8-12.5-45.3 0l-112 112c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L240 221.3l57.4 57.4c12.5 12.5 32.8 12.5 45.3 0l128-128z"></path></svg> Statistics </a></div></div><div class="navbar-nav"><div class="nav-item dropdown"><a aria-haspopup="true" aria-expanded="false" id="docs-dropdown" href="#" class="dropdown-toggle nav-link" role="button"><span><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="file-lines" class="svg-inline--fa fa-file-lines " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path fill="currentColor" d="M64 0C28.7 0 0 28.7 0 64V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V160H256c-17.7 0-32-14.3-32-32V0H64zM256 0V128H384L256 0zM112 256H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16zm0 64H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16zm0 64H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg> Docs</span></a></div></div><div class="navbar-nav"><div class="nav-item"><a href="/auth" data-rb-event-key="/auth" class="nav-link"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="right-to-bracket" class="svg-inline--fa fa-right-to-bracket " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M217.9 105.9L340.7 228.7c7.2 7.2 11.3 17.1 11.3 27.3s-4.1 20.1-11.3 27.3L217.9 406.1c-6.4 6.4-15 9.9-24 9.9c-18.7 0-33.9-15.2-33.9-33.9l0-62.1L32 320c-17.7 0-32-14.3-32-32l0-64c0-17.7 14.3-32 32-32l128 0 0-62.1c0-18.7 15.2-33.9 33.9-33.9c9 0 17.6 3.6 24 9.9zM352 416l64 0c17.7 0 32-14.3 32-32l0-256c0-17.7-14.3-32-32-32l-64 0c-17.7 0-32-14.3-32-32s14.3-32 32-32l64 0c53 0 96 43 96 96l0 256c0 53-43 96-96 96l-64 0c-17.7 0-32-14.3-32-32s14.3-32 32-32z"></path></svg> Sign In / Register</a></div></div></div></nav><div class="container" id="content"><div><div class="page-header"><h1>Developing with BookBrainz</h1></div><p class="lead">We aim to make it as easy as possible to use the data stored in BookBrainz. If you’re a developer wanting to make programs that depend on BookBrainz, we have a web service available, and are releasing database dumps regularly.</p><h2>Web Service / API</h2><p>The web service is the primary way of getting BookBrainz data. The key advantage of using the web service over the dumps is that you don’t need to install any database engine — you can access the data through the internet. The web service is currently in alpha version and a <a href="https://api.test.bookbrainz.org/1/docs/">live documentation is served at this address</a>.</p><h2>Database Dumps</h2><p>The database dumps will be useful if you need to process a lot of data quickly — in cases where the web service is not able to respond quickly enough. The latest database dump can be found <a href="ftp://ftp.musicbrainz.org/pub/musicbrainz/bookbrainz/latest.sql.bz2">at this address</a>. A dump is made every week.</p><h2>Source Code</h2><p>BookBrainz runs on open source software. If you wish to access the source and contribute to the project, please see <a href="https://github.com/metabrainz/bookbrainz-site">our github page</a>.</p></div></div><footer class="footer"><div class="container-fluid"><div class="row"><div class="col-4"><small>Tested with <a href="https://www.browserstack.com/" rel="noopener noreferrer" target="_blank"><img alt="BrowserStack Logo" height="25" src="/images/BrowserStack.png"/></a></small></div><div class="text-center col-4"><small>Cover image by <a href="https://commons.wikimedia.org/wiki/File:Bookshelf.jpg">Stewart Butterfield</a> (<a href="https://creativecommons.org/licenses/by/2.0/deed.en">CC-BY-2.0</a>)</small></div><div class="text-right col-4"><div class="small"><a href="/admin-logs">Admin Logs</a></div><div class="small"><a href="/privacy">Privacy & Terms</a></div></div></div><div class="row"><div class="text-center col-12"><small>Alpha Software — <a href="https://github.com/metabrainz/bookbrainz-site/tree/v-2024-08-20.0">v-2024-08-20.0</a> — <a href="https://tickets.metabrainz.org/projects/BB/issues/">Report a Bug</a></small></div></div></div></footer></div></div> <script src='/js/bundle.js'></script> <script id='page' type='application/json'>Develop</script> <script id='props' type='application/json'> {"siteRevision":"v-2024-08-20.0","repositoryUrl":"https://github.com/metabrainz/bookbrainz-site/","alerts":[],"user":null}</script> <script src='/js/index.js'></script> </body> </html>