PHPackages                             tobymaxham/ux9-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. tobymaxham/ux9-api

ActiveLibrary[API Development](/categories/api)

tobymaxham/ux9-api
==================

The offical UX9 URL Shortener API.

3.0.0(1y ago)511[1 issues](https://github.com/TobyMaxham/ux9-api/issues)MITPHPPHP >=8.2

Since Aug 16Pushed 1y ago1 watchersCompare

[ Source](https://github.com/TobyMaxham/ux9-api)[ Packagist](https://packagist.org/packages/tobymaxham/ux9-api)[ Docs](https://ux9.de)[ RSS](/packages/tobymaxham-ux9-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (11)Used By (0)

[![UX9 URL Shortener API](https://camo.githubusercontent.com/ac9f6c4776468e9aae65aee2eda05d84a6b3ba45c1b673ef797a83783c9577f1/68747470733a2f2f736f6369616c6966792e6769742e63692f746f62796d617868616d2f7578392d6170692f696d6167653f6465736372697074696f6e3d3126666f6e743d52616c65776179266973737565733d31266c616e67756167653d31266f776e65723d31267061747465726e3d436861726c696525323042726f776e2670756c6c733d31267374617267617a6572733d31267468656d653d4c69676874)](https://socialify.git.ci/tobymaxham/ux9-api?description=1&font=Raleway&issues=1&language=1&owner=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Light)

[![Latest Version on Packagist](https://camo.githubusercontent.com/40aefd32096bd2556e6e67afa33a6eaf2bd9b4a77910304615721917f5dadf83/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f746f62796d617868616d2f7578392d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tobymaxham/ux9-api)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/82333275be7d236f3e8f718ffb603721838086121e2023a239a97987ab5511e2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f746f62796d617868616d2f7578392d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tobymaxham/ux9-api)[![Support me on Patreon](https://camo.githubusercontent.com/cef3268299ac4e91c241041bc589061c18d2c61f9e8393f33907c2fb23fe11be/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e742e7376673f75726c3d6874747073253341253246253246736869656c6473696f2d70617472656f6e2e76657263656c2e617070253246617069253346757365726e616d65253344546f62796d617868616d25323674797065253344706174726f6e73267374796c653d666c6174)](https://patreon.com/Tobymaxham)

Official UX9 URL Shortener API. Visit [ux9.de](https://ux9.de/devs) for more Details.

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

[](#installation)

```
composer require tobymaxham/ux9-api

```

Usage
-----

[](#usage)

There are different ways how to get your short URL. If you are using Laravel than try out [laravel-junkies/url-shortener](https://github.com/laravel-junkies/url-shortener). It's an Laravel Package where you simply can use this:

```
$url = Shortener::short('https://example.com');
```

### Initialize

[](#initialize)

```
$shortener = new TobyMaxham\Ux9\Shortener($url = null, $config = null, $format = 'json');

// set the API Token
$shortener->setToken('YOUR_API_TOKEN');
```

Where `$url` can be a valid URL or an array containing URL's. The `$format` is the output/return format you specified. If you don't enter a format it will take the specified format defined in the [configuration Array](#configuration) or the 'json' format.

### Get short URL

[](#get-short-url)

```
$shortener->out();
```

### Short Version

[](#short-version)

```
$shortener->short('http://maxham.de');
$shortener->short('http://github.com');
```

Here you will always get the string of the short url.

### Options and parameters

[](#options-and-parameters)

```
// default = json, alternativ plain, array
$shortener->format($format);
$shortener->out($format);
$shortener->add($url);
```

Configuration
-------------

[](#configuration)

```
$config = [
    'API_TOKEN' => 'YOUR_API_TOKEN',
    'FORMAT' => 'plain',
];

$shortener = new TobyMaxham\Ux9\Shortener($url = null, $config);
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

If you've found a bug regarding security please mail  instead of using the issue tracker.

Support me
----------

[](#support-me)

[![ko-fi](https://camo.githubusercontent.com/201ef269611db7eb6b5d08e9f756ab8980df3014b64492770bdf13a6ed924641/68747470733a2f2f6b6f2d66692e636f6d2f696d672f676974687562627574746f6e5f736d2e737667)](https://ko-fi.com/Z8Z4NZKU)
[![Support me on Patreon](https://camo.githubusercontent.com/cef3268299ac4e91c241041bc589061c18d2c61f9e8393f33907c2fb23fe11be/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e742e7376673f75726c3d6874747073253341253246253246736869656c6473696f2d70617472656f6e2e76657263656c2e617070253246617069253346757365726e616d65253344546f62796d617868616d25323674797065253344706174726f6e73267374796c653d666c6174)](https://patreon.com/Tobymaxham)

Credits
-------

[](#credits)

- [TobyMaxham](https://github.com/TobyMaxham)
- [All Contributors](../../contributors)

License
-------

[](#license)

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

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance42

Moderate activity, may be stable

Popularity7

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity82

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 80.6% 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 ~390 days

Recently: every ~665 days

Total

10

Last Release

407d ago

Major Versions

v1.2 → v2.02016-03-24

v2.1.2 → 3.0.02025-03-29

PHP version history (2 changes)v1.0PHP >=5.5.9

3.0.0PHP >=8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/900ab0a66bf701f3fb99a4db54276b4984cf3cf9b55ccad6df65c034f58be85f?d=identicon)[TobyMaxham](/maintainers/TobyMaxham)

---

Top Contributors

[![TobiasMaxham](https://avatars.githubusercontent.com/u/263875125?v=4)](https://github.com/TobiasMaxham "TobiasMaxham (29 commits)")[![TobyMaxham](https://avatars.githubusercontent.com/u/5646469?v=4)](https://github.com/TobyMaxham "TobyMaxham (4 commits)")[![kamillos](https://avatars.githubusercontent.com/u/13738946?v=4)](https://github.com/kamillos "kamillos (3 commits)")

---

Tags

urlshortenertobymaxhamux9

###  Code Quality

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/tobymaxham-ux9-api/health.svg)

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

###  Alternatives

[yourls/yourls

Your Own URL Shortener

11.9k27.7k1](/packages/yourls-yourls)[mremi/url-shortener

A PHP5/PHP7/PHP8 library using API to shorten/expand URL

79719.0k6](/packages/mremi-url-shortener)[mbarwick83/shorty

Google Url Shortener API Package for Laravel 5.1

31204.9k](/packages/mbarwick83-shorty)[mremi/url-shortener-bundle

Implementation of UrlShortener library for Symfony2/Symfony3

19135.0k](/packages/mremi-url-shortener-bundle)[phplicengine/bitly

Bitly API v4

22277.3k](/packages/phplicengine-bitly)[laracrafts/laravel-url-shortener

Powerful URL shortening tools in Laravel

97110.7k](/packages/laracrafts-laravel-url-shortener)

PHPackages © 2026

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