BAV API Python SDK - bavapi documentation

WPPBAV provides a python consumer for the WPPBAV Fount API.

It is published as wpp-bavapi in PyPI and hosted on GitHub.

With bavapi you can access the full BAV data catalog, the largest and most comprehensive database of brand data in the world.

Queries are validated automatically thanks to pydantic and retrieved asynchronously via the httpx package.

For more information about the Fount API, see the API documentation website.

Installing bavapi

bavapi should work with any Python installation above version 3.8.

Install bavapi using pip:

pip install wpp-bavapi

See Installation for more detailed instructions.

Example usage

Protected access

To use bavapi, you will need a Fount API token. Read more in the Authentication section.

>>> import bavapi
>>> result = bavapi.brands("TOKEN", name="Swatch") # (1)
>>> result

1. Replace "TOKEN" with your Fount API token.

	sector_id	sector_name	id	name	...
0	233	Apparel & Accessories	8635	Swatch	...
...	...	...	...	...	...

Features

• Support for all endpoints in the Fount API.
  • Extended support for the following endpoints:
    • audiences
    • audience-groups
    • brand-metrics
    • brand-metric-groups
    • brands
    • brandscape-data
    • categories
    • cities
    • collections
    • companies
    • countries
    • sectors
    • studies
    • years
  • Other endpoints are available via the raw_query functions and methods.
  • Extended support for Fount API Tools/TurboPitch endpoints.
• Validates query parameters are of the correct types and provides type hints for better IDE support.
• Retrieve multiple pages of data simultaneously, monitoring and preventing exceeding API rate limit.
• Both synchronous and asynchronous APIs for accessing BAV data.

Documentation

To start using bavapi, go to the Getting Started section.

After going through the "Getting Started" section, please see Basic Usage.

For more advanced topics, see the Advanced Usage section.

Each Fount API endpoint may behave slightly differently. You can find detailed explanations in the Endpoints section.

You can also find a detailed SDK reference in the Code Reference section.

Issues

For bug reports and feature requests, please open an issue on GitHub.

Contributing

To contribute to bavapi, please read the Contributing section of the documentation.