boarddata

Python SDK for the BoardData V2 REST API.

Installation

pip install boarddata

Quick Start

from boarddata import BoardDataClient

# From environment variables
client = BoardDataClient.from_env()

# Or explicit configuration
client = BoardDataClient(
    base_url="https://api.boarddata.scalens.com",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# List companies
companies = client.list_companies(country="FR", page_size=10)

# Get a specific company
company = client.get_company("company-uuid")

# Create or update a company
result = client.upsert_company("FR0000120271", "TotalEnergies", country="FR")
print(result["action"])  # "created" or "updated"
print(result["id"])      # company UUID

Environment Variables

Variable	Description
`BOARDDATA_BACKEND_URL`	Base URL of the BoardData API
`BOARDDATA_CLIENT_ID`	OAuth2 client ID (from Django admin)
`BOARDDATA_CLIENT_SECRET`	OAuth2 client secret (from Django admin)

Token Caching

from boarddata import BoardDataClient, FileTokenCache

# File-based cache
client = BoardDataClient.from_env(token_cache="~/.boarddata/token.json")

# Or with explicit cache object
cache = FileTokenCache("~/.boarddata/token.json")
client = BoardDataClient.from_env(token_cache=cache)

Pagination

# Auto-paginate any list endpoint
all_companies = client.paginate(client.list_companies, country="FR")

# Limit pages
first_100 = client.paginate(client.list_companies, max_pages=4, page_size=25)

Available Domains

Companies — list_companies, get_company, create_company, update_company, delete_company, upsert_company
Persons — list_persons, get_person, create_person, update_person, delete_person, upsert_person
Directors — list_directors, get_director, create_director, update_director, delete_director, upsert_director
Comex — list_comex, get_comex, create_comex, update_comex, delete_comex, upsert_comex
Auditors — list_auditors, get_auditor, create_auditor, update_auditor, delete_auditor
Documents — list_documents, get_document, create_document, update_document, delete_document
Assemblies — list_assemblies, get_assembly, create_assembly, update_assembly, delete_assembly
Resolutions — list_resolutions, get_resolution, update_resolution, delete_resolution
ESG — list_iros, create_iro, list_transition_plans, create_transition_plan, list_esg_benchmark
Sentinel — list_analyses, create_analysis, retry_press_extraction, update_press_article
Utilities — search, query_assistant, get_field_sources, paginate

License

MIT

Release files for boarddata 6.8.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for boarddata 6.8.4
File	Size	Uploaded
boarddata-6.8.4.tar.gz	86.4 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for boarddata 6.8.4
File	Interpreter	ABI	Platform	Reset
boarddata-6.8.4-py3-none-any.whl 120.5 kB Sep 25, 2026	Python 3	none	any	Details

Total release size: 207.0 kB

Release files / boarddata-6.8.4.tar.gz

Download URL	boarddata-6.8.4.tar.gz
Size	86.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`b952424f0177289d319dc1f6324680b25d4f839ce4552c7633219acbded159d1`
BLAKE2b-256 checksum How to use checksums	`d907d68840965742ef2226abd39df78eeb94663d2ba616551d8ab563697ad4b8`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.15`

Release files / boarddata-6.8.4-py3-none-any.whl

Download URL	boarddata-6.8.4-py3-none-any.whl
Size	120.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`26a6c828ed1ae0c719c60e216e58fea5c9fd35bb5506db5eda0531bdda685050`
BLAKE2b-256 checksum How to use checksums	`4b2b043d8d48c36df459144417db7cd9e34eeb0313d0b5b61646749e2c86d20f`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.15`