For more information on how to access this asset via the Socrata Open Data API, read on. Additional information on query functionality, code samples, and libraries can be accessed using the navigation above.
Good to go! You're already using the latest version of this dataset API.
This dataset contains a list of Camden's housing stock; attributes include the property type, number of bedrooms and approximate location. Location is based on the centre point of the housing estate the property resides in; estates which contain less than twenty properties do not have a location to provide anonymity to the tenant.
All communication with the API is done through HTTPS, and errors are communicated through HTTP response codes. Available response types include JSON
(including GeoJSON
), XML
, and CSV
, which are selectable by the "extension" (.json
, etc.) on the API endpoint or through content-negotiation with HTTP Accepts
headers.
This documentation also includes inline, runable examples. Click on any link that contains a gear symbol
next to it to run that example live against the Camden residential housing stock on estates with 20 or more properties excluding leasehold properties
API. If you just want to grab the API endpoint and go, you'll find it below.
Learn more about:
All requests should include an app token that identifies your application, and each application should have its own unique app token. A limited number of requests can be made without an app token, but they are subject to much lower throttling limits than request that do include one. With an app token, your application is guaranteed access to it's own pool of requests. If you don't have an app token yet, click the button to the right to sign up for one.
Once you have an app token, you can include it with your request either by using the X-App-Token
HTTP header, or by passing it via the $$app_token
parameter on your URL.
Each column in the dataset is represented by a single field
in its SODA API. Using filters and SoQL queries, you can search for records, limit your results, and change the way the data is output. For example, you could filter this dataset by its property_reference
field using a query like the following:
For richer filtering, you can combine filters together by stacking parameters on your URL or by using SoQL queries. Learn more about about each of the fields in this dataset by clicking the headers below, or read more about the SODA API using the navigation at the top of the page.
Learn more about:
property_reference
The property_reference
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
property_type
The property_type
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
property_subtype
The property_subtype
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
bedroom_count
The bedroom_count
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
leased
The leased
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
The lease_start_date
column is of the floating_timestamp
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the floating_timestamp
datatype.
district_name
The district_name
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
estate_name
The estate_name
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
ward_name
The ward_name
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
easting
The easting
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
northing
The northing
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
longitude
The longitude
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
latitude
The latitude
column is of the number
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the number
datatype.
location
The location
column is of the point
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the point
datatype.
spatial_accuracy
The spatial_accuracy
column is of the text
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the text
datatype.
The last_uploaded
column is of the floating_timestamp
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the floating_timestamp
datatype.
organisation_uri
The organisation_uri
column is of the url
datatype.
Please wait while we fetch an example for you...
For more details on what query options you have for this column, see the detailed docs on the url
datatype.
The following are grab-and-go code code samples you can use with popular programming languages and data science tools.
jQuery makes it super simple to fetch and parse JSON from an API endpoint.
$.ajax({
url: "https://opendata.camden.gov.uk/resource/6y4s-v3ea.json",
type: "GET",
data: {
"$limit" : 5000,
"$$app_token" : "YOURAPPTOKENHERE"
}
}).done(function(data) {
alert("Retrieved " + data.length + " records from the dataset!");
console.log(data);
});
The following resources might also be helpful:
Python package using Pandas to easily work with JSON data
#!/usr/bin/env python
# make sure to install these packages before running:
# pip install pandas
# pip install sodapy
import pandas as pd
from sodapy import Socrata
# Unauthenticated client only works with public data sets. Note 'None'
# in place of application token, and no username or password:
client = Socrata("opendata.camden.gov.uk", None)
# Example authenticated client (needed for non-public datasets):
# client = Socrata(opendata.camden.gov.uk,
# MyAppToken,
# username="user@example.com",
# password="AFakePassword")
# First 2000 results, returned as JSON from API / converted to Python list of
# dictionaries by sodapy.
results = client.get("6y4s-v3ea", limit=2000)
# Convert to pandas DataFrame
results_df = pd.DataFrame.from_records(results)
The following resources might also be helpful:
PowerShell to extract data from SODA
$url = "https://opendata.camden.gov.uk/resource/6y4s-v3ea"
$apptoken = "YOURAPPTOKENHERE"
# Set header to accept JSON
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Accept","application/json")
$headers.Add("X-App-Token",$apptoken)
$results = Invoke-RestMethod -Uri $url -Method get -Headers $headers
The following resources might also be helpful:
The City of Chicago and community maintains a great RSocrata
package on Github.
## Install the required package with:
## install.packages("RSocrata")
library("RSocrata")
df <- read.socrata(
"https://opendata.camden.gov.uk/resource/6y4s-v3ea.json",
app_token = "YOURAPPTOKENHERE",
email = "user@example.com",
password = "fakepassword"
)
The following resources might also be helpful:
SAS is a tried and true application suite for data analysis and visualization. The following snippet brings Socrata data into a SAS.
filename datain url 'http://opendata.camden.gov.uk/resource/6y4s-v3ea.csv?$limit=5000&$$app_token=YOURAPPTOKENHERE';
proc import datafile=datain out=dataout dbms=csv replace;
getnames=yes;
run;
The following resources might also be helpful:
The soda-ruby
gem is a simple wrapper around the SODA APIs that makes usage with Ruby more natural.
#!/usr/bin/env ruby
require 'soda/client'
client = SODA::Client.new({:domain => "opendata.camden.gov.uk", :app_token => "YOURAPPTOKENHERE"})
results = client.get("6y4s-v3ea", :$limit => 5000)
puts "Got #{results.count} results. Dumping first results:"
results.first.each do |k, v|
puts "#{key}: #{value}"
end
The following resources might also be helpful:
SODA.NET
is a Socrata Open Data API client library for .NET
using System;
using System.Linq;
// Install the package from Nuget first:
// PM> Install-Package CSM.SodaDotNet
using SODA;
var client = new SodaClient("https://opendata.camden.gov.uk", "YOURAPPTOKENHERE");
// Get a reference to the resource itself
// The result (a Resouce object) is a generic type
// The type parameter represents the underlying rows of the resource
// and can be any JSON-serializable class
var dataset = client.GetResource("6y4s-v3ea");
// Resource objects read their own data
var rows = dataset.GetRows(limit: 5000);
Console.WriteLine("Got {0} results. Dumping first results:", rows.Count());
foreach (var keyValue in rows.First())
{
Console.WriteLine(keyValue);
}
The following resources might also be helpful:
Copy and paste the following to import this dataset into Stata
clear
. import delimited "https://opendata.camden.gov.uk/resource/6y4s-v3ea.csv?%24limit=5000&%24%24app_token=YOURAPPTOKENHERE"