PHPackages                             aso824/octoprint-php-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. aso824/octoprint-php-api

ActiveLibrary[API Development](/categories/api)

aso824/octoprint-php-api
========================

OctoPrint API client written in PHP

v0.1.3(1y ago)0212MITPHPPHP ^7.4|^8.0

Since Sep 26Pushed 1y ago1 watchersCompare

[ Source](https://github.com/aso824/octoprint-php-api)[ Packagist](https://packagist.org/packages/aso824/octoprint-php-api)[ RSS](/packages/aso824-octoprint-php-api/feed)WikiDiscussions master Synced 2d ago

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

OctoPrint PHP API
=================

[](#octoprint-php-api)

API wrapper to allow easy use of [OctoPrint REST API](https://docs.octoprint.org/en/master/api) in your PHP appplication.

Please note that library is currently in WIP status.

Requirements
------------

[](#requirements)

- PHP ^7.4
- Symfony Serializer ^5.0
- Any PSR-18 compatible HTTP client (consider using [HTTPlug](https://github.com/php-http/httplug))
- OctoPrint ^1.4

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

[](#installation)

```
composer require aso824/octoprint-php-api

```

Usage
-----

[](#usage)

This simple example below assumes that you are using HTTPlug and have any compatible HTTP client.

```
use Http\Discovery\HttpClientDiscovery;
use aso824\OctoPrintPHP\Client;
use aso824\OctoPrintPHP\Configuration;

$httpClient = HttpClientDiscovery::find();

$configuration = new Configuration('http://octoprint.local', 'your-api-key');
$octoClient = new Client($configuration, $httpClient);

var_dump($octoClient->getVersion()->getServer()); // "1.4.2"

$file = $octoClient->files->getFile('test.gcode');
var_dump($file->getGcodeAnalysis()->getEstimatedPrintTime()); // 10120 (seconds)
```

For list of available action please visit OctoPrint REST API documentation.

Currently implemented endpoints
-------------------------------

[](#currently-implemented-endpoints)

API resourceStatusConnection✔️Files✅ Without uploadJobs❌Languages❌Log files❌Printer operations❌Printer profiles❌Settings❌Slicing❌System❌Timelapse❌Access control❌Util❌Contributing
------------

[](#contributing)

All pull requests are welcome. Please follow same convention as in already existing files.

License
-------

[](#license)

This library is under [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance36

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity52

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 ~491 days

Total

4

Last Release

583d ago

PHP version history (2 changes)v0.1PHP ^7.4

v0.1.3PHP ^7.4|^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3472386?v=4)[Jan](/maintainers/aso824)[@aso824](https://github.com/aso824)

---

Top Contributors

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

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/aso824-octoprint-php-api/health.svg)

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

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[cognesy/instructor-php

The complete AI toolkit for PHP: unified LLM API, structured outputs, agents, and coding agent control

310107.9k1](/packages/cognesy-instructor-php)[wordpress/php-ai-client

A provider agnostic PHP AI client SDK to communicate with any generative AI models of various capabilities using a uniform API.

26236.6k14](/packages/wordpress-php-ai-client)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[tg-bot-api/bot-api-base

Clear and simple Telegram bot API

22278.8k2](/packages/tg-bot-api-bot-api-base)

PHPackages © 2026

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