---
title: "API Reference"
description: "Reference documentation for Nimiq Pay mini app providers and APIs"
canonical_url: "https://nimiq.dev/mini-apps/api-reference"
---
# API Reference

> Reference documentation for Nimiq Pay mini app providers and APIs

This API is injected by the host app into the mini app environment. For Nimiq access, the recommended pattern is to use the Mini App SDK `init()` helper. This section is reference-only.

## Contents

- [Nimiq provider](https://nimiq.dev/mini-apps/api-reference/nimiq-provider)
- [Ethereum provider](https://nimiq.dev/mini-apps/api-reference/ethereum-provider)

To load and build a mini app, see [Load a Local Mini App in Nimiq Pay](https://nimiq.dev/mini-apps/load-local-mini-app), the [Mini app tutorial](https://nimiq.dev/mini-apps/mini-app-tutorial), and [Build a Dual-Chain Mini App with Nimiq Pay](https://nimiq.dev/mini-apps/dual-chain-mini-app-tutorial).

## Quick Start Examples

### Nimiq Provider

```typescript
import { init } from '@nimiq/mini-app-sdk'

const nimiq = await init()

const accounts = await nimiq.listAccounts()
const signed = await nimiq.sign('hello')

console.log({ accounts, signed })
```

### Ethereum dApp (EIP-1193)

```javascript
const provider = window.ethereum

const accounts = await provider.request({ method: 'eth_requestAccounts' })
const address = accounts[0]

const balance = await provider.request({
  method: 'eth_getBalance',
  params: [address, 'latest'],
})

console.log({ address, balance })
```


## Sitemap

See the full [sitemap](https://nimiq.dev/sitemap.md) for all pages.