C# Property Data SDK

The Datafiniti C# SDK provides a strongly-typed .NET client for searching, counting, and paginating property records through the Datafiniti Property API (/v4/properties).

Installation

dotnet add package Datafiniti.Sdk

Install-Package Datafiniti.Sdk

<PackageReference Include="Datafiniti.Sdk" Version="0.1.*" />

Authentication

The SDK authenticates with a Bearer token. Set your API key in the DATAFINITI_API_KEY environment variable and construct the client with FromEnvironment(), or pass the key directly.

using Datafiniti.Sdk;

var propertyClient = DatafinitiPropertyClient.FromEnvironment();

using Datafiniti.Sdk;

var propertyClient = new DatafinitiPropertyClient("YOUR_API_KEY");

Quick start

Building queries

The fluent PropertyQuery builder composes field filters into the Datafiniti query syntax. Call Build() to produce the final query string.

var query = client.Query()
    .Country("US")
    .City("Austin")
    .Province("TX")
    .MostRecentStatus("For Sale")
    .Build();
// country:US AND city:"Austin" AND province:"TX" AND mostRecentStatus:("For Sale")

Geolocation search

Search within a circular radius around a coordinate. The longitude comes first, followed by latitude, radius, and unit.

var query = client.Query()
    .GeoLocation(longitude: -97.7430600, latitude: 30.2671500, radius: 10, unit: "mi")
    .Build();
// geoLocation:[-97.743060,30.26715,10,mi]

Address search

var query = client.Query()
    .SearchByAddress("1600 Pennsylvania Ave NW, Washington, DC")
    .Build();

Fuzzy matching

The address field uses fuzzy matching by default, so exact, full, and partial address variants can resolve to the same property. Searches such as 1100 Congress Ave, 1100 Congress Avenue, 1100 Congress Ave, Austin, and 1100 Congress Ave, Austin, TX 78701 all match the same address when the parser can normalize them successfully.

var query = client.Query()
    .SearchByAddress("1100 Congress Ave, Austin, TX 78701")
    .Build();
// address:"1100 Congress Ave, Austin, TX 78701"

Supported address formats

Ambiguous state/suffix codes

Some two-letter codes are valid both as street suffixes and state abbreviations. For example, CT can mean Court or Connecticut, and LA can mean Lane or Louisiana.

When the parser encounters one of these ambiguous codes, it needs a disambiguator to split the address correctly. Include either a ZIP code after the state token or a comma before the state token. Without one of those signals, the parser treats the code as a street suffix instead of a state.

For-sale convenience filter

var query = client.Query()
    .ForSale()
    .Province("TX")
    .Build();

Core methods

All request methods are asynchronous and return Task<T>.

Search

var results = await client.SearchAsync(query, numRecords: 25);
Console.WriteLine($"Returned {results.Records.Count} records");

Count

long total = await client.CountAsync(query);
Console.WriteLine($"Total matches: {total}");

Paginate

await foreach (var record in client.PaginateAsync(query))
{
    Console.WriteLine(record["address"]);
}

Error handling

Failed API requests throw DatafinitiApiException. The client automatically retries transient failures with exponential backoff.

try
{
    var results = await client.SearchAsync(query);
}
catch (DatafinitiApiException ex)
{
    Console.WriteLine($"API error {ex.StatusCode}: {ex.Message}");
}

Example: Find property comps from transaction data

Determining where the market sits can be done with relative ease. Datafiniti provides current and historical data for any given property, and the transactions field exposes the prices a property has sold for. This example walks through finding comparable sales ("comps") for an area.

Find a property with transaction data

To find a property that has a transaction history, search its area and require a transaction price with a wildcard. This guarantees each returned record has a sale price.

var query = client.Query()
    .Country("US")
    .Province("FL")
    .HasTransactionPrice()   // transactions.price:*
    .Build();
// country:US AND province:FL AND transactions.price:*

var results = await client.SearchAsync(query, numRecords: 1);

A matching record contains a transactions array like this:

"transactions": [
    {
        "saleDate": "2022-12-20T00:00:00.000Z",
        "documentType": "Warranty Deed",
        "price": 17300,
        "sellerLastName": "Dl Investors 1 Llc",
        "loanType": "Conventional",
        "parcelNumber": "09-44-25-15-0000D.0190"
    }
]

Find property transactions within a date range

To pull properties sold within a specific window, filter on transactions.saleDate with a range.

var query = client.Query()
    .Country("US")
    .Province("FL")
    .HasTransactionPrice()
    .SaleDateBetween("2023-01-01", "2024-01-01")
    .Build();
// country:US AND province:FL AND transactions.price:* AND transactions.saleDate:[2023-01-01 TO 2024-01-01]

var results = await client.SearchAsync(query, numRecords: 1);

Compare comps in a specific area

Narrow to a single postal code to compare comps within a focused area. This returns records with the sold price of each property.

var query = client.Query()
    .Country("US")
    .Province("FL")
    .HasTransactionPrice()
    .PostalCode("33905")
    .Build();
// country:US AND province:FL AND transactions.price:* AND postalCode:33905

var results = await client.SearchAsync(query, numRecords: 10);

foreach (var record in results.Records)
{
    var transactions = record["transactions"];
    Console.WriteLine($"{record["address"]}: {transactions}");
}

Configuration reference