Skip to content

Authentication

This module contains objects for authenticating with the TFL API.

Using the Auth class, you can authenticate with the TFL API using your API key. When a request is sent, the API key will be added to the request URL.

You can register for an API key via the TFL API website. An API key is not required to use the TFL API. However, without registering for an API key, you will be limited to 50 requests per hour. If an invalid API key is provided an error by the TFL API will be returned.

Auth

Bases: httpx.Auth

The authentication class for Transport for London API.

Using the Auth class, you can authenticate with the TFL API using your API key. When a request is sent, the API key will be added to the request URL.

Example 
from tfl import clients

async with clients.LiftDisruptionsV2Client(auth=clients.Auth("<your-tfl-api-key>")) as client:
    response = await client.get_lift_disruptions()

print(response.json())

Parameters:

Name Type Description Default
key str

The TFL API key.

 required
Source code in tfl/clients/_auth.py 
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
44
45
46
47
48
49
50
51
52
53
class Auth(httpx.Auth):
    """The authentication class for Transport for London API.

    Using the `Auth` class, you can authenticate with the TFL API using your API key. When a request is sent, the API
    key will be added to the request URL.

    Example:
        ```python
        from tfl import clients

        async with clients.LiftDisruptionsV2Client(auth=clients.Auth("<your-tfl-api-key>")) as client:
            response = await client.get_lift_disruptions()

        print(response.json())
        ```

    Args:
        key: The TFL API key.
    """

    def __init__(self, key: str) -> None:
        self.key = key

    def auth_flow(self, request: httpx.Request) -> Generator[httpx.Request, Any, None]:
        """Add the API key to the request.

        The key will be added to the request URL as a query parameter.

        Args:
            request: The request to be sent.

        Returns:
            The request with the API key added to the URL.
        """
        request.url = request.url.copy_add_param(key="app_key", value=self.key)
        yield request

auth_flow(request)

Add the API key to the request.

The key will be added to the request URL as a query parameter.

Parameters:

Name Type Description Default
request httpx.Request

The request to be sent.

 required

Returns:

Type Description
Generator[httpx.Request, Any, None]

The request with the API key added to the URL.
Source code in tfl/clients/_auth.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
def auth_flow(self, request: httpx.Request) -> Generator[httpx.Request, Any, None]:
    """Add the API key to the request.

    The key will be added to the request URL as a query parameter.

    Args:
        request: The request to be sent.

    Returns:
        The request with the API key added to the URL.
    """
    request.url = request.url.copy_add_param(key="app_key", value=self.key)
    yield request