Python 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 to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../bright-query-api — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

uv add <path-to-sdk>

poetry add <path-to-sdk>

Quick StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct BrightQueryApiClient with keyword arguments, and call close() when you are done. Every argument is optional.

from bright_query_api import BrightQueryApiClient

client = BrightQueryApiClient(api_key_auth="YOUR_API_KEY")

client.close()

Alternatively, scope it — with BrightQueryApiClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

AsyncBrightQueryApiClient mirrors BrightQueryApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

from asyncio import run

from bright_query_api import AsyncBrightQueryApiClient


async def main() -> None:
    client = AsyncBrightQueryApiClient(api_key_auth="YOUR_API_KEY")
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncBrightQueryApiClient(...) as client: closes the pool on exit.