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

ActiveLibrary[API Development](/categories/api)

nathansalter/php-ipfs-api
=========================

A client library for the IPFS API

0.1.1(9y ago)024MITPHPPHP >=7.0

Since Aug 11Pushed 9y ago1 watchersCompare

[ Source](https://github.com/nathansalter/php-ipfs-api)[ Packagist](https://packagist.org/packages/nathansalter/php-ipfs-api)[ Docs](https://github.com/nathansalter/php-ipfs-api)[ RSS](/packages/nathansalter-php-ipfs-api/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (2)DependenciesVersions (9)Used By (0)

IPFS API wrapper library in PHP
===============================

[](#ipfs-api-wrapper-library-in-php)

> A client library for the IPFS API.

As no progress has been made from `cloutier` in 6 months, I'm forking this to build in my own project.

Usage
=====

[](#usage)

Installing
----------

[](#installing)

This library requires PHP 7.0 or above:

```
$ composer require nathansalter/php-ipfs-api
$ composer install
```

```
use NathanSalter\PhpIpfsApi\IpfsClient;

// connect to ipfs daemon API server
$ipfs = new IpfsClient("localhost", "8080", "5001"); // leaving out the arguments will default to these values
```

Please note; the above will soon change to be using GuzzleHttp instead of raw CURL.

API
---

[](#api)

#### add

[](#add)

Adds content to IPFS.

**Usage**

```
$hash = $ipfs->add('Hello world');
```

#### cat

[](#cat)

Retrieves the contents of a single hash.

**Usage**

```
$ipfs->cat($hash);
```

#### ls

[](#ls)

Gets the node structure of a hash.

**Usage**

```
$hashes = $ipfs->ls($hash);

foreach ($hashes as $e) {
    echo $e['Hash'];
    echo $e['Size'];
    echo $e['Name'];
}
```

#### Object size

[](#object-size)

Returns object size.

**Usage**

```
$size = $ipfs->size($hash);
```

#### Pin

[](#pin)

Pins a hash.

**Usage**

```
$ipfs->pinAdd($hash);
```

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2015-2016 Vincent Cloutier
Copyright (c) 2016 S3r3nity Technologies

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

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

Every ~27 days

Recently: every ~47 days

Total

8

Last Release

3419d ago

PHP version history (2 changes)0.0.1PHP >=5.3.0

0.1.0PHP >=7.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/998690?v=4)[Nathan Salter](/maintainers/nathansalter)[@nathansalter](https://github.com/nathansalter)

---

Top Contributors

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

---

Tags

ipfs

### Embed Badge

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

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

###  Alternatives

[hubspot/api-client

Hubspot API client

24016.2M19](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k11](/packages/pocketmine-bedrock-protocol)[cloutier/php-ipfs-api

A client library for the IPFS API

1209.4k2](/packages/cloutier-php-ipfs-api)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

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