Multiple filter parameters in Rest API

Introduction

Multiple filter parameters let you ask for specific data by using more than one condition. This helps you get exactly what you want from a big list.

You want to find all books by a certain author and published after a certain year.

You need to get all users who live in a specific city and have a certain subscription type.

You want to list products that are both in stock and cost less than a certain price.

You want to search for events happening in a date range and at a specific location.

Syntax

Rest API

GET /resource?filter1=value1&filter2=value2&filter3=value3

Each filter is added as a separate parameter joined by &.

The server uses all filters together to narrow down the results.

Examples

Get books written by Rowling published in 2007.

Rest API

GET /books?author=Rowling&year=2007

Get users who live in Paris and have a premium subscription.

Rest API

GET /users?city=Paris&subscription=premium

Get products that are in stock and cost 50 or less.

Rest API

GET /products?in_stock=true&max_price=50

Sample Program

This small web app returns books filtered by author and year if given. You can try URLs like /books?author=Rowling&year=2007 to see filtered results.

Rest API

from flask import Flask, request, jsonify

app = Flask(__name__)

# Sample data
books = [
    {"title": "Book A", "author": "Rowling", "year": 2007},
    {"title": "Book B", "author": "Tolkien", "year": 1954},
    {"title": "Book C", "author": "Rowling", "year": 2005}
]

@app.route('/books')
def get_books():
    author = request.args.get('author')
    year = request.args.get('year', type=int)

    filtered = books
    if author:
        filtered = [b for b in filtered if b['author'] == author]
    if year:
        filtered = [b for b in filtered if b['year'] == year]

    return jsonify(filtered)

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Filters are combined with AND logic: all conditions must be true.

Order of parameters does not matter.

Always encode special characters in URLs (like spaces).

Summary

Multiple filter parameters help you get specific data by combining conditions.

Use & to add more filters in the URL.

The server returns only items matching all filters.

Practice

1. What does adding multiple filter parameters in a REST API URL do?
example.com/api/items?color=red&size=medium

easy

A. Returns items that match all filter conditions (color red AND size medium).

B. Returns items that match any one of the filter conditions (color red OR size medium).

C. Returns all items ignoring the filters.

D. Returns an error because multiple filters are not allowed.

Solution

1. Step 1: Understand multiple filters in URL

   Multiple filters joined by & mean the server should apply all conditions together.

2. Step 2: Interpret the example URL

   The URL ?color=red&size=medium means items must be red AND medium size.

3. Final Answer:

   Returns items that match all filter conditions (color red AND size medium). -> Option A

4. Quick Check:

   Multiple filters = AND condition [OK]

Hint: Multiple filters joined by & mean AND condition [OK]

Common Mistakes:

• Thinking filters work as OR instead of AND
• Assuming filters are ignored
• Believing multiple filters cause errors

2. Which of the following is the correct syntax to filter items by category=books and author=doe in a REST API URL?

easy

A. example.com/api/items?category=books;author=doe

B. example.com/api/items?category=books&author=doe

C. example.com/api/items?category=books|author=doe

D. example.com/api/items?category=books author=doe

Solution

1. Step 1: Identify correct separator for multiple filters

   In URLs, multiple query parameters are separated by &.

2. Step 2: Check each option

   Only example.com/api/items?category=books&author=doe uses & correctly between filters.

3. Final Answer:

   example.com/api/items?category=books&author=doe -> Option B

4. Quick Check:

   Use & to separate filters [OK]

Hint: Use & to separate multiple filters in URL [OK]

Common Mistakes:

• Using | or ; instead of &
• Leaving spaces between parameters
• Not using any separator

3. Given the REST API call:
GET /products?color=blue&size=large&in_stock=true
What kind of products will the server return?

medium

A. Products that are blue AND large AND in stock.

B. Products that are blue OR large OR in stock.

C. Products that are either blue or large, ignoring stock status.

D. All products regardless of filters.

Solution

1. Step 1: Understand multiple filters joined by &

   Filters combined with & mean all conditions must be true together.

2. Step 2: Apply to given filters

   Only products that are blue, large, and in stock will be returned.

3. Final Answer:

   Products that are blue AND large AND in stock. -> Option A

4. Quick Check:

   Multiple filters = AND condition [OK]

Hint: Multiple filters joined by & mean AND condition [OK]

Common Mistakes:

• Thinking filters combine with OR
• Ignoring some filters
• Assuming filters are optional

4. You wrote this URL to filter users by age=30 and active=true:
example.com/api/users?age=30&active=true&
But the server returns an error. What is the likely problem?

medium

A. The URL should use commas instead of &.

B. The server does not support filtering by age.

C. The filter values must be in quotes.

D. The trailing & at the end causes a syntax error.

Solution

1. Step 1: Check URL syntax for filters

   A trailing & at the end of query parameters is invalid syntax.

2. Step 2: Understand server error cause

   The server likely rejects the URL because of the extra & with no following parameter.

3. Final Answer:

   The trailing & at the end causes a syntax error. -> Option D

4. Quick Check:

   Trailing & causes error [OK]

Hint: Avoid trailing & in URL query parameters [OK]

Common Mistakes:

• Leaving trailing & at end of URL
• Using commas instead of &
• Assuming quotes are needed around values

5. You want to get all orders from the REST API where status is shipped and total is greater than 100. The API supports filtering by multiple parameters but only exact matches. How can you combine filters to get orders with status=shipped and total>100?

hard

A. Use ?status=shipped&total=100 and filter results manually.

B. Use ?status=shipped&total=gt:100 to specify greater than.

C. Use ?status=shipped&total_min=101 if the API supports range filters.

D. Use ?status=shipped&total>100 directly in URL.

Solution

1. Step 1: Understand API filter limitations

   The API only supports exact matches, so direct > operator is not allowed.

2. Step 2: Use API-supported range filter parameter

   Many APIs use parameters like total_min to filter values greater than a number.

3. Step 3: Combine filters correctly

   Using ?status=shipped&total_min=101 filters orders with status shipped and total greater than 100.

4. Final Answer:

   Use ?status=shipped&total_min=101 if the API supports range filters. -> Option C

5. Quick Check:

   Use API range params for > filters [OK]

Hint: Use API-specific range filters like total_min for > conditions [OK]

Common Mistakes:

• Trying to use > directly in URL
• Assuming all APIs support gt: syntax
• Filtering manually after fetching all data