Ficsit Remote Management

https://docs.ficsit.app/ficsitremotemonitoring/latest/
Admin
Ficsit Remote Management is a Satisfactory mod that enables statistical data collection and minor...
Tokens:68,727
Snippets:211
Trust Score:8.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Creatures Example Response

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

A sample JSON response showing the structure of creature data returned by the API.

```json
[
  {
    "ID": "Char_Hog_C_2147466694",
    "ClassName": "Char_Hog_C",
    "Roaming": {
      "MinRoaming": 500,
      "MaxRoaming": 1000
    },
    "SpawnDistance": 10000,
    "State": "CS_Default",
    "location": {
      "x": -109600.786401125,
      "y": 219064.349969713,
      "z": 720.205171512911,
      "rotation": 132.556407928467
    },
    "features": {
      "properties": {
        "name": "Char_Hog_C",
        "type": "Char_Hog_C"
      },
      "geometry": {
        "coordinates": {
          "x": -109600.786401125,
          "y": 219064.349969713,
          "z": 720.205171512911
        },
        "type": "Point"
      }
    }
  },
  {
    "ID": "Char_SpaceGiraffe_C_2147475977",
    "ClassName": "Char_SpaceGiraffe_C",
    "Roaming": {
      "MinRoaming": 1000,
      "MaxRoaming": 6000
    },
    "SpawnDistance": 20000,
    "State": "CS_Default",
    "location": {
      "x": -102999.879346438,
      "y": 205214.50708689,
      "z": 1110.40994600986,
      "rotation": 0.438751220703068
    },
    "features": {
      "properties": {
        "name": "Char_SpaceGiraffe_C",
        "type": "Char_SpaceGiraffe_C"
      },
      "geometry": {
        "coordinates": {
          "x": -102999.879346438,
          "y": 205214.50708689,
          "z": 1110.40994600986
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Example Response for Get Drop Pod

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

A sample JSON response structure returned by the /getDropPod endpoint.

```json
[
  {
    "ID": "BP_DropPod14_389",
    "location": {
      "x": -43144,
      "y": 145820,
      "z": 7472,
      "rotation": 90
    },
    "Opened": false,
    "Looted": false,
    "RequiredItem": {
      "Name": "Modular Frame",
      "ClassName": "Desc_ModularFrame_C",
      "Amount": 5,
      "MaxAmount": 50
    },
    "RequiredPower": 0,
    "features": {
      "properties": {
        "name": "Drop Pod",
        "type": "Drop Pod"
      },
      "geometry": {
        "coordinates": {
          "x": -43144,
          "y": 145820,
          "z": 7472
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Get Doggo API Response Example

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

Example JSON response structure returned by the /getDoggo endpoint.

```json
[
  {
    "ID": "Char_SpaceRabbit_C_2147414178",
    "Name": "Ficsit Remote Monitoring rocks",
    "ClassName": "Char_SpaceRabbit_C",
    "location": {
      "x": -43942.754996165997,
      "y": 275363.09331948927,
      "z": -3529.0104559118095,
      "rotation": 283.58592224121094
    },
    "Inventory": [
      {
        "Name": "Steel Beam",
        "ClassName": "Desc_SteelPlate_C",
        "Amount": 200,
        "MaxAmount": 200
      }
    ],
    "features": {
      "properties": {
        "name": "Ficsit Remote Monitoring rocks",
        "type": "Lizard Doggo"
      },
      "geometry": {
        "coordinates": {
          "x": -43942.754996165997,
          "y": 275363.09331948927,
          "z": -3529.0104559118095
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Example Response for Get Drone

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

A sample JSON response showing the structure of drone data returned by the /getDrone endpoint.

```json
[
  {
    "ID": "BP_DroneTransport_C_2147415346",
    "Name": "Drone",
    "ClassName": "BP_DroneTransport_C",
    "HomeStation": "Arlanda",
    "PairedStation": "None",
    "HasPairedStation": false,
    "CurrentDestination": "No Destination",
    "FlyingSpeed": 0,
    "MaxSpeed": 0,
    "CurrentFlyingMode": "None",
    "location": {
      "x": -48777.9609375,
      "y": 252677.703125,
      "z": -3190.923583984375,
      "rotation": 90
    },
    "features": {
      "properties": {
        "name": "Drone",
        "type": "Drone"
      },
      "geometry": {
        "coordinates": {
          "x": -48777.9609375,
          "y": 252677.703125,
          "z": -3190.923583984375
        },
        "type": "Point"
      }
    }
  }
]
```

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

### GET /getModList

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

Retrieves a list of all installed mods on the system.

```APIDOC
## GET /getModList

### Description
Retrieves a list of all installed mods, including their names, versions, and metadata.

### Method
GET

### Endpoint
http://localhost:8080/getModList

### Response
#### Success Response (200)
- **Name** (String) - Name of the Mod.
- **SMRName** (String) - Name of Mod as Mod Repository and Unreal Engine see it as.
- **Version** (String) - Version (SemVer format) of the Mod.
- **Description** (String) - Description of the Mod.
- **DocsURL** (String) - Docs URL of the Mod.
- **SupportURL** (String) - Support URL of the Mod.
- **CreatedBy** (String) - Author of the Mod.
- **RemoteVersionRange** (String) - Acceptable Version Range of other client/server mod versions.
- **RequiredOnRemote** (Boolean) - Is the Mod required on both the server and client

#### Response Example
[
  {
    "Name": "Ficsit Remote Monitoring",
    "SMRName": "FicsitRemoteMonitoring",
    "Version": "1.4.0",
    "Description": "Statistical and GeoLocation Monitoring for Satisfactory",
    "DocsURL": "https://docs.ficsit.app/ficsitremotemonitoring/latest/index.html",
    "AcceptsAnyRemoteVersion": "https://github.com/porisius/FicsitRemoteMonitoring",
    "CreatedBy": "Porisius",
    "RemoteVersionRange": ">=1.4.0",
    "RequiredOnRemote": false
  }
]
```

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

### Example Response for Get Power Usage

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

This JSON structure represents the data returned when querying for power usage. It lists buildings with their location and power statistics.

```json
[
 {
    "ID": "Build_OilRefinery_C_2147345255",
    "Name": "Refinery",
    "ClassName": "Build_OilRefinery_C",
    "location": {
      "x": 151500,
      "y": 214300,
      "z": -7499.9814453125,
      "rotation": 90
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "FuseTriggered": false,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  },
  {
    "ID": "Build_OilRefinery_C_2147345106",
    "Name": "Refinery",
    "ClassName": "Build_OilRefinery_C",
    "location": {
      "x": 150500,
      "y": 214300,
      "z": -7499.9814453125,
      "rotation": 90
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "FuseTriggered": false,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  }
]
```

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

### Example Resource/Exploration Sink Response

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

This is an example of the JSON response body returned when querying for resource or exploration sink statistics. It includes various metrics related to progress and accumulated points.

```json
[
   {
      "Name":"A.W.E.S.O.M.E.",
      "NumCoupon":13,
      "Percent":15.7,
      "GraphPoints":[
         {
            "Index":0,
            "value":33218
         },
         {
            "Index":1,
            "value":37837
         },
         {
            "Index":2,
            "value":110488
         },
         {
            "Index":3,
            "value":34840
         },
         {
            "Index":4,
            "value":75563
         },
         {
            "Index":5,
            "value":105934
         },
         {
            "Index":6,
            "value":32933
         },
         {
            "Index":7,
            "value":150480
         },
         {
            "Index":8,
            "value":223927
         },
         {
            "Index":9,
            "value":148770
         }
      ],
      "PointsToCoupon":14902634,
      "TotalPoints":3334555366
   }
]
```

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

### Set Mod Setting Response Example

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

This is an example of a successful response when a mod setting is applied. The `IsSent` boolean indicates whether the setting was successfully applied.

```json
[
  {
    "IsSent": true
  }
]
```

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

### Arduino Serial Communication Setup

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

Basic Arduino setup for serial communication at 9600 baud. This code initializes the serial port for communication.

```arduino
void setup() {
  Serial.begin(9600); // Setup serial
}
```

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

### Retrieve Hypertube Entrances

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

Example JSON response returned by the GET request to the /getHyperEntrance endpoint.

```json
[
  {
    "ID": "Build_PipeHyperStart_C_2142927173",
    "Name": "Hypertube Entrance",
    "ClassName": "Build_PipeHyperStart_C",
    "location": {
      "x": -254709.78125,
      "y": -44782.69921875,
      "z": -125,
      "rotation": 95.1965333687203
    },
    "BoundingBox": {
      "min": {
        "x": -254709.78125,
        "y": -44782.69921875,
        "z": -125
      },
      "max": {
        "x": -254709.78125,
        "y": -44782.69921875,
        "z": -125
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "5F668C00"
    },
    "PowerInfo": {
      "CircuitGroupID": 0,
      "CircuitID": 23,
      "PowerConsumed": 10,
      "MaxPowerConsumed": 10
    }
  }
]
```

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

### Retrieve Belt Data Example Response

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

Example JSON response structure returned by the /getBelts endpoint.

```json
[
  {
    "ID": "Build_ConveyorBeltMk1_C_2147415070",
    "Name": "Conveyor Belt Mk.1",
    "ClassName": "Build_ConveyorBeltMk1_C",
    "location0": {
      "x": 0,
      "y": 0,
      "z": 0
    },
    "Connected0": true,
    "location1": {
      "x": -964.5940059659988,
      "y": -258.68724653875688,
      "z": 27.264452340796197
    },
    "Connected1": true,
    "Length": 1000.2387084960938,
    "ItemsPerMinute": 60,
    "features": {
      "properties": {
        "name": "Conveyor Belt Mk.1",
        "type": "Conveyor Belt Mk.1"
      },
      "geometry": {
        "coordinates": {
          "x": -54853.11328125,
          "y": 263822.28125,
          "z": -3733.415771484375
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Retrieve Artifacts List Response

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

Example JSON response structure returned by the GET /getArtifacts endpoint.

```json
[
  {
    "ID": "BP_WAT2_C_UAID_04421A9713F0FD6301_1747414245",
    "Name": "Mercer Sphere",
    "ClassName": "BP_WAT2_C",
    "location": {
      "x": 188755,
      "y": 137135,
      "z": 12000,
      "rotation": 90
    },
    "features": {
      "properties": {
        "name": "Mercer Sphere",
        "type": "Artifact"
      },
      "geometry": {
        "coordinates": {
          "x": 188755,
          "y": 137135,
          "z": 12000
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Retrieve Extractor List Response Example

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

Example JSON response structure returned by the /getExtractor endpoint.

```json
[
  {
    "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"
      }
    }
  }
]
```

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

### GET /getRecipes

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

Retrieves a list of all available recipes in the game.

```APIDOC
## GET getRecipes

### Description
Gets a list of all recipes.

### Method
GET

### Endpoint
getRecipes
```

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

### GET /getCloudInv

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

Retrieves the current inventory list from the dimensional depot.

```APIDOC
## GET /getCloudInv

### Description
Retrieves the inventory of the dimensional depot.

### Method
GET

### Endpoint
http://localhost:8080/getCloudInv

### Response
#### Success Response (200)
- **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.

#### Response Example
[
  {
    "Name": "Iron Plate",
    "ClassName": "Desc_IronPlate_C",
    "Amount": 164,
    "MaxAmount": 200
  },
  {
    "Name": "Copper Sheet",
    "ClassName": "Desc_CopperSheet_C",
    "Amount": 200,
    "MaxAmount": 200
  }
]
```

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

### GET /getPortal

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

Retrieves a list of all portals currently registered in the system.

```APIDOC
## GET /getPortal

### Description
Gets a list of all portals available in the system.

### Method
GET

### Endpoint
http://localhost:8080/getPortal

### Response
#### Success Response (200)
- **ID** (String) - Unique ID of the Portal.
- **Name** (String) - Name of the Portal.
- **ClassName** (String) - ClassName of the Portal.
- **location** (Object) - Location details of the Portal.
- **BoundingBox** (Object) - Bounding Box information about the Actor.
- **ColorSlot** (Object) - Color/Decoration information about the Actor.

#### Response Example
[
  {
    "ID": "Build_Portal_C_2147455423",
    "Name": "Main Portal",
    "ClassName": "Build_Portal_C",
    "location": {
      "x": -65200,
      "y": 240100,
      "z": 21100,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": -65600,
        "y": 239700,
        "z": 21100
      },
      "max": {
        "x": -64800,
        "y": 240500,
        "z": 22300
      }
    },
    "ColorSlot": {
      "PrimaryColor": "C800BD00",
      "SecondaryColor": "C800BD00"
    }
  }
]
```

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

### Example Constructor Response

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

This JSON object represents the response for a single Constructor building. It includes details about its ID, name, class name, location, current recipe, production and ingredient status, productivity, manufacturing speed, configuration, production state, and power information.

```json
[
  {
    "ID": "Build_ConstructorMk1_C_2147415548",
    "Name": "Constructor",
    "ClassName": "Build_ConstructorMk1_C",
    "location": {
      "x": -70700,
      "y": 254500,
      "z": -3599.984130859375,
      "rotation": 90
    },
    "Recipe": "Concrete",
    "RecipeClassName": "Recipe_Concrete_C",
    "production": [
      {
        "Name": "Concrete",
        "ClassName": "Desc_Cement_C",
        "Amount": 33,
        "CurrentProd": 0,
        "MaxProd": 1.649999976158142,
        "ProdPercent": 0
      }
    ],
    "ingredients": [
      {
        "Name": "Limestone",
        "ClassName": "Desc_Stone_C",
        "Amount": 1,
        "CurrentConsumed": 0,
        "MaxConsumed": 4.949999809265137,
        "ConsPercent": 0
      }
    ],
    "Productivity": 0,
    "ManuSpeed": 100,
    "IsConfigured": true,
    "IsProducing": false,
    "IsPaused": true,
    "PowerInfo": {
      "CircuitGroupID": 0,
      "CircuitID": 1,
      "PowerConsumed": 0.10000000149011612,
      "MaxPowerConsumed": 0.21619677543640137
    },
    "features": {
      "properties": {
        "name": "Constructor",
        "type": "Constructor"
      },
      "geometry": {
        "coordinates": {
          "x": -70700,
          "y": 254500,
          "z": -3599.984130859375
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Example Session Info Response

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

This JSON object represents a typical response from the /getSessionInfo endpoint, detailing various aspects of the current game session.

```json
{
  "SessionName": "1.1-Save",
  "IsPaused": false,
  "DayLength": 50,
  "NightLength": 10,
  "PassedDays": 1306,
  "NumberOfDaysSinceLastDeath": 235,
  "Hours": 15,
  "Minutes": 26,
  "Seconds": 14.97265625,
  "IsDay": true,
  "TotalPlayDuration": 4685136,
  "TotalPlayDurationText": "1301:25:36"
}
```

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

### Retrieve Power Slug Data

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

Example JSON response returned by the GET /getPowerSlug endpoint containing an array of power slug objects.

```json
[
  {
    "ID": "BP_Crystal27_27",
    "Name": "Blue Power Slug",
    "ClassName": "BP_Crystal_C",
    "location": {
      "x": -54543.35546875,
      "y": 270830.1875,
      "z": -1451.72412109375,
      "rotation": 232.89628601074219
    },
    "features": {
      "properties": {
        "name": "Blue Power Slug",
        "type": "Power Slug"
      },
      "geometry": {
        "coordinates": {
          "x": -54543.35546875,
          "y": 270830.1875,
          "z": -1451.72412109375
        },
        "type": "Point"
      }
    }
  },
  {
    "ID": "BP_Crystal3_3",
    "Name": "Blue Power Slug",
    "ClassName": "BP_Crystal_C",
    "location": {
      "x": -64958.64453125,
      "y": 268214,
      "z": -3016.97998046875,
      "rotation": 115.72634887695312
    },
    "features": {
      "properties": {
        "name": "Blue Power Slug",
        "type": "Power Slug"
      },
      "geometry": {
        "coordinates": {
          "x": -64958.64453125,
          "y": 268214,
          "z": -3016.97998046875
        },
        "type": "Point"
      }
    }
  }
]
```

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

### POST /createPing

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

Creates a world ping at specified coordinates. This endpoint requires authentication via the X-FRM-Authorization header.

```APIDOC
## POST /createPing

### Description
Creates a world ping. The ping will be created by the first player.

### Method
POST

### Endpoint
http://localhost:8080/createPing

### Parameters
#### Request Body
- **x** (Float) - Required - X Location of the Ping.
- **y** (Float) - Required - Y Location of the Ping.
- **z** (Float) - Required - Z Location of the Ping.

### Request Example
{
  "x": 0,
  "y": 0,
  "z": 0
}
```

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

### POST /setSwitches

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

Updates the configuration of one or more Priority Power Switches. Requires authentication.

```APIDOC
## POST /setSwitches

### Description
Updates a (Priority) Power Switch. An array of objects can be passed to update multiple switches simultaneously. Note that this only works for Priority Power Switches.

### Method
POST

### Endpoint
http://localhost:8080/setSwitches

### Parameters
#### Request Body
- **ID** (String) - Required - ID of the (Priority) Power Switch
- **name** (String) - Optional - Switch Name
- **priority** (Integer) - Optional - Priority Group (0-8)
- **status** (Boolean) - Optional - Switch Status (true = Enabled, false = Disabled)

### Request Example
{
  "ID": "Build_PriorityPowerSwitch_C_2147423102",
  "name": "My Power Switch",
  "priority": 1,
  "status": true
}

### Response
#### Success Response (200)
- **ID** (String) - ID of the (Priority) Power Switch
- **Name** (String) - Updated Name
- **Priority** (Integer) - Updated Priority
- **Status** (Boolean) - Updated Status

#### Response Example
[
  {
    "ID": "Build_PriorityPowerSwitch_C_2147423102",
    "Name": "My Power Switch",
    "Status": true,
    "Priority": 1
  }
]
```

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

### Get World Inventory API Endpoint

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

This is the URL for the GET request to retrieve the world inventory. Ensure the game server is running and accessible.

```http
GET http://localhost:8080/getWorldInv
```

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

### Get Sink List Endpoint Response

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

This JSON structure represents the response body from the GET /getSinkList endpoint. It details the properties of each sinkable item.

```json
[
   {
      "Name": "Turbo Motor",
      "ClassName": "Desc_MotorLightweight_C",
      "Points": 242720,
      "PointsOverride": -1
   },
   {
      "Name": "Pressure Conversion Cube",
      "ClassName": "Desc_PressureConversionCube_C",
      "Points": 257312,
      "PointsOverride": -1
   },
   {
      "Name": "Hover Pack",
      "ClassName": "BP_EquipmentDescriptorHoverPack_C",
      "Points": 413920,
      "PointsOverride": -1
   },
   {
      "Name": "Nuclear Pasta",
      "ClassName": "Desc_SpaceElevatorPart_9_C",
      "Points": 543424,
      "PointsOverride": -1
   },
   {
      "Name": "Assembly Director System",
      "ClassName": "Desc_SpaceElevatorPart_7_C",
      "Points": 543632,
      "PointsOverride": -1
   },
   {
      "Name": "Thermal Propulsion Rocket",
      "ClassName": "Desc_SpaceElevatorPart_8_C",
      "Points": 732956,
      "PointsOverride": -1
   }
]
```

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

### Create World Ping

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

Use this endpoint to create a world ping. It requires authentication and the coordinates for the ping. The first player to call this endpoint creates the ping.

```bash
curl -X POST 'http://localhost:8080/createPing' \
-H 'Content-Type: application/json' \
-H 'X-FRM-Authorization: <your access token>' \
--data-raw '{ 
  "x": 0, 
  "y": 0, 
  "z": 0 
}'
```

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

### Arduino Serial API Endpoint Transmission

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

Examples of how to send API Endpoints over serial from an Arduino. One example includes a line break, which might be necessary for certain protocols.

```arduino
Serial.print("<API Endpoint>"); // Send request for <API Endpoint>
```

```arduino
Serial.println("<API Endpoint>"); // Send request for <API Endpoint> with a line break
```

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

### Set Mod Setting Request Example

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

Use this cURL command to send a POST request to set a mod setting. Ensure you replace `<your access token>` with your actual token and adjust the `SplineSampleDistance` value as needed. This endpoint requires authentication.

```bash
curl -X POST 'http://localhost:8080/setModSetting' \
-H 'Content-Type: application/json' \
-H 'X-FRM-Authorization: <your access token>' \
--data-raw '{ 
  "SplineSampleDistance": 55 
}'
```

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

### GET /getRecipes

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

Retrieves information about all available recipes in the game. This endpoint is included within the getAll endpoint and runs in the game thread.

```APIDOC
## GET /getRecipes

### Description
Get information about all recipes.

### Method
GET

### Endpoint
`http://localhost:8080/getRecipes`

### Response
#### Success Response (200)
- **ID** (String) - Unique ID of the Recipe.
- **Name** (String) - Name of the Recipe.
- **ClassName** (String) - ClassName of the Recipe.
- **Category** (String) - Category of the Recipe.
- **ManualDuration** (Float) - The manual manufacturing duration for this recipe.
- **FactoryDuration** (Float) - The base manufacturing duration for this recipe.
- **Events** (String[]) - Event when the schematic is active. Possible Events: `Satisfactory Birthday`, `Christmas`, `Coffee Stain Studios Birthday`, `April Fools Day`.
- **ProducedIn** (String[]) - ClassName where the item can be produced (e.g. BP_BuildGun_C for the Build Gun).
- **Ingredients** (Object[]) - Ingredients for this recipe.
  - **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.
  - **ManualRate** (Float) - TODO
  - **FactoryRate** (Float) - TODO
- **Products** (Object[]) - Products produced by this recipe.
  - **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.
  - **ManualRate** (Float) - TODO
  - **FactoryRate** (Float) - TODO

### Response Example
```json
[
  {
    "ID": "Recipe_Fence_01_C",
    "Name": "Industrial Railing",
    "ClassName": "Recipe_Fence_01_C",
    "Category": "N/A",
    "Events": [],
    "Ingredients": [
      {
        "Name": "Iron Rod",
        "ClassName": "Desc_IronRod_C",
        "Amount": 4,
        "MaxAmount": 200,
        "ManualRate": 240,
        "FactoryRate": 240
      }
    ],
    "Products": [
      {
        "Name": "Industrial Railing",
        "ClassName": "Desc_Fence_01_C",
        "Amount": 1,
        "MaxAmount": 100,
        "ManualRate": 60,
        "FactoryRate": 60
      }
    ],
    "ProducedIn": [
      "BP_BuildGun_C"
    ],
    "ManualDuration": 1,
    "FactoryDuration": 1
  },
  {
    "ID": "Recipe_Wall_Window_8x4_03_Steel_C",
    "Name": "Panel Window",
    "ClassName": "Recipe_Wall_Window_8x4_03_Steel_C",
    "Category": "N/A",
    "Events": [],
    "Ingredients": [
      {
        "Name": "Iron Plate",
        "ClassName": "Desc_IronPlate_C",
        "Amount": 3,
        "MaxAmount": 200,
        "ManualRate": 180,
        "FactoryRate": 180
      },
      {
        "Name": "Concrete",
        "ClassName": "Desc_Cement_C",
        "Amount": 3,
        "MaxAmount": 500,
        "ManualRate": 180,
        "FactoryRate": 180
      }
    ],
    "Products": [
      {
        "Name": "Panel Window",
        "ClassName": "Desc_Wall_Window_8x4_03_Steel_C",
        "Amount": 1,
        "MaxAmount": 100,
        "ManualRate": 60,
        "FactoryRate": 60
      }
    ],
    "ProducedIn": [],
    "ManualDuration": 1,
    "FactoryDuration": 1
  }
]
```
```

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

### Get Song Tapes Information

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

Use this GET request to retrieve a list of all available Song Tapes. The response body contains an array of tape objects, each with details about its ID, name, class name, and a playlist of songs.

```HTTP
GET http://localhost:8080/getTapes
```

```JSON
[
  {
    "ID": "Tape_WorstOfGoat_C",
    "Name": "Worst of Goat Simulator",
    "ClassName": "Tape_WorstOfGoat_C",
    "Songs": [
      {
        "SongName": "Desert Chill",
        "ArtistName": "GSTFS"
      },
      {
        "SongName": "Goat Chill",
        "ArtistName": "GSTFS"
      },
      {
        "SongName": "Goat Storm",
        "ArtistName": "GSTFS"
      },
      {
        "SongName": "Goatshire",
        "ArtistName": "GSTFS"
      },
      {
        "SongName": "Waste Of Space",
        "ArtistName": "GSTFS"
      }
    ]
  }
]
```

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

### World API - Create Ping

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

Creates a ping marker at a specific location in the world.

```APIDOC
## POST /api/world/createPing

### Description
Creates a world ping.

### Method
POST

### Endpoint
/api/world/createPing

### Parameters
#### Request Body
- **location** (object) - Required - The coordinates for the ping.
  - **x** (number) - Required - The X-coordinate.
  - **y** (number) - Required - The Y-coordinate.
  - **z** (number) - Required - The Z-coordinate.
- **message** (string) - Optional - A message associated with the ping.

### Request Example
{
  "location": {
    "x": 100.5,
    "y": 50.0,
    "z": -200.75
  },
  "message": "Check this area for resources."
}

### Response
#### Success Response (200)
- **pingId** (string) - The unique identifier of the created ping.
- **success** (boolean) - Indicates if the ping was created successfully.

#### Response Example
{
  "pingId": "ping_xyz789",
  "success": true
}
```

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

### GET /getSessionInfo

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

Retrieves information about the current game session.

```APIDOC
## GET getSessionInfo

### Description
Gets information about the current session.

### Method
GET

### Endpoint
getSessionInfo
```

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

### Example Vehicle Response JSON

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

A sample JSON response body showing the structure of vehicle data, including location, storage, and fuel inventory.

```json
[
  {
    "ID": 0,
    "VehicleType": "Explorer",
    "location":
    {
      "x": -52341.4375,
      "y": -162543.21875,
      "z": -904.133544921875,
      "rotation": 313
    },
    "PathName": "Test Path",
    "Status": "Operational",
    "Driver": "porisius",
    "CurrentGear": 1,
    "ForwardSpeed": 11.1579312744141,
    "EngineRPM": 2244.17504882813,
    "ThrottlePercent": 0.400730907917023,
    "Airborne": false,
    "AutoPilot": false,
    "Storage": [
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 200
      },
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 200
      }
    ],
    "Fuel": [
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 199
      }
    ],
    "FollowingPath": false,
    "features":
    {
      "properties":
      {
        "name": "Explorer",
        "type": "Explorer"
      },
      "geometry":
      {
        "coordinates":
        {
          "X": -52341.4375,
          "Y": -162543.21875,
          "Z": -904.133544921875
        },
        "type": "Point"
      }
    }
  }
]
```

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

### Retrieve Pump and Valve Data

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

Example JSON response returned by the /getPump endpoint.

```json
[
  {
    "ID": "Build_PipelinePump_C_2146879650",
    "Name": "Pipeline Pump Mk.1",
    "ClassName": "Build_PipelinePump_C",
    "location": {
      "x": -5286.63427734375,
      "y": 48738.54296875,
      "z": 26675,
      "rotation": 0.191588392598305
    },
    "BoundingBox": {
      "min": {
        "x": -5454.63427734375,
        "y": 48678.54296875,
        "z": 26615
      },
      "max": {
        "x": -5074.63427734375,
        "y": 48798.54296875,
        "z": 26735
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "FA954900"
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  }
]
```

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

### Get Drone Station

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

Retrieves a list of all available drone stations.

```APIDOC
## GET /getDroneStation

### Description
Gets a list of all drone stations.

### Method
GET

### Endpoint
http://localhost:8080/getDroneStation

### Parameters

### Request Body

### Request Example

### Response
#### Success Response (200)
- **stations** (array) - A list of drone station objects.

#### Response Example
{
  "stations": [
    {
      "id": "drone_station_1",
      "name": "Drone Station Alpha",
      "location": {"x": 100, "y": 200, "z": 50}
    },
    {
      "id": "drone_station_2",
      "name": "Drone Station Beta",
      "location": {"x": -50, "y": 150, "z": 75}
    }
  ]
}
```

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

### GET /getVehicles

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

Retrieves a list of all vehicles currently in the game world.

```APIDOC
## GET getVehicles

### Description
Gets a list of all vehicles (tractors, trucks, trains, factory carts, etc.).

### Method
GET

### Endpoint
getVehicles
```

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

### GET /getHypertube

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

Retrieves a list of all Hypertubes currently registered in the system.

```APIDOC
## GET /getHypertube

### Description
Retrieves a list of all Hypertubes, including their unique IDs, class names, physical locations, and connection status.

### Method
GET

### Endpoint
http://localhost:8080/getHypertube

### Response
#### Success Response (200)
- **ID** (String) - Unique ID of the Hypertube.
- **Name** (String) - Name of the Hypertube Type.
- **ClassName** (String) - Class Name of the Hypertube.
- **ColorSlot** (Object) - Color/Decoration information.
- **BoundingBox** (Object) - Bounding Box information.
- **location0** (Object) - Start Location.
- **Connected0** (Boolean) - Is Hypertube Connected at starting point?
- **location1** (Object) - End Location.
- **Connected1** (Boolean) - Is Hypertube Connected at ending point?
- **Length** (Float) - Length of the Hypertube in cm.
- **ItemsPerMinute** (Float) - Speed of the Hypertube.
- **features** (Object) - Actor coordinates and name information.
- **properties** (Object) - Name information about the actor.
- **geometry** (Object) - Geometry information.

#### Response Example
[
  {
    "ID": "Build_PipeHyper_C_2146320548",
    "Name": "Hypertube",
    "ClassName": "Build_PipeHyper_C",
    "location": {
      "x": -251831.75,
      "y": -66029.2421875,
      "z": 1143.29541015625,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": -251831.75,
        "y": -66029.2421875,
        "z": 1143.29541015625
      },
      "max": {
        "x": -251831.75,
        "y": -66029.2421875,
        "z": 1143.29541015625
      }
    },
    "ColorSlot": {
      "PrimaryColor": "2D2D2D00",
      "SecondaryColor": "00000000"
    },
    "location0": {
      "x": -251831.75,
      "y": -66029.2421875,
      "z": 1143.29541015625
    },
    "location1": {
      "x": -252129.647245099,
      "y": -65920.8164624313,
      "z": 710.0068359375
    },
    "SplineData": [
      {
        "x": -251831.75,
        "y": -66029.2421875,
        "z": 1143.29541015625
      }
    ]
  }
]
```
Tokens:
Raw