All API requests must have a HTTP header with one of your API keys enabled for the intended operation (SPARQL access or API access).
You can manage your API keys from the dedicated panel, in your account: create as many keys as you want, and grant them the proper access for each.
To programmatically perform your queries on the SPARQL endpoint, send a GET request to https://query.semantic.builders/sparql adding the header api-key with a key enabled for "Access to SPARQL endpoint".
Here you find a few samples, in different languages:
class SPARQLQueryDispatcher {
constructor( endpoint ) {
this.endpoint = endpoint;
}
query( sparqlQuery ) {
const fullUrl = this.endpoint + '?query=' + encodeURIComponent( sparqlQuery );
const headers = {
'api-key': 'YOUR_API_KEY',
'Accept': 'application/sparql-results+json',
};
return fetch( fullUrl, { headers } ).then( body => body.json() );
}
}
const endpointUrl = 'https://query.semantic.builders/sparql';
const sparqlQuery = YOUR_SPARQL_QUERY;
const queryDispatcher = new SPARQLQueryDispatcher( endpointUrl );
queryDispatcher.query( sparqlQuery ).then( console.log );
<?php
// composer require easyrdf/easyrdf
// https://www.easyrdf.org/
class SPARQLQueryDispatcher extends \EasyRdf\Sparql\Client
{
private $endpointUrl;
public function __construct(string $endpointUrl, string $apiKey)
{
parent::__construct($endpointUrl);
$client = \EasyRdf\Http::getDefaultHttpClient();
$this->setHeaders($client, 'api-key', $apiKey);
}
}
$endpointUrl = 'https://query.semantic.builders/sparql';
$sparqlQueryString = YOUR_SPARQL_QUERY;
$apiKey = 'YOUR_API_KEY';
$queryDispatcher = new SPARQLQueryDispatcher($endpointUrl, $apiKey);
$queryResult = $queryDispatcher->query($sparqlQueryString);
var_export($queryResult);
use LWP::UserAgent;
use Data::Dumper;
use JSON::XS;
sub wdSparqlQuery(@args) {
my $query = shift;
my $key = shift;
my $format = shift;
my $endpointURL = "https://query.semantic.builders/sparql";
my $queryURL = "${endpointURL}?query=${query}&format=${format}";
my $ua = LWP::UserAgent -> new;
my $req = HTTP::Request -> new(
GET => $queryURL,
HTTP::Headers->new('api-key' => $key),
);
my $res = $ua -> request($req);
my $str = $res -> content;
return $str;
}
$query = "YOUR_SPARQL_QUERY";
$key = "YOUR_API_KEY";
$format = "json";
$data = JSON::XS::decode_json(wdSparqlQuery($query, $key, $format));
print "Retrieved data:\n";
print Dumper($data);
# pip install sparqlwrapper
# https://rdflib.github.io/sparqlwrapper/
import sys
from SPARQLWrapper import SPARQLWrapper, JSON
endpoint_url = "https://query.semantic.builders/sparql"
query = "YOUR_SPARQL_QUERY"
apikey = "YOUR_API_KEY"
def get_results(endpoint_url, query):
sparql = SPARQLWrapper(endpoint_url)
sparql.addCustomHttpHeader('api-key', apikey)
sparql.setQuery(query)
sparql.setReturnFormat(JSON)
return sparql.query().convert()
results = get_results(endpoint_url, query)
for result in results["results"]["bindings"]:
print(result)
#gem install sparql
#http://www.rubydoc.info/github/ruby-rdf/sparql/frames
require 'sparql/client'
endpoint = "https://query.semantic.builders/sparql"
sparql = YOUR_SPARQL_QUERY
client = SPARQL::Client.new(endpoint,
:method => :get,
headers: {'api-key' => 'YOUR_API_KEY'})
rows = client.query(sparql)
puts "Number of rows: #{rows.size}"
for row in rows
for key,val in row do
# print "#{key.to_s.ljust(10)}: #{val}\t"
print "#{key}: #{val}\t"
end
print "\n"
end
Semantic Builders exposed a simple API to access your Saved Queries and Extractions.
All requests must have a X-SB-Key header with a key enabled for "Access to API".
Available endpoints:
GET https://semantic.builders/api/saved
To access the list of your saved queries. This returns a JSON array, containing a JSON object for each query.
[
{
"id": "ef7d45c0-a13a-4795-9503-64521a5b6f5d",
"title": "My Saved Query",
"access": "private",
"created_at": "2022-12-24T13:29:24",
"size": 1463071
},
{
"id": "6d8dbba4-22b0-47c0-89df-b479c287ad1f",
"title": "My Other Saved Query",
"access": "private",
"created_at": "2022-12-20T12:23:24",
"size": 4014811
}
]Each saved query is described by:
Error codes:
GET https://semantic.builders/api/saved/ID
To access the actual contents of a given saved query, identified by the id (provided by the listing endpoint).
Contents are returned in standard SPARQL Query Results JSON.
{
"head": {
"vars": ["item", "itemLabel"]
},
"results": {
"bindings": [
{
"item": {
"type": "uri",
"value": "http://www.wikidata.org/entity/Q378619"
},
"itemLabel": {
"xml:lang": "en",
"type": "literal",
"value": "CC"
}
},
{
"item": {
"type": "uri",
"value": "http://www.wikidata.org/entity/Q498787"
},
"itemLabel": {
"xml:lang": "en",
"type": "literal",
"value": "Muezza"
}
}
]
}
}Error codes:
GET https://semantic.builders/api/extracts
To access the list of your extractions. This returns a JSON array, containing a JSON object for each query.
[
{
"id": "b2454d94-a44e-403d-aa38-ee21512d7db6",
"title": "My Extraction",
"created_at": "2022-12-24T13:29:24",
"size": 3991013
},
{
"id": "5353ad62-dfb9-4721-826a-01cc51710287",
"title": "My Other Extraction",
"created_at": "2022-12-20T12:23:24",
"size": 2712268
}
]Each extraction is described by:
Error codes:
GET https://semantic.builders/api/extracts/ID
To access the actual contents of a given extraction, identified by the id (provided by the listing endpoint).
Contents are returned in CSV.
Q1868,"Paul Otlet",+1868-08-23T00:00:00Z,+1944-12-10T00:00:00Z
Q23,"George Washington",+1732-02-22T00:00:00Z,+1799-12-14T00:00:00Z
Q42,"Douglas Adams",+1952-03-11T00:00:00Z,+2001-05-11T00:00:00Z
Q368,"Augusto Pinochet",+1915-11-25T00:00:00Z,+2006-12-10T00:00:00ZError codes: