AskCHIS Neighborhood Edition
API change historyThe AskCHIS Neighborhood Edition (AskCHIS NE) API provides access to all of the estimates available in the AskCHIS NE dashboard (http://askchisne.ucla.edu). The API can be used for both web development and research and makes it easy for users to build custom queries and extract estimates. Health indicators in AskCHIS NE are created using a sophisticated modeling technique called Small Area Estimation (SAE). For more information on data provenance, please visit the help section in AskCHIS NE.
Pool Data by Geo IDs
Will pool data from different locations and return it as a single dataset. The geographic IDs must be of the same type (e.g. all cities, all counties or all zip codes)
Note: This operation is not available for the Free product. You must upgrade in order to do pooling.
Try itRequest
Request URL
Request parameters
-
string
Indicator name
-
string
Can be any GeoId that represents a geographic entity.
To query for more than one GeoId, provide a comma-separated list (e.g. geoids=666000,644000,92037,92117).
GeoIds must belong to locations with the same geoType (all 'CITIES' or all 'COUNTIES' for example) or a '400 - Bad Request' message will be returned.
-
(optional)string
Can be any of the following (case-sensitive): population, estimate, SE, CI_LB95, CI_UB95, CV, MSE
To query for more than one attribute, provide a comma-separated list (e.g. attributes=population,estimate
-
(optional)number
Desired dataset year
Request headers
Request body
Responses
200 OK
Representations
[
{
"name": "HEARTDA",
"description": "Adult respondents ages 18+ who were ever diagnosed with heart disease by a doctor.",
"category": "Health Topic",
"subcategory": "Heart disease",
"attributeTypes": [
"estimate",
"CI_LB95",
"CI_UB95",
"population",
"indicator_type"
],
"attributeLabels": [
"Heart disease",
"95% Confidence Interval (C.I.) - lower boundary",
"95% Confidence Interval (C.I.) - higher boundary",
"Estimated Population",
""
],
"geographies": [
{
"geoId": "620802,644000",
"geoName": "East Los Angeles,Los Angeles",
"geoTypeId": "CITIES",
"attributes": [
"0.056",
"0.051",
"0.062",
"2992300",
"1"
],
"isSuppressed": false,
"suppressionReason": null
}
]
}
]
400 Bad Request
Code samples
@ECHO OFF
curl -v -X GET "http://askchisne.azure-api.net/api/variablepool/{name}?geoIds={string}&attributes={string}&year={number}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["geoIds"] = "{string}";
queryString["attributes"] = "{string}";
queryString["year"] = "{number}";
var uri = "http://askchisne.azure-api.net/api/variablepool/{name}?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("http://askchisne.azure-api.net/api/variablepool/{name}");
builder.setParameter("geoIds", "{string}");
builder.setParameter("attributes", "{string}");
builder.setParameter("year", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"geoIds": "{string}",
"attributes": "{string}",
"year": "{number}",
};
$.ajax({
url: "http://askchisne.azure-api.net/api/variablepool/{name}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"http://askchisne.azure-api.net/api/variablepool/{name}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"geoIds={string}",
@"attributes={string}",
@"year={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('http://askchisne.azure-api.net/api/variablepool/{name}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'geoIds' => '{string}',
'attributes' => '{string}',
'year' => '{number}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'geoIds': '{string}',
'attributes': '{string}',
'year': '{number}',
})
try:
conn = httplib.HTTPConnection('askchisne.azure-api.net')
conn.request("GET", "/api/variablepool/{name}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'geoIds': '{string}',
'attributes': '{string}',
'year': '{number}',
})
try:
conn = http.client.HTTPConnection('askchisne.azure-api.net')
conn.request("GET", "/api/variablepool/{name}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('http://askchisne.azure-api.net/api/variablepool/{name}')
query = URI.encode_www_form({
# Request parameters
'geoIds' => '{string}',
'attributes' => '{string}',
'year' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body