Boolean query parameters in FastAPI

Introduction

Boolean query parameters let users send true or false values in URLs. This helps control how the server responds.

To enable or disable a feature in an API call, like showing extra details.

To filter results, for example, only show active items when true.

To toggle options, such as turning on debug mode via URL.

To decide if a response should include sensitive data or not.

To control pagination or sorting behavior with simple true/false flags.

Syntax

FastAPI

from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

@app.get("/items/")
async def read_items(show_details: Optional[bool] = Query(False)):
    if show_details:
        return {"message": "Showing detailed info"}
    return {"message": "Showing basic info"}

Use Optional[bool] with Query to declare a boolean query parameter.

FastAPI automatically converts query strings like ?show_details=true or ?show_details=false to Python booleans.

Examples

This example shows a boolean query parameter that can be true, false, or not provided.

FastAPI

from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

@app.get("/users/")
async def get_users(active: Optional[bool] = Query(None)):
    if active is None:
        return {"users": "all users"}
    elif active:
        return {"users": "only active users"}
    else:
        return {"users": "only inactive users"}

Here, the boolean parameter debug defaults to false if not given.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/debug/")
async def debug_mode(debug: bool = False):
    return {"debug": debug}

Sample Program

This FastAPI app has a GET endpoint at /items/. It accepts a boolean query parameter show_details. If true, it returns a message with detailed info. Otherwise, it returns basic info.

FastAPI

from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

@app.get("/items/")
async def read_items(show_details: Optional[bool] = Query(False)):
    if show_details:
        return {"message": "Showing detailed info"}
    return {"message": "Showing basic info"}

Important Notes

Boolean query parameters accept values like true, false, 1, 0 (case insensitive).

If you want the parameter to be optional, use Optional[bool] and set a default like None or False.

FastAPI handles the conversion automatically, so you get a Python boolean in your function.

Summary

Boolean query parameters let users control API behavior with true/false flags.

FastAPI converts query strings to Python booleans automatically.

Use Optional[bool] with Query to declare them clearly.

Practice

1. What does a Boolean query parameter in FastAPI represent?

easy

A. A true or false flag passed in the URL to control API behavior

B. A number used to count API requests

C. A string that describes the API endpoint

D. A list of items sent in the request body

Solution

1. Step 1: Identify the purpose of Boolean query parameters

   Boolean query parameters are flags that can be true or false, used to control how the API behaves.

2. Step 2: Identify the correct description

   Only "A true or false flag passed in the URL to control API behavior" describes a true/false flag passed via URL query parameters.

3. Final Answer:

   A true or false flag passed in the URL to control API behavior -> Option A

4. Quick Check:

   Boolean query parameter = true/false flag [OK]

Hint: Boolean query parameters are true/false flags in the URL [OK]

Common Mistakes:

• Confusing Boolean parameters with numbers or strings
• Thinking Boolean parameters come from request body
• Assuming Boolean parameters are lists

2. Which of the following is the correct way to declare an optional Boolean query parameter in FastAPI?

easy

A. def read_items(active: bool = Query(None)):

B. def read_items(active: Optional[bool] = Query(None)):

C. def read_items(active: str = Query(None)):

D. def read_items(active: int = Query(None)):

Solution

1. Step 1: Recall FastAPI syntax for optional Boolean query parameters

   Use Optional[bool] with Query(None) to allow the parameter to be true, false, or missing.

2. Step 2: Match the correct function signature

   def read_items(active: Optional[bool] = Query(None)): correctly uses Optional[bool] and Query(None) for an optional Boolean query parameter.

3. Final Answer:

   def read_items(active: Optional[bool] = Query(None)): -> Option B

4. Quick Check:

   Optional[bool] with Query(None) = correct syntax [OK]

Hint: Use Optional[bool] with Query(None) for optional Booleans [OK]

Common Mistakes:

• Using bool without Optional for optional parameters
• Using str or int instead of bool
• Omitting Query import or default value

3. Given this FastAPI endpoint code, what will be the output if the URL is /items?active=true?

from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

@app.get('/items')
async def read_items(active: Optional[bool] = Query(None)):
    return {"active": active}

medium

A. Error: invalid query parameter

B. {"active": "true"}

C. {"active": null}

D. {"active": true}

Solution

1. Step 1: Understand FastAPI Boolean query parsing

   FastAPI automatically converts query strings like 'true' to Python boolean True.

2. Step 2: Check the returned dictionary

   The function returns {"active": active}, so with active=true in URL, it returns {"active": true} as JSON.

3. Final Answer:

   {"active": true} -> Option D

4. Quick Check:

   Query 'true' converts to True boolean [OK]

Hint: FastAPI converts 'true' string to True boolean automatically [OK]

Common Mistakes:

• Expecting string 'true' instead of boolean true
• Assuming missing parameter returns false
• Thinking it causes an error

4. Identify the error in this FastAPI endpoint that uses a Boolean query parameter:

from fastapi import FastAPI, Query

app = FastAPI()

@app.get('/items')
async def read_items(active: bool = Query()):
    return {"active": active}

medium

A. The return statement must convert active to string

B. Boolean query parameters cannot be used in FastAPI

C. Query() requires a default value for optional parameters

D. The function must be synchronous, not async

Solution

1. Step 1: Check Query parameter usage

   Query() without a default value means the parameter is required. For optional, a default like None is needed.

2. Step 2: Identify the missing default

   Since active is bool and no default is given, FastAPI expects the query parameter always present, else error.

3. Final Answer:

   Query() requires a default value for optional parameters -> Option C

4. Quick Check:

   Query() needs default for optional params [OK]

Hint: Use Query(None) for optional Boolean parameters [OK]

Common Mistakes:

• Omitting default value for optional query parameters
• Thinking async is not allowed
• Trying to convert Boolean to string manually

5. You want to create a FastAPI endpoint that filters items by an optional Boolean query parameter available. If available is true, return only available items; if false, only unavailable items; if missing, return all items. Which code correctly implements this behavior?

hard

A. from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

items = [{"name": "item1", "available": True}, {"name": "item2", "available": False}]

@app.get('/items')
async def read_items(available: Optional[bool] = Query(None)):
if available is None:
return items
return [item for item in items if item["available"] == available]

B. from fastapi import FastAPI

app = FastAPI()

@app.get('/items')
async def read_items(available: bool = False):
return {"available": available}

C. from fastapi import FastAPI, Query

app = FastAPI()

@app.get('/items')
async def read_items(available: bool = Query()):
return {"available": available}

D. from fastapi import FastAPI, Query
from typing import Optional

app = FastAPI()

@app.get('/items')
async def read_items(available: Optional[str] = Query(None)):
return {"available": available}

Solution

1. Step 1: Analyze the required filtering behavior

   If available is None, return all items; else filter by matching available status.

2. Step 2: Check code correctness

   from fastapi import FastAPI, Query from typing import Optional app = FastAPI() items = [{"name": "item1", "available": True}, {"name": "item2", "available": False}] @app.get('/items') async def read_items(available: Optional[bool] = Query(None)): if available is None: return items return [item for item in items if item["available"] == available] uses Optional[bool] with Query(None) and filters items correctly based on available value.

3. Final Answer:

   from fastapi import FastAPI, Query from typing import Optional app = FastAPI() items = [{"name": "item1", "available": True}, {"name": "item2", "available": False}] @app.get('/items') async def read_items(available: Optional[bool] = Query(None)): if available is None: return items return [item for item in items if item["available"] == available] -> Option A

4. Quick Check:

   Optional[bool] with filtering logic = correct [OK]

Hint: Use Optional[bool] and check None to handle missing query param [OK]

Common Mistakes:

• Using bool without Optional for optional parameter
• Not filtering items based on Boolean value
• Using string type instead of Boolean