Companies
info
Read more in the API documentation for the companies
endpoint.
The companies
endpoint has full support, including query validation.
Endpoint | Function | Client method | Filters class |
---|---|---|---|
"companies" | companies | Client.companies | CompaniesFilters |
Usage
- Sync
- Async
Using top-level functions
import bavapi
result = bavapi.companies("TOKEN", name="Unilever")
Using Client asynchronously
import bavapi
async with bavapi.Client("TOKEN") as bav:
result = await bav.companies(name="Unilever")
Available filters in function calls
These filters are available directly within the function/method:
- Positional filters:
public
,private
,brands
- Keyword filters:
company_id
For other filters, passing an CompaniesFilters
instance to the filters
parameter is required.