PHPackages                             psychicat/monero-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. psychicat/monero-php

ActiveLibrary[API Development](/categories/api)

psychicat/monero-php
====================

A PHP library for the Monero simplewallet JSON-RPC interface.

v1.0(10y ago)048MITPHP

Since Mar 10Pushed 8y agoCompare

[ Source](https://github.com/btele/monero-php)[ Packagist](https://packagist.org/packages/psychicat/monero-php)[ Docs](https://github.com/PsychicCat/monero-php)[ RSS](/packages/psychicat-monero-php/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

Monero-PHP
==========

[](#monero-php)

A PHP library for the Monero `simplewallet` JSON-RPC interface.

For more information about Monero, please visit .

If you found this useful, feel free to donate!

XMR: `47Vmj6BXSRPax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ6RjbVtp`

Installation
------------

[](#installation)

Install the library using Composer.

```
composer require psychicat/monero-php

```

Create an Instance of the Wallet
--------------------------------

[](#create-an-instance-of-the-wallet)

```
require 'vendor/autoload.php';
use Monero\Wallet;

$wallet = new Monero\Wallet();
```

Default hostname and port connects to .

To connect to an external IP or different port:

```
$hostname = YOUR_WALLET_IP;
$port = YOUR_WALLET_PORT;
$wallet = new Monero\Wallet($hostname, $port);
```

Wallet Methods
--------------

[](#wallet-methods)

### getBalance

[](#getbalance)

```
$balance = $wallet->getBalance();
```

Responds with the current balance and unlocked (spendable) balance of the wallet in atomic units. Divide by 1e12 to convert.

Example response:

```
{ balance: 3611980142579999, unlocked_balance: 3611980142579999 }

```

### getAddress

[](#getaddress)

```
$address = $wallet->getAddress();
```

Responds with the Monero address of the wallet.

Example response:

```
{ address: '47Vmj6BXSRPax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ6RjbVtp' }

```

### transfer

[](#transfer)

```
$tx_hash = $wallet->transfer($options);
```

Transfers Monero to a single recipient OR a group of recipients in a single transaction. Responds with the transaction hash of the payment.

Parameters:

- `options` - an array containing `destinations` (object OR array of objects), `mixin` (int), `unlock_time` (int), `payment_id` (string). Only `destinations` is required. Default mixin value is 4.

```
$options = [
    'destinations' => (object) [
        'amount' => '1',
        'address' => '47Vmj6BXSRPax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ6RjbVtp'
    ]
];
```

Example response:

```
{ tx_hash: '', tx_key: '' }

```

### transferSplit

[](#transfersplit)

```
$tx_hash = $wallet->transferSplit($options);
```

Same as `transfer()`, but can split into more than one transaction if necessary. Responds with a list of transaction hashes.

Additional property available for the `options` array:

- `new_algorithm` - `true` to use the new transaction construction algorithm. defaults to `false`. (*boolean*)

Example response:

```
{ tx_hash_list: [ '' ] }

```

### sweepDust

[](#sweepdust)

```
$tx_hashes = $wallet->sweepDust();
```

Sends all dust outputs back to the wallet, to make funds easier to spend and mix. Responds with a list of the corresponding transaction hashes.

Example response:

```
{ tx_hash_list: [ '' ] }

```

### getPayments

[](#getpayments)

```
$payments = $wallet->getPayments($payment_id);
```

Returns a list of incoming payments using a given payment ID.

Parameters:

- `paymentID` - the payment ID to scan wallet for included transactions (*string*)

### getBulkPayments

[](#getbulkpayments)

```
$payments = $wallet->getBulkPayments($payment_id, $height);
```

Returns a list of incoming payments using a single payment ID or a list of payment IDs from a given height.

Parameters:

- `paymentIDs` - the payment ID or list of IDs to scan wallet for (*array*)
- `minHeight` - the minimum block height to begin scanning from (example: 800000) (*int*)

### incomingTransfers

[](#incomingtransfers)

```
$transfers = $wallet->incomingTransfers($type);
```

Returns a list of incoming transfers to the wallet.

Parameters:

- `type` - accepts `"all"`: all the transfers, `"available"`: only transfers that are not yet spent, or `"unavailable"`: only transfers which have been spent (*string*)

### queryKey

[](#querykey)

```
$key = $wallet->queryKey($type);
```

Returns the wallet's spend key (mnemonic seed) or view private key.

Parameters:

- `type` - accepts `"mnemonic"`: the mnemonic seed for restoring the wallet, or `"view_key"`: the wallet's view key (*string*)

### integratedAddress

[](#integratedaddress)

```
$integratedAddress = $wallet->integratedAddress($payment_id);
```

Make and return a new integrated address from your wallet address and a given payment ID, or generate a random payment ID if none is given.

Parameters:

- `payment_id` - a 64 character hexadecimal string. If not provided, a random payment ID is automatically generated. (*string*, optional)

Example response:

```
{ integrated_address: '4HCSju123guax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ96NYBVqEd6JAu9j3gk' }

```

### splitIntegrated

[](#splitintegrated)

```
$splitIntegrated = $wallet->splitIntegrated($integrated_address);
```

Returns the standard address and payment ID corresponding for a given integrated address.

Parameters:

- `integrated_address` - an Monero integrated address (*string*)

Example response:

```
{ payment_id: '',
  standard_address: '47Vmj6BXSRPax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ6RjbVtp' }

```

### getHeight

[](#getheight)

Usage:

```
$height = $wallet->getHeight();

```

Returns the current block height of the daemon.

Example response:

```
{ height: 874458 }

```

### stopWallet

[](#stopwallet)

```
$wallet->stopWallet();
```

Cleanly shuts down the current simplewallet process.

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3764d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3154120?v=4)[Brandon Telle](/maintainers/btelle)[@btelle](https://github.com/btelle)

---

Top Contributors

[![PsychicCat](https://avatars.githubusercontent.com/u/4073856?v=4)](https://github.com/PsychicCat "PsychicCat (12 commits)")[![btele](https://avatars.githubusercontent.com/u/34487582?v=4)](https://github.com/btele "btele (2 commits)")

---

Tags

cryptocurrencyPoloniexMoneroShapeshift

### Embed Badge

![Health badge](/badges/psychicat-monero-php/health.svg)

```
[![Health](https://phpackages.com/badges/psychicat-monero-php/health.svg)](https://phpackages.com/packages/psychicat-monero-php)
```

###  Alternatives

[psychiccat/monero-php

A PHP library for the Monero simplewallet JSON-RPC interface.

308.5k1](/packages/psychiccat-monero-php)[coinpaymentsnet/coinpayments-php

A PHP wrapper for the CoinPayments.net v1 API.

56129.9k](/packages/coinpaymentsnet-coinpayments-php)[coinremitter/laravel

Official laravel plugin for Coinremitter cryptocurrency payment gateway

2120.8k](/packages/coinremitter-laravel)[hardcastle/xrpl_php

PHP SDK / Client for the XRP Ledger

1110.4k6](/packages/hardcastle-xrpl-php)[coinremitterphp/coinremitter-php

Official PHP SDK for coinremitter cryptocurrency payment gateway

142.4k](/packages/coinremitterphp-coinremitter-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)