Passing a list as a query parameter to FastAPI [duplicate]

Question

I have an endpoint like this:

@app.get("/Corr")
async def Corr(symbols : list, sample : str) -> List[CorrItem]:

I would like to call it with a list of symbols like this:

http://endpoint.com/Corr?symbols=[GOOG, MSFT]&sample=M

I am getting a runtime error:

HTTP/1.1" 422 Unprocessable Entity

You may also want to have a look here and here, as well as here, here and here — Chris
– Chris, Commented May 12, 2023 at 17:01

M.O. · Accepted Answer · 2023-05-12 14:27:11Z

2

The way to send a list in an HTTP request,^* as described in the FastAPI documentation is to send the same query parameter several times:

http://endpoint.com/Corr?symbols=GOOG&symbols=MSFT&sample=M

^* There are other ways used in HTTP requests, but this is the one accepted by FastAPI

answered May 12, 2023 at 14:27

M.O.

3,3981 gold badge11 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ivan Over a year ago

Thanks. That got me farther. However with the signature of def Corr as given, I can't call it at runtime. Can you give an example of what the signature of the function looks like?

MatsLindh Over a year ago

def corr(symbols: List[str], sample: str)

Chris Over a year ago

@MatsLindh You would need to define the query parameter (i.e., symbols) explicitly with Query; otherwise, it would be interpreted as a request body. Please have a look at the link provided above.

Collectives™ on Stack Overflow

Passing a list as a query parameter to FastAPI [duplicate]

1 Answer 1

3 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Linked

Related