How to get URL query string in API route in Next.js?

Question

I have a constant that uses the request query to pull into my API the name and town values of the URL parameters.

This works great. What I can't work out, I've looked at a number of articles but I want to return the full set of parameters from the URL, either as an array or a string. If it includes the URL path it's no problem, ideally just the parameters ampersand separated or any other way.

I need to do so as this API captures a set of question responses that may change over time, and I need the flexibility to loop over all the answers returned irrelevant if its 10 or 100.

export default async function (req, res) {
    const {
        query: name ,
        query: town ,
    } = req
    // ...
}

Not sure if I understood your question correctly, but don't you have access to req.url, which contains the full URL including the query params? — juliomalves
– juliomalves, Commented Jan 30, 2021 at 14:50
Thanks Juliomalves, I was looking for a reference of the properties on req, but all I found was numerous examples not the properties... if you post it, I'll mark it as the anwser. — Carl Bruiners
– Carl Bruiners, Commented Jan 30, 2021 at 14:53

juliomalves · Accepted Answer · 2021-12-06 22:20:56Z

9

You can access the query params as a string from req.url which contains the full URL including the query params.

export default async function (req, res) {
    console.log(req.url) // Logs: '/api/info?name=john&town=london'
}

For more details on the req object check Node.js official documentation.

Alternatively, you can also get the query params as an object from the req.query object, which you can manipulate however you like.

export default async function (req, res) {
    console.log(req.query) // Logs: { name: 'john', town: 'london' }
}

edited Dec 6, 2021 at 22:20

answered Jan 30, 2021 at 15:00

juliomalves

51.1k23 gold badges180 silver badges170 bronze badges

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

Collectives™ on Stack Overflow

How to get URL query string in API route in Next.js?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related