C# SDK

IntroCopy Anchor Link

The BrightQuery API SDK provides access to the BrightQuery API REST APIs.

Government-verified business intelligence on U.S. organizations, legal entities, locations and people, linked by the BrightQuery bq_id.

InstallationCopy Anchor Link

Add the SDK as a project reference into your solution:

dotnet add reference <path-to-sdk>/src/BrightQueryApi/BrightQueryApi.csproj

The project takes its build settings from the files around it, so reference it in place.

Quick StartCopy Anchor Link

Dependency InjectionCopy Anchor Link

Register the client with IServiceCollection and resolve it from the container. The HttpClient is managed by IHttpClientFactory. Configure the client's behavior through BrightQueryApiClientOptions.

services.AddBrightQueryApiClient(options =>
{
    options.ApiKeyAuth = "YOUR_API_KEY";
    options.Environment = ServerEnvironment.Production;
    // TODO: configure more client options here
});

Direct InstantiationCopy Anchor Link

Create the client by passing an HttpClient you manage yourself. Configure the client's behavior through BrightQueryApiClientOptions.

var httpClient = new HttpClient();
// TODO: configure more client options here
var options = new BrightQueryApiClientOptions
{
    ApiKeyAuth = "YOUR_API_KEY",
    Environment = ServerEnvironment.Production,
};
var client = new BrightQueryApiClient(httpClient, options);