API user guide | Queensland Government

<!DOCTYPE html> <html lang="en-AU"> <head> <title>API user guide | Queensland Government</title>  <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="apple-mobile-web-app-capable" content="yes">  <meta name="dcterms.title" content="API user guide"> <meta name="dcterms.creator" content="Open Data"> <meta name="dcterms.created" content="2021-11-19T12:51:48+10:00"> <meta name="dcterms.modified" content="2021-12-09T15:00:49+10:00"> <meta name="dcterms.issued" content="2021-12-09T15:00:48+10:00"> <meta name="dcterms.format" content="HTML"> <meta name="dcterms.identifier" content="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide">     <meta name="description" content="A set of guides and examples for using the data.qld.gov.au CKAN API." /> <meta name="keywords" content="" /> <meta name="DCTERMS.subject" content="" /> <meta name="DCTERMS.audience" content="all" scheme="AGLSTERMS.agls-audience" /> <meta name="DCTERMS.license" scheme="DCTERMS.URI" content="https://creativecommons.org/licenses/by/4.0/">  <link href="//fonts.googleapis.com/css?family=Lato:100,300,400,700,900,100italic,300italic,400italic,700italic,900italic" rel="stylesheet" type="text/css" />  <link rel="shortcut icon" href="https://www.qld.gov.au/favicon.ico"> <link rel="apple-touch-icon" sizes="180x180" href="https://www.qld.gov.au/favicon.ico"> <link rel="icon" type="image/png" sizes="32x32" href="https://www.qld.gov.au/favicon.ico"> <link rel="icon" type="image/png" sizes="16x16" href="https://www.qld.gov.au/favicon.ico">  <link rel="stylesheet" href="https://www.data.qld.gov.au/__data/assets/css_file_folder/0019/103492/open-data-plugins.min.css?v=0.1.19" /> <link href="/assets/css/main" rel="stylesheet" type="text/css" />  <link rel="stylesheet" type="text/css" href="/assets/css/data-qld">  <script>document.getElementsByTagName('html')[0].className += ' js';</script> <script type="text/javascript" src="/assets/js/jquery"></script>  <link href="https://www.data.qld.gov.au/__data/assets/git_bridge/0019/100846/open-data/dist/qld.css?h=d35263a" rel="stylesheet" /> </head> <body id="qld-gov-au" class="">  <noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-PJBVFG" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <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-PJBVFG');</script>  <div class="page-wrapper">  <div id="qg-access" role="navigation" aria-labelledby="landmark-label"> <h2 id="landmark-label" tabindex="0">Skip links and keyboard navigation</h2> <ul> <li><a href="#content">Skip to content</a></li> <li id="access-instructions"><a href="https://www.qld.gov.au/help/keyboard#section-aria-keyboard-navigation">Use tab and cursor keys to move around the page (more information)</a></li> </ul> </div>         <div class="account-masthead"> </div> <header class="navbar navbar-static-top masthead"> <div class="container"> <button data-target="#main-navigation-toggle" data-toggle="collapse" class="btn btn-navbar navbar-toggle collapsed" type="button"> <span class="fa fa-bars"></span> <span class="sr-only">Open/Close Mobile Menu</span> </button> <hgroup class="header-image pull-left"> <a class="logo" href="https://www.qld.gov.au" title="Link to Queensland Gov website"> <img src="https://www.data.qld.gov.au/__data/assets/file/0014/100832/qld-gov-open-data-logo.svg" height="37px" alt="Queensland Government" /> </a> <div class="header__data-portal"> <a href="/">Open Data Portal</a> </div> </hgroup> <div class="navbar-collapse collapse" id="main-navigation-toggle"> <nav class="section navigation"> <ul class="nav nav-pills"><li><a href="/dataset">Data</a></li> <li ><a href="/visualisations">Visualisations</a></li> <li ><a href="/news-and-case-studies">News and Case Studies</a></li> <li ><a href="/article/standards-and-guidance">Standards and guidance</a></li> <li ><a href="/article/contact">Contact</a></li></ul> </nav> <form class="section site-search simple-input" action="/dataset" method="get" autocomplete="off"> <div class="field"> <input id="field-sitewide-search" type="text" name="q" placeholder="Search" aria-label="Search"> <button class="btn-search" type="submit"> <i class="fa fa-search"></i> <span class="sr-only">Submit site search</span> </button> </div> </form> </div> </div> </header>  <div role="main"> <div id="content" class="container"> <div class="toolbar"> <ol class="breadcrumb"> <li class="home"> <a href="https://www.data.qld.gov.au"><i class="fa fa-home"></i><span> Home</span></a> </li> <li > <a href="https://www.data.qld.gov.au/article/standards-and-guidance">Standards and guidance</a> </li><li > <a href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards">Publishing and portal user guides </a> </li><li class="active"> <a class="active" href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide">API user guide</a> </li> </ol> </div> <div class="row wrapper"> <div class="primary col-sm-9 col-xs-12"> <article class="module"> <div class="module-content"> <h1>API user guide</h1> <div class="list-block"> <div class="list-block__item"> <div class="list-block__img" style="background-image: url('https://www.data.qld.gov.au/__data/assets/image/0013/226111/ckan_logo.png');"></div> <div class="list-block__content"> <div class="list-block__title"> <a href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide/ckan-api-guide">CKAN API guide</a> </div> <div class="list-block__summary"> <p>The latest version of the official CKAN API guide.</p> </div> <div class="list-block__link"> <a href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide/ckan-api-guide">Read more</a> </div> </div> </div><div class="list-block__item"> <div class="list-block__img" style="background-image: url('https://www.data.qld.gov.au/__data/assets/image/0020/226118/API_pic.PNG');"></div> <div class="list-block__content"> <div class="list-block__title"> <a href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide/data.qld.gov.au-api-customisation">data.qld.gov.au API customisation</a> </div> <div class="list-block__summary"> <p>Information about API customisations used on data.qld.gov.au.</p> </div> <div class="list-block__link"> <a href="https://www.data.qld.gov.au/article/standards-and-guidance/publishing-guides-standards/api-user-guide/data.qld.gov.au-api-customisation">Read more</a> </div> </div> </div> </div> </div> </article> </div> <div class="secondary col-sm-3"> <div class="sub-nav"> <ul> <li><a href="/dataset">Data</a></li> <li ><a href="/visualisations">Visualisations</a></li> <li ><a href="/news-and-case-studies">News and Case Studies</a></li> <li ><a href="/article/standards-and-guidance">Standards and guidance</a></li> <li ><a href="/article/contact">Contact</a></li> </ul> </div> </div> </div> </div> </div>  <footer class="site-footer"> <div class="container"> <ul> <li><a href="https://www.qld.gov.au/contact-us" class="no-print">Contact us</a></li> <li class="mobile-hidden"><a href="https://www.qld.gov.au/help" class="no-print">Help</a></li> <li><a href="https://www.qld.gov.au/legal/copyright">Copyright</a></li> <li><a href="https://www.qld.gov.au/legal/disclaimer">Disclaimer</a></li> <li><a href="https://www.qld.gov.au/legal/privacy">Privacy</a></li> <li><a href="https://www.qld.gov.au/about/rights-accountability/right-to-information">Right to information</a></li> <li class="mobile-hidden"><a href="https://www.qld.gov.au/help/accessibility" class="no-print">Accessibility</a></li> <li class="mobile-hidden"><a href="http://www.smartjobs.qld.gov.au/" class="no-print">Jobs in Queensland Government</a></li> <li id="link-languages"><a href="https://www.qld.gov.au/help/languages" class="no-print">Other languages</a></li> </ul> <div class="site-footer__copyright"> <p>© The State of Queensland 1995-2024</p> </div> <div class="site-footer__signoff"> <p><a href="https://www.qld.gov.au">Queensland Government</a></p> </div> </div> </footer> <div class="footer-scripts">  <script src="https://www.data.qld.gov.au/__data/assets/js_file_folder/0018/100890/open-data-plugins.min.js?v=0.2.9"></script> <script src="https://www.data.qld.gov.au/__data/assets/git_bridge/0019/100846/open-data/dist/js/runtime.js?h=d35263a"></script> <script src="https://www.data.qld.gov.au/__data/assets/git_bridge/0019/100846/open-data/dist/js/main.js?h=d35263a"></script> </div>  </div> </body> </html>

CINXE.COM

API user guide | Queensland Government