Ficsit Remote Monitoring

https://docs.ficsit.app/satisfactory-modding-documentation/latest/
Admin
Ficsit Remote Monitoring provides an API for the game Satisfactory, enabling remote access to read...
Tokens:3,345
Snippets:16
Trust Score:8.1
Update:4 days ago
Show doc for...
Tokens:
Raw
### Power | getPowerUsage

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of buildings with power usage. This is a read endpoint that does not run on the game thread.

```APIDOC
## GET Power/getPowerUsage

### Description
Gets a list of buildings with power usage.

### Method
GET

### Endpoint
Power/getPowerUsage

### Parameters
None documented.

### Response
#### Success Response (200)
- **buildings** (array) - List of buildings with power usage.

#### Response Example
{
  "buildings": []
}
```

--------------------------------

### Other | getAll

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of specific endpoints. This is a read endpoint with mixed game thread usage.

```APIDOC
## GET Other/getAll

### Description
Gets a list of specific endpoints (visit the page, to see all endpoints).

### Method
GET

### Endpoint
Other/getAll

### Parameters
None documented.

### Response
#### Success Response (200)
- **endpoints** (array) - List of specific endpoints.

#### Response Example
{
  "endpoints": []
}
```

--------------------------------

### World | getTapes

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Get information about the Song Tapes. This is a read endpoint that does not run on the game thread.

```APIDOC
## GET World/getTapes

### Description
Get information about the Song Tapes.

### Method
GET

### Endpoint
World/getTapes

### Parameters
None documented.

### Response
#### Success Response (200)
- **tapes** (array) - Information about the Song Tapes.

#### Response Example
{
  "tapes": []
}
```

--------------------------------

### World | getSchematics

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of all schematics. This is a read endpoint that runs on the game thread.

```APIDOC
## GET World/getSchematics

### Description
Gets a list of all schematics.

### Method
GET

### Endpoint
World/getSchematics

### Parameters
None documented.

### Response
#### Success Response (200)
- **schematics** (array) - List of all schematics.

#### Response Example
{
  "schematics": []
}
```

--------------------------------

### Power | getPower

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of all power circuits. This is a read endpoint that does not run on the game thread.

```APIDOC
## GET Power/getPower

### Description
Gets a list of all power circuits.

### Method
GET

### Endpoint
Power/getPower

### Parameters
None documented.

### Response
#### Success Response (200)
- **powerCircuits** (array) - List of all power circuits.

#### Response Example
{
  "powerCircuits": []
}
```

--------------------------------

### World | getUObjectCount

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Get the current UObject count and capacity. This is a read endpoint that does not run on the game thread.

```APIDOC
## GET World/getUObjectCount

### Description
Get the current UObject count and capacity.

### Method
GET

### Endpoint
World/getUObjectCount

### Parameters
None documented.

### Response
#### Success Response (200)
- **count** (number) - Current UObject count.
- **capacity** (number) - Current UObject capacity.

#### Response Example
{
  "count": 0,
  "capacity": 0
}
```

--------------------------------

### Power | getPowerPoles

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of all power poles, wall outlets and power towers. This is a read endpoint that does not run on the game thread.

```APIDOC
## GET Power/getPowerPoles

### Description
Gets a list of all power poles, wall outlets and power towers.

### Method
GET

### Endpoint
Power/getPowerPoles

### Parameters
None documented.

### Response
#### Success Response (200)
- **powerPoles** (array) - List of power poles, wall outlets and power towers.

#### Response Example
{
  "powerPoles": []
}
```

--------------------------------

### World | getUnlockItems

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Gets a list of unlockable actors that unlock song tapes, player helmets and customizations. This is a read endpoint that runs on the game thread.

```APIDOC
## GET World/getUnlockItems

### Description
Gets a list of unlockable actors that unlock song tapes, player helmets and customizations.

### Method
GET

### Endpoint
World/getUnlockItems

### Parameters
None documented.

### Response
#### Success Response (200)
- **unlockItems** (array) - List of unlockable actors.

#### Response Example
{
  "unlockItems": []
}
```

--------------------------------

### Factory | setSwitches

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Updates settings of a power switch (Name, Status, Priority). This is a write endpoint that runs on the game thread.

```APIDOC
## POST Factory/setSwitches

### Description
Updates settings of a power switch (Name, Status, Priority).

### Method
POST

### Endpoint
Factory/setSwitches

### Parameters
None documented.

### Request Body
- **switch** (string) - The power switch to update.
- **name** (string) - The new name.
- **status** (boolean) - The new status.
- **priority** (number) - The new priority.

### Request Example
{
  "switch": "Switch_01",
  "name": "Main Switch",
  "status": true,
  "priority": 1
}

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### World | createPing

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Creates a world ping. This is a write endpoint that runs on the game thread.

```APIDOC
## POST World/createPing

### Description
Creates a world ping.

### Method
POST

### Endpoint
World/createPing

### Parameters
None documented.

### Request Body
- **location** (object) - The location of the ping.
- **color** (string) - The color of the ping.

### Request Example
{
  "location": {
    "x": 0,
    "y": 0,
    "z": 0
  },
  "color": "#FF0000"
}

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Read Endpoints Overview

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

A list of all read endpoints available in the Ficsit Remote Monitoring API, grouped by resource category.

```APIDOC
## Read Endpoints

### Chat
- **getChatMessages** - Gets a list of recent chat messages. (Game Thread: Yes)

### Factory
- **getAssembler** - Gets a list of all assemblers.
- **getBlender** - Gets a list of all blenders.
- **getConstructor** - Gets a list of all constructors.
- **getConverter** - Gets a list of all converters.
- **getElevators** - Gets a list of all elevators.
- **getEncoder** - Gets a list of all encoders.
- **getFactory** - Gets a list of all factories (smelters, constructors, assemblers, foundries, etc.).
- **getSmelter** - Gets a list of all smelters.
- **getRefinery** - Gets a list of all refineries.
- **getManufacturer** - Gets a list of all manufacturers.
- **getPackager** - Gets a list of all packages.
- **getParticle** - Gets a list of all particle accelerators.
- **getFoundry** - Gets a list of all foundries.
- **getBelts** - Gets a list of all belts.
- **getLifts** - Gets a list of all conveyor lifts.
- **getCables** - Gets a list of all cables.
- **getHypertube** - Gets a list of all hypertubes.
- **getPipeJunctions** - Gets a list of all pipe junctions.
- **getPipes** - Gets a list of all pipes.
- **getPump** - Gets a list of all pumps.
- **getTrainRails** - Gets a list of all railways.
- **getExtractor** - Gets a list of all miners. (Game Thread: Yes)
- **getFrackingActivator** - Gets a list of all fracking activators. (Game Thread: Yes)
- **getPortal** - Gets a list of all portals.
- **getRadarTower** - Gets a list of all radar towers.
- **getResourceSinkBuilding** - Gets a list of all resource sinks.
- **getSpaceElevator** - Gets a list of all space elevators.
- **getHUBTerminal** - Gets a list of the HUB Terminals. (Game Thread: Yes)
- **getSwitches** - Gets a list of all switches (priority power switches and power switches).

### Generators
- **getGenerators** - Gets a list of all generators (biomass burners, coal generators, etc.).
- **getBiomassGenerator** - Gets a list of all biomass generators.
- **getCoalGenerator** - Gets a list of all coal generators.
- **getNuclearGenerator** - Gets a list of all nuclear generators.
- **getFuelGenerator** - Gets a list of all fuel generators.
- **getGeothermalGenerator** - Gets a list of all geothermal generators.

### Inventory
- **getCloudInv** - Gets a list of the cloud inventory.
- **getFluidBuffer** - Gets a list of all fluid buffers.
- **getWorldInv** - Gets a list of the world inventory.
- **getStorageInv** - Gets a list of all storage inventories.

### Resource Nodes
- **getResourceNode** - Gets a list of all fracking satellites. (Game Thread: Yes)
- **getResourceGeyser** - Gets a list of all geysers. (Game Thread: Yes)
- **getResourceWell** - Gets a list of all resource ore nodes, geysers and fracking satellites. (Game Thread: Yes)

### Session
- **getSessionInfo** - Gets information about the current session. (Game Thread: Yes)
- **getResearchTrees** - Gets a list of all MAM research trees. (Game Thread: Yes)
- **getPlayer** - Gets a list of all players. (Game Thread: Yes)
- **getModList** - Gets a list of all installed mods.

### Sink
- **getSinkList** - Gets a list of all sinkable items. (Game Thread: Yes)
- **getResourceSink** - Gets a statistic about the resource sink.
- **getExplorationSink** - Gets a statistic about the exploration sink.

### Stations
- **getDroneStation** - Gets a list of all drone stations.
- **getTrainStation** - Gets a list of all train stations.
- **getTruckStation** - Gets a list of all truck stations.

### Vehicles
- **getDrone** - Gets a list of all drones. (Game Thread: Yes)
- **getExplorer** - Gets a list of all explorers. (Game Thread: Yes)
- **getFactoryCart** - Gets a list of all factory carts.
- **getTractor** - Gets a list of all tractors.
- **getTrains** - Gets a list of all trains.
- **getTruck** - Gets a list of all trucks.
- **getVehiclePaths** - Gets a list of all vehicle paths.
- **getVehicles** - Gets a list of all vehicles (tractors, trucks, trains, factory carts, etc.).

### World
- **getCreatures** - Gets a list of all creatures.
- **getDoggo** - Gets a list of all tamed doggos. (Game Thread: Yes)
- **getDropPod** - Gets a list of all drop pods. (Game Thread: Yes)
- **getMapMarkers** - Gets a list of all map markers.
- **getPowerSlug** - Gets a list of all streamed power slugs. (Game Thread: Yes)
- **getProdStats** - Gets a list of the Production Stats Mod by Andre Aquila.
- **getRecipes** - Gets a list of all recipes. (Game Thread: Yes)
```

--------------------------------

### Factory | setEnabled

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Updates Status of a factory buildable. This is a write endpoint that runs on the game thread.

```APIDOC
## POST Factory/setEnabled

### Description
Updates Status of a factory buildable.

### Method
POST

### Endpoint
Factory/setEnabled

### Parameters
None documented.

### Request Body
- **buildable** (string) - The factory buildable to update.
- **enabled** (boolean) - The new status.

### Request Example
{
  "buildable": "Build_ConveyorBeltMk1_C",
  "enabled": true
}

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### World | setModSetting

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Update a mod setting. This is a write endpoint that runs on the game thread.

```APIDOC
## POST World/setModSetting

### Description
Update a mod setting.

### Method
POST

### Endpoint
World/setModSetting

### Parameters
None documented.

### Request Body
- **mod** (string) - The mod identifier.
- **setting** (string) - The setting name.
- **value** (any) - The new value.

### Request Example
{
  "mod": "ModName",
  "setting": "SomeSetting",
  "value": true
}

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Chat | sendChatMessage

Source: https://docs.ficsit.app/ficsitremotemonitoring/latest/json/json.html

Sends a chat message to all players. This is a write endpoint that runs on the game thread.

```APIDOC
## POST Chat/sendChatMessage

### Description
Sends a chat message to all players.

### Method
POST

### Endpoint
Chat/sendChatMessage

### Parameters
None documented.

### Request Body
- **message** (string) - The chat message to send.

### Request Example
{
  "message": "Hello world"
}

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.

#### Response Example
{
  "status": "success"
}
```
Tokens:
Raw