| s | p_blank | o_blank |
|---|---|---|
| /id/geography/administration/lsoa/E01024712 | http://www.w3.org/1999/02/22-rdf-syntax-ns#type | geosparql: Geometry |
| /id/geography/administration/lsoa/E01024712 | geosparql: asWKT | MULTIPOLYGON (((1.352820371013881 51.37985635849303, 1.3441221046655696 51.38037579416533, 1.342715907088753 51.38043877220966, 1.3427706441818206 51.38151752272008, 1.3447179348819895 51.381585599173945, 1.3450425690173515 51.38306436870372, 1.3451999385414661 51.385137756341805, 1.3461816794004127 51.385870013349674, 1.348719971415089 51.385883806924824, 1.3509495206254383 51.387062259011316, 1.3520362685901373 51.38725783375129, 1.3533602277822916 51.38713897107269, 1.356675220723269 51.38603764068513, 1.3579382187454496 51.38575386444046, 1.3578597302660234 51.38529195498776, 1.3567257957128942 51.38531547048266, 1.3558678877937895 51.38477238349437, 1.3539180335062184 51.385042944017684, 1.3513649826194436 51.384945078025, 1.3511290684137427 51.38350707370382, 1.3503739631763034 51.38325183562, 1.350458248860348 51.382627868099306, 1.3533246365686462 51.382840331558675, 1.3558257991285703 51.38175257253477, 1.3551572029151837 51.38113755487048, 1.3538794819436828 51.38110089375796, 1.3537927997864572 51.380565769446825, 1.352820371013881 51.37985635849303))) |
The most flexible way to access the data is by using SPARQL, a query language, analagous to SQL for relational databases, for retrieving and manipulating data from graph databases like ours. We support SPARQL 1.1 query syntax. Many online tutorials are available.
To submit a SPARQL query from your code, you issue an HTTP GET or POST to our endpoint:http://opendatacommunities.org/sparql, with the query itself as a url-encoded parameter called query.
For example, to run the following simple SPARQL query and get the results as JSON:
SELECT * WHERE {?s ?p ?o} LIMIT 10Issue a POST to the endpoint, with the query in the body, and an Accept header of sparql-results+json:
POST http://opendatacommunities.org/sparql HTTP/1.1
Host: opendatacommunities.org
Accept: application/sparql-results+json
Content-Type: application/x-www-form-urlencoded
query=SELECT+%2A+WHERE+%7B%3Fs+%3Fp+%3Fo%7D+LIMIT+10Issue a GET to the following URL (note the .json extension - see the formats section for more detail on this):
GET http://opendatacommunities.org/sparql.json?query=SELECT+%2A+WHERE+%7B%3Fs+%3Fp+%3Fo%7D+LIMIT+10Scroll down to the end of this page for examples of both of these methods in a few different languages.
As with other aspects of our API, to get the data in different formats, you can use either (a) a format extension or (b) an HTTP Accept header. Available result formats depend on the type of SPARQL query. There are four main forms:
SELECT queries return tabular results, and the formats available reflect this:
| Format | Extensions | Accept Headers |
|---|---|---|
| XML | .xml |
application/xml, application/sparql-results+xml |
| JSON | .json |
application/json, application/sparql-results+json |
| Text | .txt, .text | text/plain |
| CSV | .csv | text/csv |
CONSTRUCT and DESCRIBE queries return graph data, so the results are available in the same formats as our resource APIs:
| Format | Extensions | Accept Headers |
|---|---|---|
| RDF/XML | .rdf | application/rdf+xml |
| N-triples | .nt, .txt, .text | application/n-triples, text/plain |
| Turtle | .ttl | text/turtle |
| JSON-LD | .json | application/ld+json, application/json |
ASK queries return a boolean result:
| Format | Extensions | Accept Headers |
|---|---|---|
| XML | .xml | application/xml, application/sparql-results+xml |
| JSON | .json | application/json, application/sparql-results+json |
| Text | .txt, .text | text/plain |
We accept page and per_page parameters for paginating the results of SELECT queries (we automatically modify your query to apply LIMIT and OFFSET clauses). For other query types (i.e. DESCRIBE, CONSTRUCT, ASK), pagination like this doesn’t make so much sense, so these parameters are ignored.
For requests made through the website (i.e. HTML format), the page size is defaulted to 20. For requests to our sparql endpoint for data formats (i.e. non-HTML), there will be no defaults for these parameters (i.e. results are unlimited. For performance reasons we generally advise LIMITing your query if possible).
You can parameterise your SPARQL by including %{tokens} in your queries, and providing values for the tokens in the request parameters.
Note that the following tokens are reserved and cannot be used as parameters for substitution:
controlleractionpageper_pageidcommitutf8queryOur servers are configured to allow access from all domains. This means that if you’re writing JavaScript to request data from our server in to a web page hosted on another domain, your browser should check this header and allow it.
If you need to support very old browsers, you can additionally pass a callback parameter and the results will be wrapped in that function. For example:
http://opendatacommunities.org/sparql.json?callback=myCallbackFunction&query=SELECT+%2A+WHERE+%7B%3Fs+%3Fp+%3Fo%7D+LIMIT+10This help topic on the jQuery website has more details.
Here’s a couple of examples running a query using the widely available cURL command line program.
Request the results as XML, using a POST:
curl -X POST -H "Accept: application/sparql-results+xml" -d "query=SELECT%20*%20WHERE%20%7B%3Fs%20%3Fp%20%3Fo%7D%20LIMIT%2010" http://opendatacommunities.org/sparqlRequest the results as JSON, using a GET:
curl -X GET -H "Accept: application/sparql-results+json" http://opendatacommunities.org/sparql?query=SELECT%20*%20WHERE%20%7B%3Fs%20%3Fp%20%3Fo%7D%20LIMIT%2010This example HTML page uses jQuery to issue a POST to our SPARQL endpoint, requesting the results as JSON.
<!DOCTYPE html>
<html lang='en'>
<head>
<script src='http://code.jquery.com/jquery-1.9.1.min.js'></script>
</head>
<body>
<script type='text/javascript'>
var query = 'SELECT * WHERE {?s ?p ?o} LIMIT 10';
var url = 'http://opendatacommunities.org/sparql.json';
$.ajax({
method: 'POST',
dataType: 'json',
url: url,
data: {query: query},
success: function(data) {
alert('success: ' + data.results.bindings.length + ' results');
console.log(data);
}
});
</script>
</body>
</html>