A Socrata Open Data API (SODA) client library targeting .NET 4.5 and above.
Simple, read-only access
//initialize a new client
//make sure you register for your own app token (http://dev.socrata.com/register)
var client = new SodaClient("data.smgov.net", "REPLACE_WITH_YOUR_APP_TOKEN");
//read metadata of a dataset using the resource identifier (Socrata 4x4)
var metadata = client.GetMetadata("1234-wxyz");
Console.WriteLine("{0} has {1} views.", metadata.Name, metadata.ViewsCount);
//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
var dataset = client.GetResource<Dictionary<string, object>>("1234-wxyz");
//of course, a custom type can be used as long as it is JSON serializable
var dataset = client.GetResource<MyClass>("1234-wxyz");
//Resource objects read their own data
var allRows = dataset.GetRows();
var first10Rows = dataset.GetRows(10);
//collections of an arbitrary type can be returned
//using SoQL and a fluent query building syntax
var soql = new SoqlQuery().Select("column1", "column2")
.Where("something > nothing")
.Group("column3");
var results = dataset.Query<MyOtherClass>(soql);SodaClient is also capable of performing write operations
//make sure to provide auth credentials!
var client =
new SodaClient("data.smgov.net", "AppToken", "user@domain.com", "password");
//Upsert some data serialized as CSV
string csvData = File.ReadAllText("data.csv");
client.Upsert(csvData, SodaDataFormat.CSV, "1234-wxyz");
//Upsert a collection of serializable entities
IEnumerable<MyClass> payload = GetPayloadData();
client.Upsert(payload, "1234-wxyz");SODA.NET uses the popular Newtonsoft.Json package for JSON (de)serialization.
NUnit was used to build the test projects.
SODA.NET is available as a NuGet package.
Install-Package CSM.SodaDotNet
If you'd like to compile SODA.NET yourself, you will need:
- Visual Studio 2013
To clone it locally, click the "Clone in Windows" button above or run the follow git commands
git clone git@github.com:CityofSantaMonica/SODA.NET.git SODA.NET
cd SODA.NET
.\build.cmd
Check out the Contributor Guidelines for more details.
Copyright 2014 City of Santa Monica, CA
Licensed under the MIT License
A tremendous amount of inspiration for this project came from the following projects. Thank you!
- Octokit.net
- soda-java
- soda-dotnet (defunct?)