Request class

You can declare a parameter in a path operation function or dependency to be of type Request and then you can access the raw request object directly, without any validation, etc.

You can import it directly from fastapi:

from fastapi import Request

Tip

When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an HTTPConnection instead of a Request or a WebSocket.

fastapi.Request

Request(<span data-autorefs-optional="fastapi.Request(scope)">scope</span>, <span data-autorefs-optional="fastapi.Request(receive)">receive</span>=<span data-autorefs-optional-hover="starlette.requests.empty_receive">empty_receive</span>, <span data-autorefs-optional="fastapi.Request(send)">send</span>=<span data-autorefs-optional-hover="starlette.requests.empty_send">empty_send</span>)

Bases: HTTPConnection

PARAMETER	DESCRIPTION
scope	TYPE: Scope
receive	TYPE: Receive DEFAULT: empty_receive
send	TYPE: Send DEFAULT: empty_send

Source code in starlette/requests.py

def __init__(
    self, scope: Scope, receive: Receive = empty_receive, send: Send = empty_send
):
    super().__init__(scope)
    assert scope["type"] == "http"
    self._receive = receive
    self._send = send
    self._stream_consumed = False
    self._is_disconnected = False
    self._form = None

scope instance-attribute

scope = scope

app property

app

url property

url

base_url property

base_url

headers property

headers

query_params property

query_params

path_params property

path_params

cookies property

cookies

client property

client

session property

session

auth property

auth

user property

user

state property

state

method property

method

receive property

receive

url_for

url_for(<span data-autorefs-optional="fastapi.Request.url_for(name)">name</span>, /, <span data-autorefs-optional="fastapi.Request.url_for(**path_params)">**path_params</span>)

PARAMETER	DESCRIPTION
name	TYPE: str
**path_params	TYPE: Any DEFAULT: {}

Source code in starlette/requests.py

def url_for(self, name: str, /, **path_params: typing.Any) -> URL:
    router: Router = self.scope["router"]
    url_path = router.url_path_for(name, **path_params)
    return url_path.make_absolute_url(base_url=self.base_url)

stream async

stream()

Source code in starlette/requests.py

async def stream(self) -> typing.AsyncGenerator[bytes, None]:
    if hasattr(self, "_body"):
        yield self._body
        yield b""
        return
    if self._stream_consumed:
        raise RuntimeError("Stream consumed")
    while not self._stream_consumed:
        message = await self._receive()
        if message["type"] == "http.request":
            body = message.get("body", b"")
            if not message.get("more_body", False):
                self._stream_consumed = True
            if body:
                yield body
        elif message["type"] == "http.disconnect":
            self._is_disconnected = True
            raise ClientDisconnect()
    yield b""

body async

body()

Source code in starlette/requests.py

async def body(self) -> bytes:
    if not hasattr(self, "_body"):
        chunks: "typing.List[bytes]" = []
        async for chunk in self.stream():
            chunks.append(chunk)
        self._body = b"".join(chunks)
    return self._body

json async

json()

Source code in starlette/requests.py

async def json(self) -> typing.Any:
    if not hasattr(self, "_json"):
        body = await self.body()
        self._json = json.loads(body)
    return self._json

form

form(*, <span data-autorefs-optional="fastapi.Request.form(max_files)">max_files</span>=1000, <span data-autorefs-optional="fastapi.Request.form(max_fields)">max_fields</span>=1000)

PARAMETER	DESCRIPTION
max_files	TYPE: int | float DEFAULT: 1000
max_fields	TYPE: int | float DEFAULT: 1000

Source code in starlette/requests.py

def form(
    self, *, max_files: int | float = 1000, max_fields: int | float = 1000
) -> AwaitableOrContextManager[FormData]:
    return AwaitableOrContextManagerWrapper(
        self._get_form(max_files=max_files, max_fields=max_fields)
    )

close async

close()

Source code in starlette/requests.py

async def close(self) -> None:
    if self._form is not None:
        await self._form.close()

is_disconnected async

is_disconnected()

Source code in starlette/requests.py

async def is_disconnected(self) -> bool:
    if not self._is_disconnected:
        message: Message = {}

        # If message isn't immediately available, move on
        with anyio.CancelScope() as cs:
            cs.cancel()
            message = await self._receive()

        if message.get("type") == "http.disconnect":
            self._is_disconnected = True

    return self._is_disconnected

send_push_promise async

send_push_promise(<span data-autorefs-optional="fastapi.Request.send_push_promise(path)">path</span>)

PARAMETER	DESCRIPTION
path	TYPE: str

Source code in starlette/requests.py

async def send_push_promise(self, path: str) -> None:
    if "http.response.push" in self.scope.get("extensions", {}):
        raw_headers: "typing.List[typing.Tuple[bytes, bytes]]" = []
        for name in SERVER_PUSH_HEADERS_TO_COPY:
            for value in self.headers.getlist(name):
                raw_headers.append(
                    (name.encode("latin-1"), value.encode("latin-1"))
                )
        await self._send(
            {"type": "http.response.push", "path": path, "headers": raw_headers}
        )