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