CINXE.COM
<div class="data-api modal fade" tabindex="-1"> <div class="modal-dialog modal-lg api-modal"> <div class="modal-content"> <div class="modal-header"> <h3 class="modal-title"> CKAN Data API </h3> </div> <div class="modal-body"> <p> <strong>Access resource data via a web API with powerful query support</strong>. Further information in the <a href="http://docs.ckan.org/en/latest/maintaining/datastore.html" target="_blank"> main CKAN Data API and DataStore documentation. </a> </p> <div class="accordion" id="accordion2"> <div class="accordion-item"> <h2 class="accordion-heading"> <button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-endpoints" aria-expanded="true" aria-controls="collapse-endpoints"> Endpoints » </button> </h2> <div id="collapse-endpoints" class="accordion-collapse collapse show" aria-labelledby="collapse-endpoints" data-bs-parent="#accordion2"> <div class="accordion-body"> <p>The Data API can be accessed via the following actions of the CKAN action API.</p> <table class="table table-striped table-bordered"> <thead></thead> <tbody> <!-- <tr>--> <!-- <th scope="row">Create</th>--> <!-- <td><code>https://discover.data.vic.gov.au/api/3/action/datastore_create</code></td>--> <!-- </tr>--> <!-- <tr>--> <!-- <th scope="row">Update / Insert</th>--> <!-- <td><code>https://discover.data.vic.gov.au/api/3/action/datastore_upsert</code></td>--> <!-- </tr>--> <!-- <tr>--> <th scope="row">Query</th> <td><code>https://discover.data.vic.gov.au/api/3/action/datastore_search</code></td> </tr> </tbody> </table> </div> </div> </div> <div class="accordion-item"> <h2 class="accordion-heading"> <button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-querying" aria-expanded="false" aria-controls="collapse-querying"> Querying » </button> </h2> <div id="collapse-querying" class="accordion-collapse collapse show" aria-labelledby="collapse-querying" data-bs-parent="#accordion2"> <div class="accordion-body"> <strong>Query example (first 5 results)</strong> <p> <code> <a href="https://discover.data.vic.gov.au/api/3/action/datastore_search?resource_id=40738d51-857e-5742-a5da-00e7eb7b933f&limit=5" target="_blank" rel="noreferrer">https://discover.data.vic.gov.au/api/3/action/datastore_search?resource_id=40738d51-857e-5742-a5da-00e7eb7b933f&limit=5</a> </code> </p> <strong>Query example (results containing 'jones')</strong> <p> <code> <a href="https://discover.data.vic.gov.au/api/3/action/datastore_search?resource_id=40738d51-857e-5742-a5da-00e7eb7b933f&q=jones" target="_blank" rel="noreferrer">https://discover.data.vic.gov.au/api/3/action/datastore_search?resource_id=40738d51-857e-5742-a5da-00e7eb7b933f&q=jones</a> </code> </p> </div> </div> </div> <div class="accordion-item"> <h2 class="accordion-heading"> <button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-javascript" aria-expanded="false" aria-controls="collapse-javascript"> Example: Javascript » </button> </h2> <div id="collapse-javascript" class="accordion-collapse collapse show" aria-labelledby="collapse-javascript" data-bs-parent="#accordion2"> <div class="accordion-body"> <p>A simple ajax (JSONP) request to the data API using jQuery.</p> <pre> var data = { resource_id: '40738d51-857e-5742-a5da-00e7eb7b933f', // the resource id limit: 5, // get 5 results q: 'jones' // query for 'jones' }; $.ajax({ url: 'https://discover.data.vic.gov.au/api/3/action/datastore_search', data: data, dataType: 'jsonp', success: function(data) { alert('Total results found: ' + data.result.total) } }); </pre> </div> </div> </div> <div class="accordion-item"> <h2 class="accordion-heading"> <button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-python" aria-expanded="false" aria-controls="collapse-python"> Example: Python »</button> </h2> <div id="collapse-python" class="accordion-collapse collapse show" aria-labelledby="collapse-python" data-bs-parent="#accordion2"> <div class="accordion-body"> <pre> import urllib.request url = 'https://discover.data.vic.gov.au/api/3/action/datastore_search?resource_id=40738d51-857e-5742-a5da-00e7eb7b933f&limit=5&q=title:jones' fileobj = urllib.request.urlopen(url) print(fileobj.read()) </pre> </div> </div> </div> </div> </div> </div> </div> </div>