IBKR.Api.Authentication
0.7.5
dotnet add package IBKR.Api.Authentication --version 0.7.5
NuGet\Install-Package IBKR.Api.Authentication -Version 0.7.5
<PackageReference Include="IBKR.Api.Authentication" Version="0.7.5" />
<PackageVersion Include="IBKR.Api.Authentication" Version="0.7.5" />
<PackageReference Include="IBKR.Api.Authentication" />
paket add IBKR.Api.Authentication --version 0.7.5
#r "nuget: IBKR.Api.Authentication, 0.7.5"
#:package IBKR.Api.Authentication@0.7.5
#addin nuget:?package=IBKR.Api.Authentication&version=0.7.5
#tool nuget:?package=IBKR.Api.Authentication&version=0.7.5
IBKR.Api.Authentication
Core OAuth2 + JWT authentication library for Interactive Brokers Client Portal API.
Overview
This package provides the core authentication logic for IBKR Client Portal API, including:
- OAuth2 token flow with JWT client assertions
- Bearer token management and caching
- Brokerage session initialization
- RSA signing for JWT
Usage
This is a low-level library. Most users should use IBKR.Sdk.Client instead, which provides a complete, easy-to-use SDK.
Direct Usage (Advanced)
var options = new IBKRAuthenticationOptions
{
ClientId = "TESTCONS",
Credential = "your_username",
ClientKeyId = "kid-from-portal",
ClientPemPath = "/path/to/private-key.pem",
BaseUrl = "https://api.ibkr.com"
};
var authProvider = new IBKRAuthenticationProvider(options);
await authProvider.InitializeSessionAsync();
var bearerToken = await authProvider.GetBearerTokenAsync();
Related Packages
- IBKR.Sdk.Client - High-level SDK (recommended)
- IBKR.Api.NSwag.Authentication - NSwag authentication adapter
- IBKR.Api.Kiota.Authentication - Kiota authentication adapter
License
MIT License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. |
-
net8.0
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Http (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.4)
- System.IdentityModel.Tokens.Jwt (>= 8.2.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on IBKR.Api.Authentication:
| Package | Downloads |
|---|---|
|
IBKR.Sdk.Client
A clean, intuitive .NET SDK for Interactive Brokers Client Portal API |
|
|
IBKR.Api.NSwag.Authentication
IBKR authentication integration for NSwag SDK using HttpMessageHandler |
|
|
IBKR.Api.Kiota.Authentication
IBKR authentication integration for Kiota SDK using IAuthenticationProvider |
GitHub repositories
This package is not used by any popular GitHub repositories.