Expo

Get Started
API Reference

Network

expo-network provides useful information about the device's network such as its IP address, MAC address, and airplane mode status.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-network

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

Configuration

On Android, this module requires permissions to access the network and Wi-Fi state. The permissions ACCESS_NETWORK_STATE and ACCESS_WIFI_STATE are added automatically.

API

import * as Network from 'expo-network';

Methods

Network.getIpAddressAsync()

Gets the device's current IPv4 address. Returns `0.0.0.0`` if the IP address could not be retrieved.

On web, this method uses the third-party ipify service to get the public IP address of the current device.

Returns

  • Promise<string>

A Promise that fulfils with a string of the current IP address of the device's main network interface. Can only be IPv4 address.

Example

await Network.getIpAddressAsync();
// "92.168.32.44"

Network.getMacAddressAsync(interfaceName)

This method is deprecated and will be removed in a future SDK version.

Arguments

  • interfaceName (string | null) - A string representing interface name (eth0, wlan0) or null (default), meaning the method should fetch the MAC address of the first available interface.

Gets the specified network interface's MAC address.

Beginning with iOS 7 and Android 11, non-system applications can no longer access the device's MAC address. In SDK 41 and above, this method will always resolve to a predefined value that isn't useful.

If you need to identify the device, use the getIosIdForVendorAsync() method / androidId property of the expo-application unimodule instead.

Returns

A Promise that fulfils with the value '02:00:00:00:00:00'.

Network.getNetworkStateAsync()

Gets the device's current network connection state.

On web, navigator.connection.type is not available on browsers. So if there is an active network connection, the field type returns NetworkStateType.UNKNOWN. Otherwise, it returns NetworkStateType.NONE.

Returns

A Promise that fulfils with a NetworkState object.

Example

await Network.getNetworkStateAsync();
// {
//   type: NetworkStateType.CELLULAR,
//   isConnected: true,
//   isInternetReachable: true,
// }

Network.isAirplaneModeEnabledAsync()

Android only. Tells if the device is in airplane mode.

Returns

Returns a Promise that fulfils with a boolean value for whether the device is in airplane mode or not.

Example

await Network.isAirplaneModeEnabledAsync();
// false

Types

NetworkState

NameTypeDescription
isConnected
(optional)		booleanIf there is an active network connection. Note that this does not mean that internet is reachable. This field is false if the type is either Network.NetworkStateType.NONE or Network.NetworkStateType.UNKNOWN, true otherwise.
isInternetReachable
(optional)		booleanIf the internet is reachable with the currently active network connection. On Android, this depends on NetInfo.isConnected() (API level < 29) or ConnectivityManager.getActiveNetwork() (API level >= 29). On iOS, this value will always be the same as isConnected.
type
(optional)		NetworkStateTypeA NetworkStateType enum value that represents the current network connection type.

Enums

NetworkStateType

An enum of the different types of devices supported by Expo.

  • NetworkStateType.BLUETOOTH : "BLUETOOTH" - Active network connection over Bluetooth.
  • NetworkStateType.CELLULAR : "CELLULAR" - Active network connection over mobile data or DUN-specific mobile connection when setting an upstream connection for tethering.
  • NetworkStateType.ETHERNET : "ETHERNET" - Active network connection over Ethernet.
  • NetworkStateType.NONE : "NONE" - No active network connection detected.
  • NetworkStateType.OTHER : "OTHER" - Active network connection over other network connection types.
  • NetworkStateType.UNKNOWN : "UNKNOWN" - The connection type could not be determined.
  • NetworkStateType.VPN : "VPN" - Active network connection over VPN.
  • NetworkStateType.WIFI : "WIFI" - Active network connection over WiFi.
  • NetworkStateType.WIMAX : "WIMAX" - Active network connection over Wimax.

Error Codes

CodeDescription
ERR_NETWORK_IP_ADDRESSOn Android, there may be an unknown Wifi host when trying to access WifiManager in getIpAddressAsync. On iOS, no network interfaces could be retrieved.
ERR_NETWORK_UNDEFINED_INTERFACEAn undefined interfaceName was passed as an argument in getMacAddressAsync.
ERR_NETWORK_SOCKET_EXCEPTIONAn error was encountered in creating or accessing the socket in getMacAddressAsync.
ERR_NETWORK_INVALID_PERMISSION_INTERNETThere are invalid permissions for android.permission.ACCESS_WIFI_STATE in getMacAddressAsync.
ERR_NETWORK_NO_ACCESS_NETWORKINFOUnable to access network information