> For AI agents: the complete documentation index is available at /react-native-nitro-device-info/llms.txt, the full documentation bundle is available at /react-native-nitro-device-info/llms-full.txt.

# API Reference Overview

Choose the API entry point before copying an example. The root API and `/compat` API have different names and return types.

## Entry points

| Import                                                                      | Purpose                                         | Example                                                                             |
| --------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------- |
| `{ DeviceInfoModule }` from `react-native-nitro-device-info`                | Native properties and methods                   | `DeviceInfoModule.model`                                                            |
| `DeviceInfo` from `react-native-nitro-device-info/compat`                   | `react-native-device-info` 15.x-style functions | `DeviceInfo.getModel()`                                                             |
| `{ useBatteryLevel }` from `react-native-nitro-device-info`                 | React hook returning a value                    | `number \| null`                                                                    |
| `{ useIsHeadphonesConnected }` from `react-native-nitro-device-info/compat` | Compatibility hook result                       | `{ loading, result }`                                                               |
| `{ DeviceIntegrityModule }` from `react-native-nitro-device-integrity`      | Device attestation with backend verification    | See [Device Attestation](/react-native-nitro-device-info/api/device-attestation.md) |

`DeviceInfo` from the root is a TypeScript type. It is not a default runtime object. See [Migration](/react-native-nitro-device-info/api/migration.md) for compatibility caveats.

## Availability badges

Each API section shows its introduction version and current platform behavior. Grouped properties have badges in their table rows.

<span class="rp-badge rp-badge--tip">Since v1.3.0</span> <span class="rp-badge rp-badge--info">iOS 15.1+</span> <span class="rp-badge rp-badge--info">Android API 24+</span> <span class="rp-badge rp-badge--warning">Web: fallback</span>

- **Since** identifies the first published release with this member name and property or method form. Earlier releases may have different return types or behavior. It does not mean that every platform implemented the feature in that release.
- **iOS / Android** identifies a functional native implementation. The number is an OS minimum, not a package version. A separate `since v…` inside the platform badge identifies a later functional implementation. The current core package requires iOS 15.1+ and Android API 24+; dependencies can raise these minimums.
- **Limited** identifies an estimate, restricted implementation, or browser API dependency. Read the section's limitations before using the result.
- **Fallback** identifies an unsupported operation that returns a fixed default. **Rejects** identifies a method that fails on that platform.
- **Unreleased** identifies an implementation on `main` that has not reached a published npm release. It is not a version number.

Web entry points and their fallback values are available from **v1.8.0**. A `Web: limited` badge identifies browser-derived values. Browser permissions, API availability, and SSR can still produce fallbacks. A fallback does not provide the native feature.

The iOS camera and device-authentication implementations are available from v1.9.0. Core releases through v1.8.3 expose those names but return constants on iOS.

### Version evidence

Introduction versions were checked against [published npm versions and their `gitHead` values](https://registry.npmjs.org/react-native-nitro-device-info). These source snapshots show the relevant member declarations:

| Published version | Source                                                                                                                                                                                                                                                               |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| v0.1.0            | [Initial interface](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/0.1.0/src/DeviceInfo.nitro.ts)                                                                                                                                                  |
| v1.1.0            | [Expanded interface](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.1.0/src/DeviceInfo.nitro.ts)                                                                                                                                                |
| v1.2.0            | [Property-based interface](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.2.0/src/DeviceInfo.nitro.ts)                                                                                                                                          |
| v1.2.1            | [Key-store and Liquid Glass declarations](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.2.1/src/DeviceInfo.nitro.ts)                                                                                                                           |
| v1.3.0            | [Runtime getter interface](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.3.0/src/DeviceInfo.nitro.ts)                                                                                                                                          |
| v1.4.0            | [React hook exports](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.4.0/src/hooks/index.ts)                                                                                                                                                     |
| v1.4.2            | [Local integrity and Expo Device parity declarations](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.4.2/src/DeviceInfo.nitro.ts)                                                                                                               |
| v1.5.0            | [Carrier and build-field declarations](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.5.0/packages/react-native-nitro-device-info/src/DeviceInfo.nitro.ts)                                                                                      |
| v1.8.0            | [Functional iOS async wrappers](https://github.com/l2hyunwoo/react-native-nitro-device-info/commit/cb6eb026) and [web entry point](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/v1.8.0/packages/react-native-nitro-device-info/src/index.web.ts) |

## Native API by task

These members belong to `DeviceInfoModule`. Parentheses identify methods; entries without parentheses are properties.

| Task                                                 | Example members                                                                    | Reference                                                                                                           |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Identify the model and OS                            | `deviceId`, `model`, `systemVersion`, `deviceType`                                 | [Core Device Information](/react-native-nitro-device-info/api/device-info.md#core-device-information-9-apis)        |
| Read identifiers                                     | `uniqueId`, `manufacturer`, `deviceName`                                           | [Core Device Information](/react-native-nitro-device-info/api/device-info.md#core-device-information-9-apis)        |
| Check hardware                                       | `isTablet`, `isEmulator`, `isCameraPresent`, `isPinOrFingerprintSet`               | [Device Capabilities](/react-native-nitro-device-info/api/device-info.md#device-capabilities-7-apis)                |
| Read display information                             | `getHasNotch()`, `getHasDynamicIsland()`, `getIsLandscape()`, `getBrightness()`    | [Display & Screen](/react-native-nitro-device-info/api/device-info.md#display--screen-7-apis)                       |
| Read memory and storage                              | `totalMemory`, `getUsedMemory()`, `totalDiskCapacity`, `getFreeDiskStorage()`      | [System Resources](/react-native-nitro-device-info/api/device-info.md#system-resources-7-apis)                      |
| Read battery state                                   | `getBatteryLevel()`, `getPowerState()`, `getIsBatteryCharging()`                   | [Battery & Power](/react-native-nitro-device-info/api/device-info.md#battery--power-4-apis)                         |
| Read app metadata                                    | `version`, `buildNumber`, `bundleId`, `getFirstInstallTime()`                      | [Application Metadata](/react-native-nitro-device-info/api/device-info.md#application-metadata-9-apis)              |
| Read network information                             | `getIpAddress()`, `getIpAddressSync()`, `getMacAddress()`                          | [Network](/react-native-nitro-device-info/api/device-info.md#network-6-apis)                                        |
| Read carrier information                             | `getCarrier()`, `getCarrierSync()`, `mobileCountryCode`                            | [Carrier Information](/react-native-nitro-device-info/api/device-info.md#carrier-information-7-apis)                |
| Check audio outputs                                  | `isHeadphonesConnected()`, `getIsWiredHeadphonesConnected()`                       | [Audio Accessories](/react-native-nitro-device-info/api/device-info.md#audio-accessories-4-apis)                    |
| Check location services                              | `isLocationEnabled()`, `getIsLocationEnabled()`, `getAvailableLocationProviders()` | [Location Services](/react-native-nitro-device-info/api/device-info.md#location-services-3-apis)                    |
| Check Android features                               | `apiLevel`, `getHasGms()`, `getHasHms()`, `hasSystemFeature(feature)`              | [Android Platform](/react-native-nitro-device-info/api/device-info.md#android-platform-20-apis)                     |
| Request Apple DeviceCheck or write an ID to Keychain | `getDeviceToken()`, `syncUniqueId()`                                               | [iOS Platform](/react-native-nitro-device-info/api/device-info.md#ios-platform-2-apis)                              |
| Read installation information                        | `installerPackageName`, `getInstallReferrer()`, `isSideLoadingEnabled()`           | [Installation & Distribution](/react-native-nitro-device-info/api/device-info.md#installation--distribution-3-apis) |

For the remaining members, see the [complete DeviceInfo reference](/react-native-nitro-device-info/api/device-info.md).

## Call and return contracts

```typescript
import { DeviceInfoModule } from 'react-native-nitro-device-info';

const model: string = DeviceInfoModule.model;
const battery: number = DeviceInfoModule.getBatteryLevel();

async function readIpAddress(): Promise<string> {
  return await DeviceInfoModule.getIpAddress();
}
```

- **Property**: Read without parentheses. A property can query the OS; `readonly` does not mean that the value is constant.
- **Synchronous method**: Call directly. Synchronous execution does not guarantee a fixed latency.
- **Promise-based method**: Await inside an async function and handle rejection where the API can fail.
- **React hook**: Call inside a React component or custom hook. See [Hooks API](/react-native-nitro-device-info/api/hooks.md) for loading values and polling intervals.

Memory and storage use bytes. Battery and brightness use fractions from `0` to `1` when available. For example, `getBatteryLevel()` returns `-1` when unavailable, while `useBatteryLevel()` returns `null`.

## Platform and security limits

An unsupported API may return a placeholder or reject. A `false` result can mean that a platform has no implementation. Check the individual API and the [Web Support guide](/react-native-nitro-device-info/guide/web-support.md).

[Local device integrity](/react-native-nitro-device-info/api/device-integrity.md) checks in this package are bypassable heuristics. [Device attestation](/react-native-nitro-device-info/api/device-attestation.md) requires the separate `react-native-nitro-device-integrity` package and backend verification.

## Types and source

Import `DeviceInfo`, `PowerState`, `BatteryState`, `DeviceType`, and `NavigationMode` with `import type`. See [Type Definitions](/react-native-nitro-device-info/api/types.md).

The current website follows the repository's `main` branch. For an older installed release, check that release's declarations. The signature source is [`DeviceInfo.nitro.ts`](https://github.com/l2hyunwoo/react-native-nitro-device-info/blob/main/packages/react-native-nitro-device-info/src/DeviceInfo.nitro.ts); native implementations define platform behavior.