PHPackages                             apex/ipfs-api - 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. apex/ipfs-api

ActiveLibrary[API Development](/categories/api)

apex/ipfs-api
=============

A minimal implementation of IPFS API

0.1(4y ago)028MITPHPPHP ^8.1

Since Feb 21Pushed 4y ago1 watchersCompare

[ Source](https://github.com/apexpl/ipfs-api)[ Packagist](https://packagist.org/packages/apex/ipfs-api)[ Docs](https://github.com/openwse/ipfs-api)[ RSS](/packages/apex-ipfs-api/feed)WikiDiscussions master Synced 1w ago

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

A minimal implementation of IPFS API
------------------------------------

[](#a-minimal-implementation-of-ipfs-api)

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

[](#installation)

You can install the package via composer:

```
composer require openwse/ipfs-api
```

Usage
-----

[](#usage)

```
$client = new Ipfs\Ipfs(
    new Ipfs\Drivers\HttpClient('https://ipfs-host', 5001)
);

// add a single file (and pin it)
$client->add('/path/to/the/file', true);

// add a file from content
$client->add([
    ['/desired-path-on-ipfs/filename.txt', null, 'my text content', 'text/plain']
]);

// add a nested structure
$client->add([
    ['/path/to/local/file', '/path/on/ipfs'],
    'my-custom-dir',
    ['/path/to/local/file', '/my-custom-dir/filename'],
]);

// list all files
$client->files()->ls();

// get the version
$client->version();

// publish
$client->key()->gen('mykeyname');
$client->name()->publish('/path/hash', '48h', 'mykeyname');

// some other examples...
$client->cat('/path/hash');

$client->config()->set('key', 'value');

$client->pin()->add('/path/hash');

$client->pin()->verify();

$client->stats()->bw();

$client->key()->rm('mykeyname');
```

Lint
----

[](#lint)

Run [PHPMD](https://phpmd.org/), [PHPStan](https://phpstan.org/), and [PHP-CS-Fixer](https://github.com/FriendsOfPhp/PHP-CS-Fixer)

```
composer lint
```

Testing
-------

[](#testing)

```
composer tests
```

TODOS:
------

[](#todos)

- Complete async/streams requests
- Implement the following endpoints:
    - P2P
    - Pubsub (with name/pubsub/{cancel,state,subs})
- Missing tests:
    - Block > put
    - Filestore
    - Dht

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

1547d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4fe486d2ed7db571c0519bb0d52b08b5e953a911936e87331e736a381ef96f29?d=identicon)[apex](/maintainers/apex)

---

Top Contributors

[![mdizak](https://avatars.githubusercontent.com/u/59886259?v=4)](https://github.com/mdizak "mdizak (1 commits)")

---

Tags

apiipfsdecentralizedipfs-api

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/apex-ipfs-api/health.svg)

```
[![Health](https://phpackages.com/badges/apex-ipfs-api/health.svg)](https://phpackages.com/packages/apex-ipfs-api)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[get-stream/stream-chat

A PHP client for Stream Chat (https://getstream.io/chat/)

301.8M2](/packages/get-stream-stream-chat)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)

PHPackages © 2026

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