Skip to content

Crowding Handler

Handler to interact with the crowding API.

CrowdingHandler

Bases: base.TFLHandler

Handler to interact with the Crowding API.

API reference

Example 
from tfl import clients, enums

async with clients.TFLClient(auth=clients.Auth(key="<your-tfl-api-key>")) as client:
    response = await CrowdingHandler(client).get_crowding(
        naptan_code="940GZZLUBND", day=enums.DayOfWeekEnum.MONDAY
    )

print(response.json())
Source code in tfl/clients/handlers/_crowding_handler.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class CrowdingHandler(base.TFLHandler):
    """Handler to interact with the Crowding API.

    [API reference](https://api-portal.tfl.gov.uk/api-details#api=crowding&operation=dayofweek)

    Example:
        ```python
        from tfl import clients, enums

        async with clients.TFLClient(auth=clients.Auth(key="<your-tfl-api-key>")) as client:
            response = await CrowdingHandler(client).get_crowding(
                naptan_code="940GZZLUBND", day=enums.DayOfWeekEnum.MONDAY
            )

        print(response.json())
        ```
    """

    async def get_crowding(self, naptan_code: str, day: Optional[enums.DayOfWeekEnum] = None) -> httpx.Response:
        """Get information about crowding levels within TFL stations.

        Args:
            naptan_code: The NAPTAN code of the station to get crowding information for.
            day: The day to get crowding information for.

        Returns:
            The response from the API.
        """
        _url = f"crowding/{naptan_code}"
        if day:
            _url += f"/{day.value}"
        return await self.client.get(url=_url)

get_crowding(naptan_code, day=None) async

Get information about crowding levels within TFL stations.

Parameters:

Name Type Description Default
naptan_code str

The NAPTAN code of the station to get crowding information for.

 required
day Optional[enums.DayOfWeekEnum]

The day to get crowding information for.

 None

Returns:

Type Description
httpx.Response

The response from the API.
Source code in tfl/clients/handlers/_crowding_handler.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
async def get_crowding(self, naptan_code: str, day: Optional[enums.DayOfWeekEnum] = None) -> httpx.Response:
    """Get information about crowding levels within TFL stations.

    Args:
        naptan_code: The NAPTAN code of the station to get crowding information for.
        day: The day to get crowding information for.

    Returns:
        The response from the API.
    """
    _url = f"crowding/{naptan_code}"
    if day:
        _url += f"/{day.value}"
    return await self.client.get(url=_url)