| s | p_blank | o_blank |
|---|---|---|
| /id/geography/administration/lsoa/E01012601 | http://www.w3.org/1999/02/22-rdf-syntax-ns#type | geosparql: Geometry |
| /id/geography/administration/lsoa/E01012601 | geosparql: asWKT | MULTIPOLYGON (((-2.472211567854062 53.730855075006, -2.4762090284605667 53.729303464401156, -2.475182494977257 53.72854829001432, -2.4752533868404725 53.72720264858258, -2.4754503773018666 53.72506297266297, -2.4761574286027925 53.72367579900589, -2.47779790888147 53.7241420723943, -2.4817616157602087 53.725877356588335, -2.4811680557512807 53.726683611349046, -2.4814828950254846 53.72848929244989, -2.4829985742889162 53.73024707283004, -2.481992379144114 53.730643884420864, -2.479791443981966 53.73082098782226, -2.480463065155711 53.73216936949497, -2.4797069283370594 53.73276579736026, -2.478718213816425 53.73061926060647, -2.4760946497436973 53.731100350284784, -2.4761591458690844 53.73144163766547, -2.4748780130095698 53.73208487329055, -2.4731514934415584 53.73221753141753, -2.4704192126001585 53.7332259745588, -2.4700611528470517 53.73238655336918, -2.472659224739628 53.731453284730364, -2.472211567854062 53.730855075006))) |
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>