# BDK Native

> Reference documentation for the @bdk/native SDK — bring native iOS/Android features to any web app. Covers only the SDK's supported, customer-facing surface (the namespaced browser helpers and server helpers); internal/native-only commands are intentionally omitted.

## The two docs sets
- [SDK reference — this file](https://docs.thebdk.com/llms.txt): writing code that calls native features from your web app (@bdk/native). Full text: https://docs.thebdk.com/llms-full.txt
- [Service guide](https://thebdk.com/llms.txt): buying and shipping a native app with BDK Native — pricing, process, readiness, capabilities by app type, and the agent skill.

## Getting Started
- [Get started](https://docs.thebdk.com/getting-started/introduction): Drive native iOS and Android features from your web app with @bdk/native.
- [Install and import](https://docs.thebdk.com/getting-started/installation): Install @bdk/native and pick the right import for browser or server code.
- [Set up the client](https://docs.thebdk.com/getting-started/initializing-the-client): Create the one client object you use for everything in the SDK.
- [Handling results](https://docs.thebdk.com/getting-started/interaction-models): How to read the result of a call — immediately, from an event, or as a returned value.
- [Web fallback](https://docs.thebdk.com/getting-started/non-native-browser): Detect when your page isn't running inside the native app and fall back to a web experience.
- [Detect features](https://docs.thebdk.com/getting-started/capabilities): Check whether a feature is switched on in this app build before you show its UI.

## Browser SDK
- [Device & lifecycle](https://docs.thebdk.com/browser/device-and-lifecycle): Read device info and control the native app shell — loading splash, navigation, the launch page, and cache.
- [Open links](https://docs.thebdk.com/browser/navigation-and-links): Open URLs, deep links, and native screens from your app.
- [Deep links](https://docs.thebdk.com/browser/deep-links): Listen for custom URI-scheme links, read a pending launch link, and build links with your registered schemes.
- [Camera & media](https://docs.thebdk.com/browser/media): Take photos, capture a screenshot, record audio, and scan barcodes from the device.
- [Play audio & video](https://docs.thebdk.com/browser/media-playback): Play remote audio and video through the device's native player.
- [Geolocation](https://docs.thebdk.com/browser/location): Get the device's GPS position once or stream live location updates.
- [Runtime permissions](https://docs.thebdk.com/browser/permissions): Prompt for camera, location, or contacts before using a gated feature.
- [Notifications & badges](https://docs.thebdk.com/browser/notifications): Check authorization, request push and critical-alert permission, open settings, and set the app-icon badge.
- [Background data messages](https://docs.thebdk.com/browser/data-messages): Listen for silent data payloads and read the retained queue after a cold start.
- [Biometric login](https://docs.thebdk.com/browser/biometrics): Prompt for Face ID, Touch ID, or fingerprint and read the result.
- [Saved login](https://docs.thebdk.com/browser/smart-login): Save, restore, and clear a user's email and password so returning users skip the login form.
- [External sign-in](https://docs.thebdk.com/browser/sign-in): Hand an HTTPS authorization URL to the device and receive the OAuth callback in your page.
- [In-app purchases](https://docs.thebdk.com/browser/in-app-purchases): Run App Store and Google Play purchase and consume flows, then read the result from an event.
- [Sell products & subscriptions](https://docs.thebdk.com/browser/purchases): List store products, start a purchase, restore entitlements, and consume consumables from the App Store and Google Play.
- [Native UI](https://docs.thebdk.com/browser/ui-and-feedback): Show native banners, alerts, popups, menus, pickers, and control the status bar and orientation from your web code.
- [Native sharing](https://docs.thebdk.com/browser/sharing): Open the device's native share sheet to share text, images, video, files, or an Instagram Story.
- [Receive shared content](https://docs.thebdk.com/browser/share-inbound): Handle text, links, and files other apps share into yours.
- [Read health data](https://docs.thebdk.com/browser/health): Check authorization, read raw samples, and read totals for a fixed set of health data types.
- [NFC tags](https://docs.thebdk.com/browser/nfc): Read, write, cancel, and launch from NDEF tags with the device's NFC hardware.
- [Listen for events](https://docs.thebdk.com/browser/events): Subscribe with bdk.on(event, listener) to receive the results native features report back.

## Server SDK
- [Server helpers](https://docs.thebdk.com/server/overview): Call provider APIs from your Node backend, configure credentials, inject a custom fetch, and handle errors.
- [Verify purchases](https://docs.thebdk.com/server/iap-verification): Verify in-app purchases server-side from any Node service.
- [Push notifications](https://docs.thebdk.com/server/onesignal-push): Send a OneSignal push notification from your backend.
- [Branch deep links](https://docs.thebdk.com/server/branch): Create a Branch deep link from your server.
- [ChottuLink deep links](https://docs.thebdk.com/server/chottulink): Create a ChottuLink dynamic deep link from your server.
- [Firebase Dynamic Links](https://docs.thebdk.com/server/firebase-dynamic-links): Create a short Firebase Dynamic Link from your server.

## Reference
- [Objects](https://docs.thebdk.com/reference/objects): The shape of every object the SDK returns or delivers on an event.
- [Use with AI agents](https://docs.thebdk.com/reference/ai-agents): Point Lovable, Cursor, Replit, and other AI coding tools at the SDK so they generate correct, secure code.