CSM.SodaDotNet 0.10.1

.NET Standard 2.0 .NET Framework 4.5
Install-Package CSM.SodaDotNet -Version 0.10.1
dotnet add package CSM.SodaDotNet --version 0.10.1
<PackageReference Include="CSM.SodaDotNet" Version="0.10.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CSM.SodaDotNet --version 0.10.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CSM.SodaDotNet, 0.10.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install CSM.SodaDotNet as a Cake Addin
#addin nuget:?package=CSM.SodaDotNet&version=0.10.1

// Install CSM.SodaDotNet as a Cake Tool
#tool nuget:?package=CSM.SodaDotNet&version=0.10.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SODA.NET Build status

A Socrata Open Data API (SODA) client library targeting .NET 4.5 and above.

Getting Started

SODA.NET is available as a NuGet package.

dotnet add package CSM.SodaDotNet

Usage examples

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")

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");

Note: This library supports writing directly to datasets with the Socrata Open Data API. For write operations that use data transformations in the Socrata Data Management Experience (the user interface for creating datasets), use the Socrata Data Management API. For more details on when to use SODA vs the Socrata Data Management API, see the Data Management API documentation


Compilation can be done using Visual Studio Community Edition.

You can also use the .NET CLI:

git clone git@github.com:CityofSantaMonica/SODA.NET.git SODA.NET
dotnet build


NUnit was used to build and run the test projects.

Run tests from the Visual Studio Test Explorer, or using the .NET CLI:

dotnet test


Check out the Contributor Guidelines for more details.

Copyright and License

Copyright 2019 City of Santa Monica, CA

Licensed under the MIT License

Thank you

A tremendous amount of inspiration for this project came from the following projects. Thank you!

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on CSM.SodaDotNet:

Package Downloads

Library of helper classes and extension methods for working with Socrata Open Data portals.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.10.1 20,223 10/15/2019
0.9.0 3,287 7/24/2019
0.8.0 10,753 12/7/2017
0.7.0 8,892 1/12/2017
0.6.0 2,671 6/2/2016
0.5.0 2,725 8/12/2015
0.4.1 1,179 6/11/2015
0.4.0 1,130 5/7/2015
0.3.0 1,268 1/8/2015
0.2.1 1,399 12/2/2014
0.2.0 1,739 11/3/2014
0.1.2 1,248 10/1/2014
0.1.1 1,184 9/16/2014
0.1.0 1,247 8/28/2014