RentRollAPI.Client 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package RentRollAPI.Client --version 1.0.0
                    


                    

                
NuGet\Install-Package RentRollAPI.Client -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="RentRollAPI.Client" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="RentRollAPI.Client" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="RentRollAPI.Client" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add RentRollAPI.Client --version 1.0.0
                    


                    

                
#r "nuget: RentRollAPI.Client, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package RentRollAPI.Client@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=RentRollAPI.Client&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=RentRollAPI.Client&version=1.0.0
                    


                            Install as a Cake Tool

RentRollAPI.Client

Official .NET client for RentRollAPI — convert commercial real estate rent rolls (PDF, Excel, CSV, scans) into structured, verified data with one call.

Every extraction includes a deterministic verification report: totals recomputed from extracted units are reconciled against the totals stated on the document, unit counts are cross-checked, and any uncertain field is flagged with a confidence score — never silently guessed.

Install

dotnet add package RentRollAPI.Client

Quick start

using RentRollApi.Client;

using var client = new RentRollClient("rr_live_your_key");

var result = await client.ExtractAsync("rent-roll.pdf");

Console.WriteLine($"{result.PropertyName?.Value}: {result.Units.Count} units");
Console.WriteLine($"Confidence: {result.Verification.DocumentConfidence:P0}, all checks passed: {result.Verification.AllChecksPassed}");

foreach (var unit in result.Units)
    Console.WriteLine($"  {unit.UnitNumber?.Value,-8} {unit.TenantName?.Value,-24} {unit.MonthlyRent?.Value,10:C}");

foreach (var check in result.Verification.Checks)
    Console.WriteLine($"  [{check.Result}] {check.Name}: {check.Detail}");

Excel / CSV output

byte[] xlsx = await client.ExtractToXlsxAsync(fileStream, "rent-roll.pdf");
string csv  = await client.ExtractToCsvAsync(fileStream, "rent-roll.pdf");

With IHttpClientFactory

services.AddHttpClient("rentroll", c => c.Timeout = TimeSpan.FromMinutes(5));
// ...
var client = new RentRollClient(httpClientFactory.CreateClient("rentroll"), apiKey);

Error handling

try
{
    var result = await client.ExtractAsync("statement.pdf");
}
catch (RentRollApiException ex) when (ex.StatusCode == HttpStatusCode.UnprocessableEntity)
{
    // 422: corrupt, password-protected, or not a supported document
    Console.WriteLine(ex.Message);
}
catch (RentRollApiException ex) when ((int)ex.StatusCode == 429)
{
    // Monthly quota exceeded and no prepaid credits remain
}

Getting an API key

Plans start at $49/month (50 documents) with a free 3-docs/day demo at rentrollapi.com/app — no signup needed to try it.

Documents are processed in memory and never retained.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 93 8/1/2026
1.0.0 86 7/31/2026