Python SDK Reference

This page documents the public API surface of the Demandbase Python SDK. The SDK exposes a synchronous Python client, grouped API resources, Pydantic request and response models, enum values, logging configuration, and a shared API error type.

The SDK connects to the production Demandbase API.

Imports

You can use the package namespace:

import demandbase

with demandbase.DBClient() as client:
    subscriptions = client.b2b_api.list_subscriptions()

Or import public objects directly:

from demandbase import DBClient, DemandBaseAPIError
from demandbase.models.Common import EntityType
from demandbase.models.B2B.CompanySearch import CompanyRequest

Top-Level Package

Client And Helper Imports

API Method Groups

After creating a DBClient, call SDK methods from these API groups.

Model And Enum Namespaces

Model namespaces are case-sensitive. Use demandbase.models.B2B, demandbase.models.Export, demandbase.models.Import, and demandbase.models.Common. The top-level demandbase.B2B, demandbase.Export, demandbase.Import, and demandbase.Common names are convenience aliases for those namespaces.

Client

demandbase.DBClient

Creates a synchronous SDK client. Use it as a context manager so the underlying HTTP resources are closed automatically.

with demandbase.DBClient(timeout=60.0, retry_count=2) as client:
    result = client.b2b_api.list_subscriptions()

timeout is measured in seconds. For example, timeout=60.0 allows a request to run for up to 60 seconds before timing out.

Signature:

demandbase.DBClient(*, timeout: float = 180.0, retry_count: Optional[int] = 1)

Public attributes:

Client lifecycle:

Use DBClient as a context manager when possible. If you instantiate the client without with, call client.close() when your application is done using it.

Behavior:

Logging

demandbase.enable_logging

Enables SDK logging.

Signature:

demandbase.enable_logging(level: str = None, *, stream=None) -> None

Examples:

import sys
import demandbase

demandbase.enable_logging("INFO", stream=sys.stdout)

import demandbase

log_file = open("demandbase-sdk.log", "a", encoding="utf-8")
demandbase.enable_logging("DEBUG", stream=log_file)

Error Type

demandbase.DemandBaseAPIError

Raised when the Demandbase API returns an error response or when the SDK prevents a request because required request values are missing.

Important attributes:

SDK log output redacts bearer access tokens from authorization headers. Request payloads and query parameters can still contain sensitive business data, so avoid logging full error context in production unless your application has appropriate controls.

Example:

import demandbase

try:
    with demandbase.DBClient() as client:
        subscriptions = client.b2b_api.list_subscriptions()
except demandbase.DemandBaseAPIError as error:
    print(error.http_status_code)
    print(error.error_message)

B2B API

Access through client.b2b_api.

Search And Retrieval

Example:

import demandbase
from demandbase.models.B2B.CompanySearch import CompanyRequest

with demandbase.DBClient() as client:
    request = CompanyRequest(name="Demandbase", page="1", perPage="10")
    response = client.b2b_api.search_companies(request)
    print(response.totalCount)

Bulk Jobs

csv_data can be a pandas.DataFrame, raw CSV bytes, or a local file path string. When you pass a path string, the SDK opens and reads the file. Do not pass an already-open file stream.

Subscriptions

Example:

import demandbase

with demandbase.DBClient() as client:
    subscriptions = client.b2b_api.list_subscriptions(page=1, per_page=10)
    for subscription in subscriptions.subscriptions or []:
        print(subscription.subscriptionId, subscription.name)

Data Export API

Access through client.data_export_api.

Notes:

• create_export_job always requests CSV output.
• job_name and fields are required for create_export_job.
• Activity exports require from_date and to_date.
• Campaign and creative exports require ad_report_type and source; some report types also require from_date and to_date.
• Campaign and creative field discovery requires ad_report_type.

Example:

import demandbase
from demandbase.models.Common import EntityType

with demandbase.DBClient() as client:
    fields = client.data_export_api.get_available_export_fields(
        entity_type=EntityType.ACCOUNT
    )
    print([field.name for field in fields])

Data Import API

Access through client.data_import_api.

Import Jobs

csv_data can be a pandas.DataFrame, raw CSV bytes, or a local file path string. When you pass a path string, the SDK opens and reads the file. Do not pass an already-open file stream.

Example:

import demandbase
from demandbase.models.Common import EntityType

with demandbase.DBClient() as client:
    job = client.data_import_api.create_import_job(
        entity_type=EntityType.PERSON,
        data_import_name="example_person_import"
    )
    print(job.id, job.state)

Activity Types And Sources

Example:

import demandbase

with demandbase.DBClient() as client:
    activity_types = client.data_import_api.get_activity_types()
    for activity_type in activity_types:
        print(activity_type.id, activity_type.name)

Admin API

Access through client.admin_api.

The Admin API group is not implemented. It is present on the client for future compatibility, but currently exposes no public SDK methods.

Common Enums

EntityType

Import from demandbase.models.Common.

JobStatus

Import from demandbase.models.Export.

Source

Import from demandbase.models.Export.

AdReportType.Campaign

Import from demandbase.models.Export.

AdReportType.Creative

Import from demandbase.models.Export.

ImportJobState

Import from demandbase.models.Import.

ImportJobListAction

Import from demandbase.models.Import.

SubscriptionType

Import from demandbase.models.B2B.

NewsCategory

Import from demandbase.models.B2B.

B2B Models

Company Search Models

Contact Search Models

Company Details Models

Contact Details Models

Company News And Logo Models

Match Models

Bulk Job Models

Subscription Models

Export Models

Import Models

Serialization

SDK methods usually return Pydantic models. Access fields as attributes, or serialize models when you need dictionaries or JSON.

response = client.b2b_api.list_subscriptions()

print(response.subscriptions)
print(response.model_dump())
print(response.model_dump_json())

Validation And Exceptions

The SDK validates some client-side inputs before sending requests:

Related Pages

• Python SDK Getting Started
• Python SDK Error Handling