Get Extractor

Get a list of all extractors/miners.

URL

GET http://localhost:8080/getExtractor

Response Body

Name Type Description

ID

String

Unique ID of the Extractor.

Name

String

Name of the Extractor.

ClassName

String

ClassName of the Extractor.

ColorSlot

Object

Color/Decoration information about the Actor.

  PrimaryColor

String

Hex Code of Primary Color

  SecondaryColor

String

Hex Code of Secondary Color

BoundingBox

Object

Bounding Box information about the Actor.

  min

Object

The minimum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

  max

Object

The maximum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

Recipe

String

Name of the Recipe.

RecipeClassName

String

ClassName of the Recipe.

production

Object[]

Items that are produced.

  Name

String

Name of the item.

  ClassName

String

Class Name of the item.

  Amount

Integer

Amount of the item.

  MaxAmount

Integer

Stack size of the item.

  CurrentProd

Float

Current produced items per minute.

  MaxProd

Float

Maximum produced items per minutes.

  ProdPercent

Float

Current Efficiency of the extractor.

ManuSpeed

Float

Configured speed in % (exceeds 100 if the extractor is equipped with a power slug).

IsConfigured

Boolean

Is extractor configured?

IsProducing

Boolean

Is extractor producing items?

IsPaused

Boolean

Is extractor paused?

location

Object

Location details of the Extractor.

  x

Float

X Location in the World.

  y

Float

Y Location in the World.

  z

Float

Z Location in the World.

  rotation

Float

Rotation of the Actor (0 - 359, 0 = North, 90 = East, 180 = South, 270 = West).

PowerInfo

Object

Power Information Object.

  CircuitGroupID

Integer

The group this circuit belongs too. (-1 = not connected)

  CircuitID

Integer

This circuit’s unique identifier. (-1 = not connected)

  FuseTriggered

Boolean

Has the fuse tripped?

  PowerConsumed

Float

Current power consumption.

  MaxPowerConsumed

Float

Current maximum power consumption.

features

Object

An object with actor coordinates and name information.

  properties

Object

Name information about the actor.

    name

String

Display Name of the Actor.

    type

String

Type of the Object.

  geometry

Object

Geometry information about the Actor.

    coordinates

Object

The Actor coordinates.

      x

Float

X Location of the Actor.

      y

Float

Y Location of the Actor.

      z

Float

Z Location of the Actor.

    type

String

It’s always "Point".

Example Response

[
  {
    "ID": "Build_MinerMk1_C_2147453782",
    "Name": "Miner Mk.1",
    "ClassName": "Build_MinerMk1_C",
    "location": {
      "x": -52587.4375,
      "y": 264646.90625,
      "z": -3740.842529296875,
      "rotation": 199.99999953283191
    },
    "Recipe": "Limestone",
    "RecipeClassName": "Desc_Stone_C",
    "production": [
      {
        "Name": "Limestone",
        "ClassName": "Desc_Stone_C",
        "Amount": 12,
        "CurrentProd": 2.3529410362243652,
        "MaxProd": 149.99998474121094,
        "ProdPercent": 1.5686275170519528
      }
    ],
    "ManuSpeed": 250,
    "IsConfigured": true,
    "IsProducing": true,
    "IsPaused": false,
    "PowerInfo": {
      "CircuitGroupID": 7,
      "CircuitID": 10,
      "PowerConsumed": 16.788753509521484,
      "MaxPowerConsumed": 16.788753509521484
    },
    "features": {
      "properties": {
        "name": "Miner Mk.1",
        "type": "Miner Mk.1"
      },
      "geometry": {
        "coordinates": {
          "x": -52587.4375,
          "y": 264646.90625,
          "z": -3740.842529296875
        },
        "type": "Point"
      }
    }
  }
]