| s | p_blank | o_blank |
|---|---|---|
| /id/statistical-geography/S02001457 | http://www.w3.org/1999/02/22-rdf-syntax-ns#type | geosparql: Geometry |
| /id/statistical-geography/S02001457 | geosparql: asWKT | POLYGON ((-2.8814853344268 56.47898953832191, -2.8854821908512065 56.478086347288674, -2.887098520690245 56.477778322980086, -2.8873002432436565 56.478073366526374, -2.888837474950772 56.47773052223291, -2.8887279066453475 56.47733541803793, -2.891798752304099 56.47674736996927, -2.901037312855643 56.475422850879866, -2.9009444527651636 56.476833457921515, -2.901423722866067 56.476962471946635, -2.9113542993392687 56.47758989011217, -2.910731986832486 56.47809309233943, -2.909596532984462 56.47802813987278, -2.9093256447262776 56.47907940560429, -2.9084280819212447 56.47913545377276, -2.9074778218119466 56.47890609535657, -2.9075686206124454 56.478552164347676, -2.905860513203492 56.47855979701312, -2.9054697100152307 56.47944048813526, -2.904034812380679 56.47931709540461, -2.9041996595939765 56.480062769075154, -2.9040768459287483 56.48104296425889, -2.903595601383016 56.481289046826326, -2.900366144645452 56.48135743130644, -2.8950721739261067 56.480632036864414, -2.894959969433467 56.4800039375941, -2.893822163264078 56.479949243709626, -2.8932485313739047 56.48041157673811, -2.8899253432197543 56.47994130041378, -2.8901106014088356 56.480919271646876, -2.8861429746688763 56.48130764112068, -2.8850158602709666 56.4816295865266, -2.8830961174039937 56.482564075490934, -2.8820084475829275 56.48227590643925, -2.881011082317109 56.48096398101645, -2.8825925227200933 56.48059122571382, -2.8814853344268 56.47898953832191)) |
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://statistics-staging.gov.scot/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://statistics-staging.gov.scot/sparql HTTP/1.1
Host: statistics-staging.gov.scot
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://statistics-staging.gov.scot/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://statistics-staging.gov.scot/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://statistics-staging.gov.scot/sparqlRequest the results as JSON, using a GET:
curl -X GET -H "Accept: application/sparql-results+json" http://statistics-staging.gov.scot/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://statistics-staging.gov.scot/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>