Home

Data Processing Engine REST API

This is the reference document for the REST API and resources provided by Data Processing Engine (DPE).

API endpoint is located at http://data.socialhistory.org/api

request query parameters

parameter	values	description	synonyms
classification	modern or historical	switch between modern and historical classifications	hist
before	numeric	ending year, for example, 2000	y[max], yearmax
after	numeric	starting year, for example, 1500	y[min], yearmin
ctrlist	numeric with commas	list of countries with identificators, for example, 1,2,3
selected	numeric with commas	list of indicators with identificators corresponding to topic index
name	list of countries
action	geocoder	starting geocoding of countries list in specified classification
categoriesMax	numeric	maximum amount of categories to split data in datasets	catmax
q	character	search query to find countries on specific keywords	query
handle	character and numeric	handle.net of specific dataset, for example, hdl:10622/OWCFWP. Panel data can be requested with parameters like Panel['hdl:10622/QBACC4']	pid, dataset
getrange	yes	shows range for legends in chart
colors	greyscale or colorful (default)	colors selection for charts and maps
colormap	selection of colormap
logscale	log2, log10	logarithmic scales selection for charts and maps
year	numeric specific year selection
format	excel	download datasets in specific format
face	handle	dataset selection from the list of datasets to be selected as default for charts and maps
action	showyears, showvalues (default)	parameter to switch data visualization in treemaps
project	characters	project name for project pages, for example, laborconflics

Available Methods

Geofilter

http://data.sandbox.socialhistoryservices.org/api/geofilter

Returns list of all countries from geocoder

Example:

http://data.sandbox.socialhistoryservices.org/api/geofilter?after=1900&before=2013&selected=14002&classification=modern

Returns available countries from 1900 untill 2013 for indicator with ID 14002 in the modern classification

Indicators

http://data.socialhistory.org/api/indicators

Returns list of all indicators with topics

Datasets

https://data.socialhistory.org/api/datasets?handle={handle}

Returns specific indicator data with specified handle or panel,

Examples:

https://data.socialhistory.org/api/datasets?handle=Panel[%27hdl:10622/0PCZX5%27]

Data download

http://data.socialhistory.org/api/download?&pid={handle}&type[0]={classification}

Example:

http://data.socialhistory.org/api/download?&pid=hdl:10622/SO62N5&type[0]=modern

Tabular data

http://data.sandbox.socialhistoryservices.org/api/tabledata?handle={handle}&ctrlist={ctrlist}

Returns data points for selected indicators and countries in tabular form

Example:

http://data.sandbox.socialhistoryservices.org/api/tabledata?handle=hdl:10622/SO62N5&ctrlist=2,5,8,9,1512,726,1523

Data API

http://data.sandbox.socialhistoryservices.org/api/dataapi?handle={handle}&year={year}

Returns data points with colors and ranges for specified handle and year.

Example:

http://data.sandbox.socialhistoryservices.org/api/dataapi?handle=hdl:10622/DTVESW&year=2000

Dataverse API

http://data.sandbox.socialhistoryservices.org/api/dataverse?q={q}

Returns list of indicators with metadata from Dataverse

Example:

http://data.sandbox.socialhistoryservices.org/api/dataverse?q=gdp

Dataset API

http://data.sandbox.socialhistoryservices.org/api/datasets?handle={handle}

Returns original dataset in JSON form

Example:

http://data.sandbox.socialhistoryservices.org/api/datasets?handle=Panel[%27hdl:10622/0PCZX5%27]

Collabs API

http://data.socialhistory.org/api/collabs?project={projectname}

Returns all metadata and selections for specific project

Example:

http://data.socialhistory.org/api/collabs?project=laborrelations

Search API

http://dpe.sandbox.socialhistoryservices.org/api/search?q={q}

Returns all indicators with descriptions found on full text search query

Example:

http://dpe.sandbox.socialhistoryservices.org/api/search?q=gdp