PHPackages                             starpeace-project/starpeace-lumen-api-interface - 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. [Framework](/categories/framework)
4. /
5. starpeace-project/starpeace-lumen-api-interface

ActiveProject[Framework](/categories/framework)

starpeace-project/starpeace-lumen-api-interface
===============================================

The Starpeace Project Interface API

v0.0.1(7y ago)02MITPHPPHP &gt;=7.1.3

Since Aug 18Pushed 7y agoCompare

[ Source](https://github.com/starpeace-project/starpeace-lumen-api-interface)[ Packagist](https://packagist.org/packages/starpeace-project/starpeace-lumen-api-interface)[ RSS](/packages/starpeace-project-starpeace-lumen-api-interface/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (6)Versions (2)Used By (0)

[![](starpeace-logo.png)](starpeace-logo.png)

Starpeace Lumen API Interface
=============================

[](#starpeace-lumen-api-interface)

[![GitHub release](https://camo.githubusercontent.com/149b175d59220d5ab8bf1fc4b9e2f9667446f4d02da739d0781ba6eb129768b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f52656c656173652d76302e302e312d627269676874677265656e2e737667)](https://camo.githubusercontent.com/149b175d59220d5ab8bf1fc4b9e2f9667446f4d02da739d0781ba6eb129768b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f52656c656173652d76302e302e312d627269676874677265656e2e737667) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/7650d357355f7e9bb333b52e1029d54441d027e860795e157781f5dd9b681184/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7374617270656163652d70726f6a6563742f7374617270656163652d6c756d656e2d6170692d696e746572666163652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/starpeace-project/starpeace-lumen-api-interface/) [![Build Status](https://camo.githubusercontent.com/42fafd8768c1360d0143168c8336289b823e36306f0a3241bdd88cd5865c6154/68747470733a2f2f7472617669732d63692e6f72672f7374617270656163652d70726f6a6563742f7374617270656163652d6c756d656e2d6170692d696e746572666163652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/starpeace-project/starpeace-lumen-api-interface) [![Discourse chat](https://camo.githubusercontent.com/2fbf70a0c00131bdd8efbe0215deda701c98229667296f9c434c0d5ccd4da43d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446973636f757273652d436861742d626c75652e737667)](https://discord.gg/TF9Bmsj)[![License](https://camo.githubusercontent.com/3a423b2338207e3e05d9f894edec9e27ea9a1a2767fb0686b800dad2016b770d/68747470733a2f2f706f7365722e707567782e6f72672f6c61726176656c2f6c756d656e2d6672616d65776f726b2f6c6963656e73652e737667)](https://packagist.org/packages/laravel/lumen-framework)

This API acts as the new interface server for the re-build of Starpeace, it will be the communication point of the Starpeace client.

Install
-------

[](#install)

```
    composer require starpeace-project/starpeace-lumen-api-interface

```

Usage
-----

[](#usage)

### Installed routes

[](#installed-routes)

VerbPathNamedRouteControllerActionMiddlewarePOST/oauth/token\\Laravel\\Passport\\Http\\Controllers\\AccessTokenControllerissueToken-GET/oauth/tokens\\Laravel\\Passport\\Http\\Controllers\\AuthorizedAccessTokenControllerforUserauthDELETE/oauth/tokens/{token\_id}\\Laravel\\Passport\\Http\\Controllers\\AuthorizedAccessTokenControllerdestroyauthPOST/oauth/token/refresh\\Laravel\\Passport\\Http\\Controllers\\TransientTokenControllerrefreshauthGET/oauth/clients\\Laravel\\Passport\\Http\\Controllers\\ClientControllerforUserauthPOST/oauth/clients\\Laravel\\Passport\\Http\\Controllers\\ClientControllerstoreauthPUT/oauth/clients/{client\_id}\\Laravel\\Passport\\Http\\Controllers\\ClientControllerupdateauthDELETE/oauth/clients/{client\_id}\\Laravel\\Passport\\Http\\Controllers\\ClientControllerdestroyauthGET/oauth/scopes\\Laravel\\Passport\\Http\\Controllers\\ScopeControllerallauthGET/oauth/personal-access-tokens\\Laravel\\Passport\\Http\\Controllers\\PersonalAccessTokenControllerforUserauthPOST/oauth/personal-access-tokens\\Laravel\\Passport\\Http\\Controllers\\PersonalAccessTokenControllerstoreauthDELETE/oauth/personal-access-tokens/{token\_id}\\Laravel\\Passport\\Http\\Controllers\\PersonalAccessTokenControllerdestroyauthAPI CALLS
---------

[](#api-calls)

The purpose of this API is obviously the calls we can make and the data we can obtain. Note: All data in the examples below are example data.

### Initial Calls

[](#initial-calls)

The following calls are those currently available

### /galaxies/getTypes

[](#galaxiesgettypes)

```
    /galaxies/getTypes

```

This will return a json list of available galaxy types:

```
    {
        "data": [
            {
                "id": 1,
                "name": "free",
                "display_name": "Free",
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 2,
                "name": "subscriber",
                "display_name": "Subscriber",
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 3,
                "name": "private",
                "display_name": "Private",
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 4,
                "name": "sponsored",
                "display_name": "Sponsored",
                "updated_at": "2018-08-22 22:40:50"
            }
        ]
    }

```

### /galaxies/getGalaxies

[](#galaxiesgetgalaxies)

```
    /galaxies/getGalaxies

```

This will return a full list of the galaxy types including the worlds within

```
    {
        "data": [
            {
                "galaxy_id": 1,
                "galaxy_type": "free",
                "name": "Milky Way",
                "updated_at": "2018-08-22 22:08:50",
                "worlds": [
                    {
                        "id": 2,
                        "map_id": 2,
                        "display_name": "Winfield",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 11,
                        "map_id": 8,
                        "display_name": "Samir",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 13,
                        "map_id": 1,
                        "display_name": "Dixie",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 15,
                        "map_id": 4,
                        "display_name": "Hettie",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    }
                ]
            },
            {
                "galaxy_id": 2,
                "galaxy_type": "subscriber",
                "name": "Andromeda",
                "updated_at": "2018-08-22 22:08:50",
                "worlds": [
                    {
                        "id": 7,
                        "map_id": 9,
                        "display_name": "Hailee",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 8,
                        "map_id": 9,
                        "display_name": "Kellen",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    }
                ]
            },
            {
                "galaxy_id": 3,
                "galaxy_type": "private",
                "name": "Black Eye Galaxy",
                "updated_at": "2018-08-22 22:08:50",
                "worlds": [
                    {
                        "id": 1,
                        "map_id": 1,
                        "display_name": "Edward",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 6,
                        "map_id": 8,
                        "display_name": "Ova",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 14,
                        "map_id": 2,
                        "display_name": "Cayla",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 17,
                        "map_id": 3,
                        "display_name": "Brycen",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 18,
                        "map_id": 3,
                        "display_name": "Burnice",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 19,
                        "map_id": 5,
                        "display_name": "Laury",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 20,
                        "map_id": 10,
                        "display_name": "Arvilla",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    }
                ]
            },
            {
                "galaxy_id": 4,
                "galaxy_type": "sponsored",
                "name": "Virgo Stellar Stream",
                "updated_at": "2018-08-22 22:08:50",
                "worlds": [
                    {
                        "id": 3,
                        "map_id": 8,
                        "display_name": "Amelie",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 4,
                        "map_id": 3,
                        "display_name": "Lelia",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 5,
                        "map_id": 10,
                        "display_name": "Winona",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 9,
                        "map_id": 8,
                        "display_name": "Roger",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 10,
                        "map_id": 10,
                        "display_name": "Mike",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 12,
                        "map_id": 4,
                        "display_name": "Turner",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    },
                    {
                        "id": 16,
                        "map_id": 3,
                        "display_name": "Angus",
                        "year": 2000,
                        "updated_at": "2018-08-22 22:40:50"
                    }
                ]
            }
        ]
    }

```

### /galaxies/getGalaxy/\[n\]

[](#galaxiesgetgalaxyn)

```
    /galaxies/getGalaxy/1

```

This will return the worlds in the given galaxy \[n\]

```
    {
        "data": [
            {
                "id": 2,
                "map_id": 2,
                "display_name": "Winfield",
                "year": 2000,
                "investors": 9,
                "online": 0,
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 11,
                "map_id": 8,
                "display_name": "Samir",
                "year": 2000,
                "investors": 8,
                "online": 0,
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 13,
                "map_id": 1,
                "display_name": "Dixie",
                "year": 2000,
                "investors": 4,
                "online": 0,
                "updated_at": "2018-08-22 22:40:50"
            },
            {
                "id": 15,
                "map_id": 4,
                "display_name": "Hettie",
                "year": 2000,
                "investors": 8,
                "online": 0,
                "updated_at": "2018-08-22 22:40:50"
            }
        ]
    }

```

This return includes details of how many tycoons are investors on each world along with how many investors were online within the last ten minutes.

History
-------

[](#history)

[Discover the release history by heading on over to the releases page.](https://github.com/starpeace-project/starpeace-lumen-api-interface/releases)

Backers
-------

[](#backers)

- [Ross Wampler](https://github.com/rwampler)
- [Ron Appleton](https://github.com/ronappleton)

### Maintainers

[](#maintainers)

These amazing people are maintaining this project:

- [Ron Appleton](https://github.com/ronappleton)
- [Ross Wampler](https://github.com/rwampler)

### Sponsors

[](#sponsors)

No sponsors yet! Will you be the first?

### Contributors

[](#contributors)

These amazing people have contributed code to this project:

- [Ron Appleton](https://github.com/ronappleton) — [view contributions](https://github.com/starpeace-project/starpeace-lumen-api-interface/commits?author=ronappleton "View the GitHub contributions of Ron Appleton on repository starpeace-project/starpeace-lumen-api-interface")

License
-------

[](#license)

Unless stated otherwise all works are:

- Copyright © 2018 [Ron Appleton](http://www.linkedin.com/in/ron-appleton-b3066318/)

and licensed under:

- [MIT License](http://spdx.org/licenses/MIT.html)

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

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

2823d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6e2afdd94a6f21a4ec2c5df569b80c1d47d6f5d0428f866f55c4bc117856b58b?d=identicon)[Ron Appleton](/maintainers/Ron%20Appleton)

---

Top Contributors

[![ronappleton](https://avatars.githubusercontent.com/u/3792420?v=4)](https://github.com/ronappleton "ronappleton (15 commits)")[![rwampler](https://avatars.githubusercontent.com/u/13138481?v=4)](https://github.com/rwampler "rwampler (1 commits)")

---

Tags

apiinterfaceservicestarpeaceframeworklaravellumenstarpeacelegacy-online

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/starpeace-project-starpeace-lumen-api-interface/health.svg)

```
[![Health](https://phpackages.com/badges/starpeace-project-starpeace-lumen-api-interface/health.svg)](https://phpackages.com/packages/starpeace-project-starpeace-lumen-api-interface)
```

PHPackages © 2026

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