us-location-analytics
API change historyProduce location profile report for a site in the Contiguous US (48 States)
Produce location profile report
This API returns 8 download links in relation to the location profile report generated, including links to an integrated PDF report, an overview image and 6 charts. Upon request, separate links to other detailed charts included in the PDF report can be exposed and added. Detailed data sources analysed are shown in the report. Sample reports are available at https://www.propertylocation360.com
Try itRequest
Request URL
Request parameters
-
number
location latitude (e.g. 34.123456)
-
number
location longitude (e.g. -119.123456)
-
string
product type specified
-
string
usage id specified
Request headers
Request body
Responses
200 OK
Successful response
Representations
{
"latitude": 0.0,
"longitude": 0.0,
"product_type": "string",
"usage_id": "string",
"links": [
{
"report_pdf": "string",
"report_image1": "string",
"report_chart1": "string",
"report_chart2": "string",
"report_chart3": "string",
"report_chart4": "string",
"report_chart5": "string",
"report_chart6": "string"
}
]
}
{
"properties": {
"latitude": {
"type": "number",
"description": "Location latitude"
},
"longitude": {
"type": "number",
"description": "Location longitude"
},
"product_type": {
"type": "string",
"description": "Product type specified"
},
"usage_id": {
"type": "string",
"description": "Usage id specified"
},
"links": {
"type": "array",
"items": {
"properties": {
"report_pdf": {
"type": "string",
"description": "link to a pdf report"
},
"report_image1": {
"type": "string",
"description": "link to an overview image"
},
"report_chart1": {
"type": "string",
"description": "link to a chart showing elevation 2D profile"
},
"report_chart2": {
"type": "string",
"description": "link to a chart showing elevation 3D surface"
},
"report_chart3": {
"type": "string",
"description": "link to a chart showing average elevation"
},
"report_chart4": {
"type": "string",
"description": "link to a chart showing average slope"
},
"report_chart5": {
"type": "string",
"description": "link to a chart showing contours"
},
"report_chart6": {
"type": "string",
"description": "link to a chart showing flow directions"
}
}
}
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}"
-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}");
var uri = "https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}?" + 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("https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}");
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
};
$.ajax({
url: "https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}?" + $.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 = @"https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
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('https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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({
})
try:
conn = httplib.HTTPSConnection('api.bigdataearth.com')
conn.request("GET", "/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}?%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({
})
try:
conn = http.client.HTTPSConnection('api.bigdataearth.com')
conn.request("GET", "/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}?%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('https://api.bigdataearth.com/us/location-analytics/lat={lat}&lon={lon}&type={type}&uid={uid}')
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