We build software to make data useful to more people in the ways that are most useful to them.
Application
Programming
Interface
Programming
Interface
Common Language
A consistent way for two software systems to communicate.Stable Platform
A guarantee that the language will not change without notice.Contract
An API is a contract between a provider and a consumer.Open data is messy
C00000042|ILLINOIS TOOL WORKS FOR BETTER GOVERNMENT COMMITTEE|Michael J. Lynch|3600 W. Lake Avenue||Glenview|IL|60025|U|Q||Q|C|ILLINOIS TOOL WORKS INC|
C00000059|HALLMARK CARDS PAC|Swarens, Greg|2501 McGee|MD #288|Kansas City|MO|64108|U|Q|UNK|M|C|HALLMARK CARDS INCORPORATED|
C00000422|AMERICAN MEDICAL ASSOCIATION POLITICAL ACTION COMMITTEE|WALKER, KEVIN|25 MASSACHUSETTS AVENUE NW|SUITE 600|WASHINGTON|DC|20001|U|Q||M|M|AMERICAN MEDICAL ASSOCIATION|
C00000489|D R I V E POLITICAL FUND, CHAPTER 886|RON COBB|3528 WEST RENO||OKLAHOMA CITY|OK|73107|U|Q||Q|L|TEAMSTERS LOCAL UNION 886|
C00000547|KANSAS MEDICAL SOCIETY POLITICAL ACTION COMMITTEE|C. RICHARD BONEBRAKE, M.D.|623 SW 10TH AVE||TOPEKA|KS|66612|U|Q|UNK|Q|T|MEDICAL ASS'N; KANSAS [AMPAC]|
C00000638|INDIANA STATE MEDICAL ASSOCIATION POLITICAL ACTION COMMITTEE|Kora, M.D., Vidya|322 Canal Walk, Canal Level|.|Indianapolis|IN|46202|U|Q||Q|M|Indiana State Medical Association|
C00000729|AMERICAN DENTAL POLITICAL ACTION CMTE.|Triftshauser, Roger W|1111 14th Street NW|Suite 1100|Washington|DC|20005|U|Q|UNK|M|T|DENTAL ASS'N; AMERICAN|
Courtesy of ftp.fec.gov
Every dataset, on every Socrata data site
GET https://data.seattle.gov/resource/fire-911.json?$where=datetime > '2012-08-22 15:45'
[
{
"address": "1402 E Pike St",
"longitude": "-122.314118",
"latitude": "47.614121",
"incident_number": "F120079189",
"datetime": 1345675560,
"type": "Motor Vehicle Accident",
"report_location": {
"longitude": "-122.314118",
"latitude": "47.614121"
}
}
]
API Endpoints
Format:https://$domain/resource/$identifier.ext
API Endpoints
Example: Electric Consumption by Zip Code https://data.city.gov/envir.../elec.../abcd-1234
... becomes ...
https://data.city.gov/resource/abcd-1234.json
Simple Filters
/resource/abcd-1234.json?source=ConEd
[ {
"zipcode" : "10001",
"source" : "ConEd",
"location" : {
"longitude" : "-73.99688630375988",
"latitude" : "40.75025902143676",
},
"building_type" : "Commercial",
"kwh" : "23328498"
}, ... ]
SoQL Queries
/resource/abcd-1234.json?$where=kwh > 80000
For more details see dev.socrata.com
Aggregating Data
/resource/abcd-1234.json?
$select=source, sum(kwh)
&$group=source
[ {
"source" : "ConEd",
"sum_kwh" : "49469570957"
}, {
"source" : "Long Island Power Authority",
"sum_kwh" : "445333629"
}, ... ]
Limiting Output
/resource/abcd-1234.json?
$limit=5
Paging Through Data
/resource/abcd-1234.json?
$limit=50
&$offset=100
Application Tokens
- Register at http://dev.socrata.com/register
- Include as:
X-App-Token: $tokenHTTP Header or ...- The
$$app_token=$tokenparameter
- Profit!!! (from more API requests)
Use the Safe Software's FME Product or Socrata DataSync
For more details attend the Socrata Integration course
Example: Adding a new fire 911 report
POST https://data.seattle.gov/resource/kzjm-xkqj.json
Content-type: application/json
Authorization: Basic [REDACTED]
X-App-Token: CGxaHQoQlgQSev4zyUh5aR5J3
[
{
"address": "1402 E Pike St",
"longitude": "-122.314118",
"latitude": "47.614121",
"incident_number": "F120079189",
"datetime": 1345675560,
"type": "Motor Vehicle Accident",
"report_location": {
"longitude": "-122.314118",
"latitude": "47.614121"
}
}
]