Get local IP address in Node js

Question

I have a simple Node js program running on my machine and I want to get the local IP address of a PC on which my program is running  How do I get it with Node js

User · Answer

The correct one-liner for both Underscore js and Lodash is  var ip   require  underscore        chain require  os   networkInterfaces         values        flatten        find  family   IPv4   internal  false        value        address

User · Answer

Here is a snippet of Node js code that will parse the output of ifconfig and  asynchronously  return the first IP address found   It was tested on Mac  OS  X  v10 6  Snow  Leopard  only  I hope it works on Linux too   var getNetworkIP    function          var ignoreRE      127  0  0  1   1 fe80  1    1         i       var exec   require  child process   exec      var cached      var command      var filterRE       switch  process platform               TODO  implement for OSes without the ifconfig command         case  darwin                command    ifconfig                filterRE     binet s     s    g                  filterRE     binet6 s     s    g     IPv6              break          default               command    ifconfig                filterRE     binet b       s     s    g                  filterRE     binet6       s     s    g     IPv6              break             return function  callback  bypassCache               Get cached value         if  cached  amp  amp   bypassCache                callback null  cached               return                        System call         exec command  function  error  stdout  sterr                var ips                      Extract IP addresses             var matches   stdout match filterRE                   JavaScript doesn t have any lookbehind regular expressions  so we need a trick             for  var i   0  i  lt  matches length  i                      ips push matches i  replace filterRE    1                                   Filter BS             for  var i   0  l   ips length  i  lt  l  i                      if   ignoreRE test ips i                            if   error                            cached   ips i                                               callback error  ips i                        return                                                 Nothing found             callback error  null                             Usage example  getNetworkIP function  error  ip        console log ip       if  error            console log  error    error            false    If the second parameter is true  the function will execute a system call every time  otherwise the cached value is used   Updated version Returns an array of all local network addresses  Tested on Ubuntu 11 04  Natty Narwhal  and Windows XP 32 var getNetworkIPs    function          var ignoreRE      127  0  0  1   1 fe80  1    1         i       var exec   require  child process   exec      var cached      var command      var filterRE       switch  process platform            case  win32             case  win64      TODO  test             command    ipconfig               filterRE     bIPv 46     r n    s     s    g              break          case  darwin               command    ifconfig               filterRE     binet s     s    g                 filterRE     binet6 s     s    g     IPv6             break          default              command    ifconfig               filterRE     binet b       s     s    g                 filterRE     binet6       s     s    g     IPv6             break             return function  callback  bypassCache            if  cached  amp  amp   bypassCache                callback null  cached               return                        System call         exec command  function  error  stdout  sterr                cached                   var ip              var matches   stdout match filterRE                       if   error                for  var i   0  i  lt  matches length  i                      ip   matches i  replace filterRE    1                   if   ignoreRE test ip                         cached push ip                                                               callback error  cached                             Usage Example for updated version getNetworkIPs function  error  ip    console log ip   if  error        console log  error    error        false

User · Answer

Your local IP address is always 127 0 0 1  Then there is the network IP address  which you can get from ifconfig   nix  or ipconfig  win   This is only useful within the local network  Then there is your external public IP address  which you can only get if you can somehow ask the router for it  or you can setup an external service which returns the client IP address whenever it gets a request  There are also other such services in existence  like whatismyip com  In some cases  for instance if you have a WAN connection  the network IP address and the public IP are the same  and can both be used externally to reach your computer  If your network and public IP addresses are different  you may need to have your network router forward all incoming connections to your network IP address   Update 2013  There s a new way of doing this now  You can check the socket object of your connection for a property called localAddress  e g  net socket localAddress  It returns the address on your end of the socket  The easiest way is to just open a random port and listen on it  and then get your address and close the socket   Update 2015  The previous doesn t work anymore

User · Answer

Here s my utility method for getting the local IP address  assuming you are looking for an IPv4 address and the machine only has one real network interface  It could easily be refactored to return an array of IP addresses for multi-interface machines  function getIPAddress       var interfaces   require  os   networkInterfaces      for  var devName in interfaces        var iface   interfaces devName        for  var i   0  i  lt  iface length  i            var alias   iface i         if  alias family      IPv4   amp  amp  alias address      127 0 0 1   amp  amp   alias internal          return alias address              return  0 0 0 0

User · Answer

I was able to do this using just Node js  As Node js  var os   require   os     var networkInterfaces   Object values os networkInterfaces         reduce  r a    gt            r   r concat a          return r                  filter   family  address     gt            return family toLowerCase   indexOf  v4    gt   0  amp  amp              address      127 0 0 1              map   address     gt  address   var ipAddresses   networkInterfaces join       console log ipAddresses    As Bash script  needs Node js installed  function ifconfig2          node -e  quot  quot  quot          var os   require   os             var networkInterfaces   Object values os networkInterfaces                 reduce  r a   gt                   r   r concat a                  return r                                  filter   family  address     gt                    return family toLowerCase   indexOf  v4    gt   0  amp  amp                      address      127 0 0 1                              map   address     gt  address           var ipAddresses   networkInterfaces join               console log ipAddresses        quot  quot  quot

User · Answer

Use  var os   require  os    var networkInterfaces   os networkInterfaces    var arr   networkInterfaces  Local Area Connection 3   var ip   arr 1  address

User · Answer

https   github com indutny node-ip  var ip   require  ip    console dir   ip address

User · Answer

The accepted answer is asynchronous  I wanted a synchronous version  var os   require  os    var ifaces   os networkInterfaces     console log JSON stringify ifaces  null  4     for  var iface in ifaces      var iface   ifaces iface     for  var alias in iface        var alias   iface alias        console log JSON stringify alias  null  4         if   IPv4      alias family    alias internal     false          debug  quot skip over internal  i e  127 0 0 1  and non-IPv4 addresses quot          continue            console log  quot Found IP address   quot    alias address       return alias address        return false

User · Answer

Here is a variation of the previous examples  It takes care to filter out VMware interfaces  etc  If you don t pass an index it returns all addresses  Otherwise  you may want to set it default to 0 and then just pass null to get all  but you ll sort that out  You could also pass in another argument for the regex filter if so inclined to add  function getAddress idx         var addresses               interfaces   os networkInterfaces            name  ifaces  iface       for  name in interfaces            if interfaces hasOwnProperty name                ifaces   interfaces name               if    loopback vmware internal  gi test name                    for  var i   0  i  lt  ifaces length  i                          iface   ifaces i                       if  iface family      IPv4   amp  amp    iface internal  amp  amp  iface address      127 0 0 1                             addresses push iface address                                                                                 If an index is passed only return it      if idx  gt   0          return addresses idx       return addresses

User · Answer

I wrote a Node js module that determines your local IP address by looking at which network interface contains your default gateway   This is more reliable than picking an interface from os networkInterfaces   or DNS lookups of the hostname  It is able to ignore VMware virtual interfaces  loopback  and VPN interfaces  and it works on Windows  Linux  Mac OS  and FreeBSD  Under the hood  it executes route exe or netstat and parses the output   var localIpV4Address   require  local-ipv4-address     localIpV4Address   then function ipAddress       console log  My IP address is     ipAddress          My IP address is 10 4 4 137

User · Answer

For Linux and macOS uses  if you want to get your IP addresses by a synchronous way  try this  var ips   require  child process   execSync  quot ifconfig   grep inet   grep -v inet6   awk   gsub  addr     quot   quot   print  2   quot   toString   trim   split  quot  n quot    console log ips    The result will be something like this    192 168 3 2    192 168 2 1

User · Answer

Similar to other answers but more succinct    use strict    const interfaces   require  os   networkInterfaces     const addresses   Object keys interfaces     reduce  results  name    gt  results concat interfaces name           filter  iface    gt  iface family      IPv4   amp  amp   iface internal     map  iface    gt  iface address

User · Answer

Many times I find there are multiple internal and external facing interfaces available  example  10 0 75 1  172 100 0 1  192 168 2 3    and it s the external one that I m really after  172 100 0 1    In case anyone else has a similar concern  here s one more take on this that hopefully may be of some help     const address   Object keys os networkInterfaces           flatten interfaces to an array      reduce  a  key    gt               a             os networkInterfaces   key                    non-internal ipv4 addresses only      filter iface   gt  iface family      IPv4   amp  amp   iface internal         project ipv4 address as a 32-bit number  n       map iface   gt       iface  n   d   gt         d 0   256    d 1    256    d 2    256    d 3    iface address split                 set a hi-bit on  n  for reserved addresses so they will sort to the bottom      map iface   gt  iface address startsWith  10       iface address startsWith  192          iface  n  Math pow 2 32    iface n    iface         sort ascending on  n       sort  a  b    gt  a n - b n       0      address

User · Answer

Here s a variation that allows you to get local IP address  tested on Mac and Windows    var        Local IP address that we re trying to calculate     address        Provides a few basic operating-system related utility functions  built-in       os   require  os          Network interfaces      ifaces   os networkInterfaces         Iterate over interfaces     for  var dev in ifaces                and find the one that matches the criteria     var iface   ifaces dev  filter function details            return details family      IPv4     details internal     false               if iface length   0          address   iface 0  address        Print the result console log address      10 25 10 147

User · Answer

Google directed me to this question while searching for  quot Node js get server IP quot   so let s give an alternative answer for those who are trying to achieve this in their Node js server program  may be the case of the original poster   In the most trivial case where the server is bound to only one IP address  there should be no need to determine the IP address since we already know to which address we bound it  for example  the second parameter passed to the listen   function   In the less trivial case where the server is bound to multiple IP addresses  we may need to determine the IP address of the interface to which a client connected  And as briefly suggested by Tor Valamo  nowadays  we can easily get this information from the connected socket and its localAddress property  For example  if the program is a web server  var http   require  quot http quot    http createServer function  req  res        console log req socket localAddress      res end req socket localAddress     listen 8000   And if it s a generic TCP server  var net   require  quot net quot    net createServer function  socket        console log socket localAddress      socket end socket localAddress     listen 8000   When running a server program  this solution offers very high portability  accuracy and efficiency  For more details  see   http   nodejs org api net html http   nodejs org api http html

User · Answer

Here is a multi-IP address version of jhurliman s answer  function getIPAddresses          var ipAddresses            var interfaces   require  os   networkInterfaces        for  var devName in interfaces            var iface   interfaces devName           for  var i   0  i  lt  iface length  i                  var alias   iface i               if  alias family      IPv4   amp  amp  alias address      127 0 0 1   amp  amp   alias internal                    ipAddresses push alias address                                     return ipAddresses

User · Answer

Based on a comment  here s what s working for the current version of Node js  var os   require  os    var     require  lodash     var ip     chain os networkInterfaces       values      flatten      filter function val        return  val family     IPv4   amp  amp  val internal    false          pluck  address      first      value     The comment on one of the answers above was missing the call to values    It looks like os networkInterfaces   now returns an object instead of an array

User · Answer

If you re into the whole brevity thing  here it is using Lodash   x000D   x000D  var os   require  os    var     require  lodash    var firstLocalIp     os networkInterfaces    values   flatten   where   family   IPv4   internal  false    pluck  address   first     console log  First local IPv4 address is     firstLocalIp   x000D   x000D   x000D

User · Answer

Install a module called ip like  npm install ip  Then use this code  var ip   require  quot ip quot    console log ip address

User · Answer

The bigger question is  quot Why  quot  If you need to know the server on which your Node js instance is listening on  you can use req hostname

User · Answer

All I know is I wanted the IP address beginning with 192 168   This code will give you that   function getLocalIp         const os   require  os         for let addresses of Object values os networkInterfaces               for let add of addresses                if add address startsWith  192 168                       return add address                                    Of course you can just change the numbers if you re looking for a different one

User · Answer

Using internal-ip   const internalIp   require  internal-ip    console log internalIp v4 sync

User · Answer

One liner for macOS first localhost address only  When developing applications on macOS  and you want to test it on the phone  and need your app to pick the localhost IP address automatically  require  os   networkInterfaces   en0 find elm   gt  elm family   IPv4   address   This is just to mention how you can find out the ip address automatically  To test this you can go to terminal hit  node os networkInterfaces   en0 find elm   gt  elm family   IPv4   address   output will be your localhost IP address

User · Answer

Here s what might be the cleanest  simplest answer without dependencies  amp  that works across all platforms   const   lookup     require  dns   promises  const   hostname     require  os     async function getMyIPAddress options      return  await lookup hostname    options        address

User · Answer

For anyone interested in brevity  here are some  quot one-liners quot  that do not require plugins dependencies that aren t part of a standard Node js installation  Public IPv4 and IPv6 address of eth0 as an array  var ips   require  os   networkInterfaces   eth0 map function interface        return interface address       First public IP address of eth0  usually IPv4  as a string  var ip   require  os   networkInterfaces   eth0 0  address

User · Answer

Use the npm ip module  var ip   require  ip     console log ip address       gt   192 168 0 117

User · Answer

Calling ifconfig is very platform-dependent  and the networking layer does know what IP addresses a socket is on  so best is to ask it  Node js doesn t expose a direct method of doing this  but you can open any socket  and ask what local IP address is in use  For example  opening a socket to www google com  var net   require  net    function getNetworkIP callback      var socket   net createConnection 80   www google com      socket on  connect   function         callback undefined  socket address   address       socket end            socket on  error   function e        callback e   error             Usage case  getNetworkIP function  error  ip        console log ip       if  error            console log  error    error

User · Answer

Here s my variant that allows getting both IPv4 and IPv6 addresses in a portable manner          Collects information about the local IPv4 IPv6 addresses of    every network interface on the local computer     Returns an object with the network interface name as the first-level key and     IPv4  or  IPv6  as the second-level key     For example you can use getLocalIPs   eth0 IPv6 to get the IPv6 address     as string  of eth0     getLocalIPs   function          var addrInfo  ifaceDetails   len      var localIPInfo             Get the network interfaces     var networkInterfaces   require  os   networkInterfaces          Iterate over the network interfaces     for  var ifaceName in networkInterfaces            ifaceDetails   networkInterfaces ifaceName             Iterate over all interface details         for  var  i   0   len   ifaceDetails length   i  lt   len   i                  addrInfo   ifaceDetails  i               if  addrInfo family      IPv4                       Extract the IPv4 address                 if   localIPInfo ifaceName                         localIPInfo ifaceName                                          localIPInfo ifaceName  IPv4   addrInfo address                else if  addrInfo family      IPv6                       Extract the IPv6 address                 if   localIPInfo ifaceName                         localIPInfo ifaceName                                          localIPInfo ifaceName  IPv6   addrInfo address                                    return localIPInfo       Here s a CoffeeScript version of the same function   getLocalIPs        gt              Collects information about the local IPv4 IPv6 addresses of       every network interface on the local computer      Returns an object with the network interface name as the first-level key and        IPv4  or  IPv6  as the second-level key      For example you can use getLocalIPs   eth0 IPv6 to get the IPv6 address        as string  of eth0             networkInterfaces   require  os   networkInterfaces        localIPInfo          for ifaceName  ifaceDetails of networkInterfaces         for addrInfo in ifaceDetails             if addrInfo family   IPv4                  if  localIPInfo ifaceName                      localIPInfo ifaceName                       localIPInfo ifaceName  IPv4   addrInfo address             else if addrInfo family   IPv6                  if  localIPInfo ifaceName                      localIPInfo ifaceName                       localIPInfo ifaceName  IPv6   addrInfo address     return localIPInfo   Example output for console log getLocalIPs       lo    IPv4   127 0 0 1   IPv6     1       wlan0    IPv4   192 168 178 21   IPv6   fe80  aa1a 2eee feba 1c39       tap0    IPv4   10 1 1 7   IPv6   fe80  ddf1 a9a1 1242 bc9b

User · Answer

This information can be found in os networkInterfaces        an object  that maps network interface names to its properties  so that one interface can  for example  have several addresses    use strict    const   networkInterfaces     require  os     const nets   networkInterfaces    const results   Object create null      Or just       an empty object  for  const name of Object keys nets         for  const net of nets name                Skip over non-IPv4 and internal  i e  127 0 0 1  addresses         if  net family      IPv4   amp  amp   net internal                if   results name                     results name                                  results name  push net address                          results       quot en0 quot          quot 192 168 1 101 quot          quot eth0 quot          quot 10 0 0 101 quot          quot  lt network name gt  quot          quot  lt ip gt  quot        quot  lt ip alias gt  quot        quot  lt ip alias gt  quot                     results  quot en0 quot   0   quot 192 168 1 101 quot

User · Answer

This is a modification of the accepted answer  which does not account for vEthernet IP addresses such as Docker  etc         Get local IP address  while ignoring vEthernet IP addresses  like from Docker  etc       let localIP  var os   require  os    var ifaces   os networkInterfaces    Object keys ifaces  forEach function  ifname       var alias   0      ifaces ifname  forEach function  iface          if   IPv4      iface family    iface internal     false                Skip over internal  i e  127 0 0 1  and non-IPv4 addresses          return                 if ifname      Ethernet              if  alias  gt   1                   This single interface has multiple IPv4 addresses                console log ifname         alias  iface address              else                  This interface has only one IPv4 address                console log ifname  iface address                         alias           localIP   iface address                     console log localIP    This will return an IP address like 192 168 2 169 instead of 10 55 1 1

User · Answer

If you dont want to install dependencies and are running a  nix system you can do  hostname -I  And you ll get all the addresses for the host  you can use that string in node  const exec   require  child process   exec  let cmd    quot hostname -I quot   exec cmd  function error  stdout  stderr      console log stdout   error   stderr        Is a one liner and you don t need other libraries like  os  or  node-ip  that may add accidental complexity to your code  hostname -h  Is also your friend  -  Hope it helps

User · Answer

An improvement on the top answer for the following reasons   Code should be as self-explanatory as possible   Enumerating over an array using for   in    should be avoided   for   in    enumeration should be validated to ensure the object s being enumerated over contains the property you re looking for  As JavaScript is loosely typed and the  for   in    can be handed any arbitrary object to handle  it s safer to validate the property we re looking for is available   var os   require  os         interfaces   os networkInterfaces         address       addresses            i       l       interfaceId       interfaceArray    for  interfaceId in interfaces         if  interfaces hasOwnProperty interfaceId              interfaceArray   interfaces interfaceId            l   interfaceArray length            for  i   0  i  lt  l  i    1                  address   interfaceArray i                 if  address family      IPv4   amp  amp   address internal                     addresses push address address                                         console log addresses

User · Answer

Any IP address of your machine you can find by using the os module - and that s native to Node js  var os   require  os     var networkInterfaces   os networkInterfaces     console log networkInterfaces    All you need to do is call os networkInterfaces   and you ll get an easy manageable list - easier than running ifconfig by leagues

User · Answer

Here s a simplified version in vanilla JavaScript to obtain a single IP address  function getServerIp        var os   require  os      var ifaces   os networkInterfaces      var values   Object keys ifaces  map function name        return ifaces name           values      concat apply     values  filter function val       return val family     IPv4   amp  amp  val internal    false           return values length   values 0  address    0 0 0 0

User · Answer

The following solution works for me const ip   Object values require  quot os quot   networkInterfaces             flat            filter  item    gt   item internal  amp  amp  item family      quot IPv4 quot            find Boolean  address

User · Answer

Running programs to parse the results seems a bit iffy  Here s what I use  require  dns   lookup require  os   hostname    function  err  add  fam      console log  addr      add       This should return your first network interface local IP address

User · Answer

I m using Node js 0 6 5    node -v v0 6 5  Here is what I do  var util   require  util    var exec   require  child process   exec   function puts error  stdout  stderr            util puts stdout      exec  quot hostname -i quot   puts

User · Answer

Here s a neat little one-liner for you which does this functionally   const ni   require  os   networkInterfaces    Object    keys ni     map interf   gt      ni interf  map o   gt   o internal  amp  amp  o family      IPv4   amp  amp  o address      reduce  a  b    gt  a concat b      filter o   gt  o     0

[javascript] Get local IP address in Node.js

Examples related to javascript

Examples related to node.js

Examples related to ip