UEX API α Documentation

About

Welcome to UEX APIα Documentation. This page is dedicated to quickly show you all the ways you can use UEX data to develop something cool.


Authentication

Before you start, make sure you got your API key. To obtain it, please contact the developer on Discord. We'll be soon(tm) be adding a registration tool to speed up this process.

Example:

curl https://api.uexcorp.space/systems -L -H "api_key: 665b1e3851eefefa3fb878654292f16597d25155"

Resources

/commodities

Obtain all commodities available in-game and their respective UEX prices averages.

URL https://api.uexcorp.space/commodities/
Method GET
Type application/json
Response example
{
  "status": "ok",
  "code": 200,
  "data": 
  [
    {
      "code": "ACSU",
      "name": "Agricultural Supplies",
      "kind": "Agricultural",
      "trade_price_buy": 1.05,
      "trade_price_sell": 1.16,
      "date_added": 1608949515,
      "date_modified": 1625097602
    },
    ...
  ]
}
                                    

/tradeports

Obtain all locations buying and selling commodities, as well as their respective prices in a star system.

URL https://api.uexcorp.space/tradeports/system/{system_code}/
Method GET
Parameters
Name Type Length Description Example
system_code string 2 Star system code ST (Stanton)
Response example
{
  "status": "ok",
  "code": 200,
  "data": 
  [
    {
      "system": "ST",
      "planet": "ARC",
      "satellite": "WALA",
      "city": null,
      "code": "AM045",
      "name": "ArcCorp Mining Area 045",
      "name_short": "ArcCorp 045",
      "visible": "1",
      "armistice": "1",
      "trade": "1",
      "outlaw": "0",
      "refinery": "0",
      "shops": "0",
      "restricted": "0",
      "minable": 0,
      "date_added": 1608949515,
      "date_modified": 1608949515,
      "prices": 
      {
        "ALUM": 
        {
          "price_buy": 1.11,
          "price_sell": 0,
          "date_update": 1624312112
        },
        "DISP": 
        {
          "price_buy": 0,
          "price_sell": 5.54,
          "date_update": 1623100401
        },
        ...
      }
    },
    ...
  ]
}
                                     

/systems

Obtain a list of all star systems operated by UEX at this time.

URL https://api.uexcorp.space/systems/
Method GET
Response example
{
  "status": "ok",
  "code": 200,
  "data": [
    {
      "name": "Stanton",
      "code": "ST",
      "available": 1,
      "default": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    ...
  ]
}
                                     

/planets

Obtain a list of all planets in a system, operated by UEX.

URL https://api.uexcorp.space/planets/system/{system_code}/
Method GET
Parameters
Name Type Length Description Example
system_code string 2 Star system code ST (Stanton)
Response example
{
  "status": "ok",
  "code": 200,
  "data": [
    {
      "system": "ST",
      "code": "ARC",
      "name": "ArcCorp",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "code": "CRU",
      "name": "Crusader",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "code": "HUR",
      "name": "Hurston",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "code": "MIC",
      "name": "microTech",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    }
  ]
}
                                     

/satellites

Obtain a list of all planetary satellites in a system, operated by UEX.

URL https://api.uexcorp.space/satellites/system/{system_code}/
Method GET
Parameters
Name Type Length Description Example
system_code string 2 Star system code ST (Stanton)
Response example
{
  "status": "ok",
  "code": 200,
  "data": [
    {
      "system": "ST",
      "code": "ABER",
      "name": "Aberdeen",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "code": "ARIA",
      "name": "Arial",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    ...
  ]
}
                                     

/cities

Obtain a list of all cities in a system, operated by UEX.

URL https://api.uexcorp.space/cities/system/{system_code}/
Method GET
Parameters
Name Type Length Description Example
system_code string 2 Star system code ST (Stanton)
Response example
{
  "status": "ok",
  "code": 200,
  "data": [
    {
      "system": "ST",
      "planet": "ARC",
      "code": "A18",
      "name": "Area 18",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "planet": "HUR",
      "code": "LOR",
      "name": "Lorville",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    },
    {
      "system": "ST",
      "planet": "MIC",
      "code": "NBB",
      "name": "New Babbage",
      "available": 1,
      "date_added": 1608949515,
      "date_modified": 0
    }
  ]
}
                                     

Apps using UEX API

No applications yet. Want to showcase your app? Please contact us!


Important

UEX API α still under development as well as our website, so bugs and minor changes should be expected.


Questions?

Please contact the developer on Discord.