2. Tutorials
  3. Retrieve a Request’s IP Address in Node.js

Retrieve a Request’s IP Address in Node.js

Web frameworks in Node.js provide a request object containing information from the requesting instance. The request object typically includes the IP address of the requesting client. If you want to geo-locate the requesting user, the IP address is helpful.

This tutorial shows you how to retrieve the client IP address from a request instance in Node.js.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  1. Filter Data in Streams
  1. Get Number of Seconds Since Epoch in JavaScript
  2. Get Tomorrow’s Date in JavaScript
  3. Increase a Date in JavaScript by One Week
  4. Add Seconds to a Date in Node.js and JavaScript
  5. Add Month(s) to a Date in JavaScript or Node.js
  6. Add Week(s) to a Date in JavaScript or Node.js
  7. Get the Current Year in JavaScript or Node.js
  8. How to Get a UNIX Timestamp in JavaScript or Node.js
  9. How to Convert a UNIX Timestamp to a Date in JavaScript or Node.js
  10. Add Days to a Date in JavaScript or Node.js
  11. Get Yesterday's Date in JavaScript or Node.js
  1. How to Run an Asynchronous Function in Array.map()
  2. How to Reset and Empty an Array
  3. for…of vs. for…in Loops
  4. Clone/Copy an Array in JavaScript and Node.js
  5. Get an Array With Unique Values (Delete Duplicates)
  6. Sort an Array of Integers in JavaScript and Node.js
  7. Sort a Boolean Array in JavaScript, TypeScript, or Node.js
  8. Check If an Array Contains a Given Value in JavaScript or Node.js
  9. Add an Item to the Beginning of an Array in JavaScript or Node.js
  10. Append an Item at the End of an Array in JavaScript or Node.js
  11. How to Exit and Stop a for Loop in JavaScript and Node.js
  12. Split an Array Into Smaller Array Chunks in JavaScript and Node.js
  13. How to Get an Index in a for…of Loop in JavaScript and Node.js
  14. How to Exit, Stop, or Break an Array#forEach Loop in JavaScript or Node.js
  15. Retrieve a Random Item From an Array in JavaScript or Node.js
  16. How to Reverse an Array in JavaScript and Node.js
  1. Callback and Promise Support in your Node.js Modules
  2. Run Async Functions/Promises in Sequence
  3. Run Async Functions/Promises in Parallel
  4. Run Async Functions in Batches
  5. How to Fix “Promise resolver undefined is not a function” in Node.js or JavaScript
  6. Detect if Value Is a Promise in Node.js and JavaScript
  7. Overview of Promise-Based APIs in Node.js
  1. Human-Readable JSON.stringify() With Spaces and Line Breaks
  2. Write a JSON Object to a File
  3. Create a Custom “toJSON” Function in Node.js and JavaScript
  4. Securely Parse JSON
  1. Check If a Value Is Iterable in JavaScript or Node.js
  1. Extend Multiple Classes (Multi Inheritance)
  2. Retrieve the Class Name at Runtime in JavaScript and Node.js
  1. Generate a Random Number in Range With JavaScript/Node.js
  2. Ensure a Positive Number in JavaScript or Node.js
  1. How to Merge Objects
  2. How to Check if an Object is Empty in JavaScript or Node.js
  3. How to CamelCase Keys of an Object in JavaScript or Node.js
  4. How to Snake_Case Keys of an Object in JavaScript or Node.js
  5. How to Destructure a Dynamic Key in JavaScript or Node.js
  6. How to Get All Keys (Including Symbols) from an Object in JavaScript or Node.js
  7. How to Delete a Key From an Object in JavaScript or Node.js
  8. Iterate Through an Object’s Keys and Values in JavaScript or Node.js
  1. Get a File’s Created Date
  2. Get a File’s Last Modified or Updated Date of a File
  3. How to Create an Empty File
  4. Check If a Path or File Exists
  5. How to Rename a File
  6. Check If a Path Is a Directory
  7. Check If a Path Is a File
  8. Retrieve the Path to the User’s Home Directory
  9. How to Touch a File
  10. Read File Content as String
  11. Check If a Directory Is Empty
  12. How to Create a Directory (and Parents If Needed)
  13. Get a File‘s Extension
  14. Get the Size of a File
  15. Get a File Name (With or Without Extension)
  16. Read a JSON File
  1. Create From Object
  2. Transform to an Object
  1. Determine the Node.js Version Running Your Script
  1. Check if a Value is a Symbol in JavaScript or Node.js
  1. Detect if Running on Linux
  2. Detect if Running on macOS
  3. Detect if Running on Windows
  4. Check if Running on 64bit or 32bit Platform
  1. How to Download a File

Get the Request IP Address

The request can carry the client’s IP address in different locations. For example, it may be stored in an HTTP request header like x-forwarded-for, in one of the request properties like request.connection, request.socket, request.info, or request.raw.

Serverless environments provide a request context. For example, in AWS Lambda functions using AWS API Gateway you may have the IP address stored in an identity property carrying the sourceIp.

The @supercharge/request-ip package streamlines the process retrieving the request’s IP address. It checks dozens of possible locations and returns the found IP address.

At first, install the package as a dependency of your project:

npm install @supercharge/request-ip

Then, go ahead and retrieve IP address from the request object like this:

const RequestIp = require('@supercharge/request-ip')

const ip = RequestIp.getClientIp(request)

// for example '213.211.254.97' as an IP v4 address
// or '2001:0db8:85a3:0000:0000:8a2e:0370:7334' as an IP v6 address
// or 'undefined' if no IP address is available on the given request

That’s it. Pass the request object to the RequestIp.getClientIp(request) function and it returns the IP address (or undefined if nothing was found).

Detect the IP Address in Frameworks Like Express/hapi/Fastify/Koa/Co.

Depending on your web framework of choice and use case, you may need to retrieve the IP address in a middleware or route handler.

Here are two basic examples showing how to retrieve the IP address in an Express middleware and hapi route handler:

simple Express middleware example

const RequestIp = require('@supercharge/request-ip')

const expressMiddleware = function (req, res, next) {  
  req.ip = RequestIp.getClientIp(req)

  next()
}

simple hapi route handler example:

const Hapi = require('@hapi/hapi')  
const RequestIp = require('@supercharge/request-ip')

const server = new Hapi.Server({  
  host: 'localhost'
})

server.route({  
  method: 'GET',
  path: '/login',
  handler: (request, h) => {
    const ip = RequestIp.getClientIp(request)

    return h.response(ip)
  }
})

The @supercharge/request-ip package comes handy when retrieving a client’s IP address from a request instance!

Mentioned Resources

Marcus Pöhls

Marcus is a fullstack JS developer. He’s passionate about the hapi framework for Node.js and loves to build web apps and APIs. Creator of Futureflix and the “learn hapi” learning path.

Explore the Library

Find interesting tutorials and solutions for your problems.

Android

Node.js

Server

Miscellaneous