Aydsko.iRacingData 2404.5.0-beta

.NET 6.0 This package targets .NET 6.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.
This is a prerelease version of Aydsko.iRacingData.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Aydsko.iRacingData --version 2404.5.0-beta                

                    
                

            
NuGet\Install-Package Aydsko.iRacingData -Version 2404.5.0-beta
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="Aydsko.iRacingData" Version="2404.5.0-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Aydsko.iRacingData --version 2404.5.0-beta                

                    
                

            
#r "nuget: Aydsko.iRacingData, 2404.5.0-beta"
#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. 
// Install Aydsko.iRacingData as a Cake Addin
#addin nuget:?package=Aydsko.iRacingData&version=2404.5.0-beta&prerelease

// Install Aydsko.iRacingData as a Cake Tool
#tool nuget:?package=Aydsko.iRacingData&version=2404.5.0-beta&prerelease

Aydsko iRacing Data API

iRacing is the leading online racing simulation for PC. During events hosted via the iRacing service there is a large amount of data created related to race results and member participation in events.

This library allows access via .NET to the iRacing "Data API". These APIs allow a properly authenticated user a supported method of accessing data from the service.

⚠ Upcoming Multi-Factor Authentication Requirement

iRacing has announced that they will be requiring multi-factor authentication (MFA) for all users by default. This will affect the ability to use the iRacing Data API by logging in with a username or password.

In the immediate future, use of the Data API will be supported by enabling "Legacy Authentication" in your iRacing account settings. iRacing will advise next steps for the authentication of applications for the Data API later on.

To continue to use this library you must enable "Legacy Authentication" in your iRacing account settings before attempting to authenticate. Please do not enable this setting unless you require it, as it may reduce the security on your iRacing account.

Getting Started

1. Install the Aydsko iRacing Data API library.

The library is distributed as the Aydsko.iRacingData NuGet package. Install using your package manager of choice.

dotnet add package Aydsko.iRacingData

2. Register the client.

Register the iRacing Data API client classes with the service provider.

services.AddIRacingDataApi(options =>
{
    options.UserAgentProductName = "MyApplicationName";
    options.UserAgentProductVersion = new Version(1, 0);
});

3. Use the client.

Use the IDataClient from the service provider to authenticate and request data.

// Retrieve an instance from the service provider.
var dataClient = serviceProvider.GetRequiredService<IDataClient>();

// Supply your iRacing username and password.
dataClient.UseUsernameAndPassword(iRacingUsername, iRacingPassword);

// Retrieve information about our own account.
var infoResponse = await dataClient.GetMyInfoAsync(cancellationToken);

// Write that information to the console.
Console.WriteLine($"Driver name: {infoResponse.Data.DisplayName}");
Console.WriteLine($"Customer ID: {infoResponse.Data.CustomerId}");
Console.WriteLine($"Club: {infoResponse.Data.ClubName}");

Enable Caching of Results

1. Add the Microsoft memory caching package.

dotnet add package Microsoft.Extensions.Caching.Memory

2. Register the memory caching library with the service provider.

services.AddMemoryCache();

3. Register the caching client.

Register the iRacing Data API caching client classes with the service provider.

services.AddIRacingDataApiWithCaching(options =>
{
    options.UserAgentProductName = "MyApplicationName";
    options.UserAgentProductVersion = new Version(1, 0);
});

Then simply use the IDataClient as before.

Versioning

Ideally you should always use the latest version of the library that is available. This is because iRacing will sometimes introduce API changes during a release which make the old code incompatible.

This library will use version numbers will be in the format:

[YY][SS].[R]

Where:

  • YY = two digit year
  • SS = the iRacing season the library release was made in as a zero-padded number (i.e. 01, 02, 03, 04)
  • R = release number, which increments when changes are made although it may not be sequential

Example:

  • 2303.1 = changes compatible with iRacing 2023 Season 3 or later, and is release 1 during this season
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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. 
.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
2404.5.0 117 11/9/2024
2404.5.0-beta 76 11/2/2024
2404.4.0 291 10/15/2024
2404.3.0 94 10/10/2024
2404.2.1 112 9/29/2024
2404.2.0 87 9/29/2024
2404.0.0 246 9/9/2024
2403.3.0 181 9/3/2024
2403.2.0 174 8/4/2024
2403.1.0 194 7/2/2024
2403.0.0 206 6/13/2024
2402.2.0 356 5/1/2024
2402.1.0 132 4/20/2024
2304.1.0 1,113 11/27/2023
2303.1.0 643 8/2/2023
2303.0.0 484 6/19/2023
0.10.0 249 5/4/2023
0.9.2 353 4/9/2023
0.9.1 187 4/8/2023
0.9.0 281 4/7/2023
0.8.0 321 3/12/2023
0.7.3 307 2/24/2023
0.7.2 301 2/9/2023
0.7.1 255 2/6/2023
0.7.0 297 12/23/2022
0.6.4 499 11/27/2022
0.6.3 323 11/27/2022 0.6.3 is deprecated because it has critical bugs.
0.6.2 554 10/12/2022
0.6.1 430 9/28/2022
0.6.0 533 9/24/2022
0.5.1 406 9/19/2022
0.5.0 438 9/11/2022
0.4.1 639 7/11/2022
0.4.0 529 7/3/2022
0.3.0 451 6/1/2022
0.2.0 460 4/25/2022
0.1.2 448 4/14/2022
0.1.1 452 4/9/2022
0.1.0 440 3/26/2022
0.0.8 440 3/23/2022
0.0.7 438 3/5/2022
0.0.6 447 3/3/2022
0.0.5 440 2/27/2022
0.0.4 458 2/24/2022

BREAKING CHANGES:

iRacing has enabled two-factor authentication by default. To continue to use this library you must enable "Legacy Authentication" in your iRacing account settings before attempting to authenticate. Please do not enable this setting unless you require it, as it may reduce the security on your iRacing account.

Fixes / Changes:

- Add "/data/stats/season_supersession_standings" Endpoint (Issue: #22)

- Unauthorized Responses Do Not Retry And Calls Continue To Fail (Issue: #231)
 - Implemented a retry mechanism for 401 Unauthorized responses
 - If a request fails with a 401 Unauthorized response, the library will attempt to re-authenticate and retry the request 2 more times
 - If the request continues to fail after 3 attempts, the library will throw an "iRacingUnauthorizedResponseException"