Fika API

All our APIs (last updated for SPT 4.0, Fika 2.0)

Overview

An API key is automatically generated on first launch. You can find it in the fika.jsonc file in the configuration folder.

Use the API key to authenticate when making request. You also need to add the requestcompressed header with a value of 0.

Authentication example for C#

client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", config.APIKey);
client.DefaultRequestHeaders.Add("requestcompressed", "0");

In e.g. Postman, the authentication type is "API Key", with the key being "Authorization" and the value being "Bearer {apiKey}".

Get

fika/api/items

Returns all items from the SPT database, with the MongoID being the identifier, and the name, description and stackable amount being values. Example response:

{
    "items": {
        "5447a9cd4bdc2dbd208b4567": {
            "name": "Colt M4A1 5.56x45 assault rifle",
            "description": "The Colt M4A1 carbine is a fully automatic variant of the basic M4 Carbine and was primarily designed for special operations use.\nHowever, U.S. Special Operations Command (USSOCOM) was soon to adopt the M4A1 for almost all special operations units, followed later by general introduction of the M4A1 into service with the U.S. Army and Marine Corps.",
            "stackable": 10
        }
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "GetItemsResponse",
  "type": "object",
  "properties": {
    "items": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/ItemData"
      }
    }
  },
  "required": ["items"],

  "$defs": {
    "ItemData": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "stackable": {
          "type": "integer",
          "description": "Number of items that can stack together (StackAmount)."
        }
      },
      "required": ["name", "description", "stackable"]
    }
  }
}

fika/api/raids

Returns all active raids.

Example response:

{
  "64f92bdacb123456789abcde": {
    "ips": ["192.168.1.10"],
    "serverGuid": "2fbb7ba6-327e-4c58-8f87-75e43da5a5f5",
    "port": 7070,
    "hostUsername": "PlayerOne",
    "timestamp": 1730840102,
    "crc32": 123456789,
    "gameVersion": "1.0.0",
    "raidConfig": {},
    "locationData": {},
    "status": 1,
    "timeout": 300,
    "players": {
      "64f92bdae8123456789aaaaa": {
        "groupId": "group123",
        "isDead": false,
        "isSpectator": false
      }
    },
    "side": 0,
    "time": 0,
    "raidCode": "ABCD1234",
    "natPunch": true,
    "isHeadless": false,
    "raids": 5
  }
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MatchesResponse",
  "type": "object",
  "description": "Dictionary<string, FikaMatch>",
  "additionalProperties": {
    "$ref": "#/$defs/FikaMatch"
  },

  "$defs": {
    "FikaMatch": {
      "type": "object",
      "properties": {
        "ips": {
          "type": "array",
          "items": { "type": "string" }
        },
        "serverGuid": {
          "type": "string",
          "format": "uuid"
        },
        "port": {
          "type": "integer"
        },
        "hostUsername": {
          "type": "string"
        },
        "timestamp": {
          "type": "integer"
        },
        "crc32": {
          "type": "integer",
          "minimum": 0
        },
        "gameVersion": {
          "type": "string"
        },
        "raidConfig": {
          "description": "Ignored type placeholder.",
          "type": "object"
        },
        "locationData": {
          "description": "Ignored type placeholder.",
          "type": "object"
        },
        "status": {
          "$ref": "#/$defs/EFikaMatchStatus"
        },
        "timeout": {
          "type": "integer"
        },
        "players": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/FikaPlayer"
          }
        },
        "side": {
          "$ref": "#/$defs/EFikaSide"
        },
        "time": {
          "$ref": "#/$defs/EFikaTime"
        },
        "raidCode": {
          "type": "string"
        },
        "natPunch": {
          "type": "boolean"
        },
        "isHeadless": {
          "type": "boolean"
        },
        "raids": {
          "type": "integer"
        }
      },
      "required": [
        "raidConfig",
        "locationData",
        "status",
        "side",
        "time"
      ]
    },

    "FikaPlayer": {
      "type": "object",
      "properties": {
        "groupId": { "type": "string" },
        "isDead": { "type": "boolean" },
        "isSpectator": { "type": "boolean" }
      },
      "required": ["groupId", "isDead", "isSpectator"]
    },

    "EFikaMatchStatus": {
      "type": "integer",
      "enum": [0, 1, 2],
      "description": "0=LOADING, 1=IN_GAME, 2=COMPLETE"
    },

    "EFikaSide": {
      "type": "integer",
      "enum": [0, 1],
      "description": "0=PMC, 1=Savage"
    },

    "EFikaTime": {
      "type": "integer",
      "enum": [0, 1],
      "description": "0=CURR, 1=PAST"
    }
  }
}

fika/api/headless

Returns all active headless clients.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "GetHeadlessResponse",
  "type": "object",
  "properties": {
    "headlessClients": {
      "type": "array",
      "items": { "$ref": "#/$defs/OnlineHeadless" }
    }
  },
  "required": ["headlessClients"],

  "$defs": {
    "OnlineHeadless": {
      "type": "object",
      "properties": {
        "profileId": { "type": "string" },
        "nickname": { "type": "string" },
        "state": { "$ref": "#/$defs/EHeadlessState" },
        "players": { "type": "integer" }
      },
      "required": ["profileId", "nickname", "state", "players"]
    },
    "EHeadlessState": {
      "type": "integer",
      "enum": [0, 1],
      "description": "0 = Ready, 1 = NotReady"
    }
  }
}

fika/api/heartbeat

Checks whether the server is running. Primarily used by the WebApp.

fika/api/players

Returns all online players.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "GetOnlinePlayersResponse.schema.json",
  "title": "GetOnlinePlayersResponse",
  "type": "object",
  "properties": {
    "players": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OnlinePlayer"
      }
    }
  },
  "required": ["players"],

  "$defs": {
    "OnlinePlayer": {
      "type": "object",
      "properties": {
        "profileId": {
          "type": "string"
        },
        "nickname": {
          "type": "string"
        },
        "level": {
          "type": "integer"
        },
        "location": {
          "$ref": "#/$defs/EFikaLocation"
        }
      },
      "required": ["profileId", "nickname", "level", "location"]
    },

    "EFikaLocation": {
      "type": "integer",
      "description": "Enumeration representing player location.",
      "enum": [
        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
      ],
      "enumNames": [
        "None",
        "Hideout",
        "Factory",
        "Customs",
        "Woods",
        "Shoreline",
        "Interchange",
        "Reserve",
        "Streets",
        "Lighthouse",
        "GroundZero",
        "Laboratory",
        "Labyrinth"
      ]
    }
  }
}

fika/api/rawprofile

Returns a raw profile in JSON format.

Input:

Key	Value	Description
profileId	{validMongoID}	The MongoID to return a raw profile of.

Example input:

{baseUrl}/fika/api/rawprofile?profileId=68e8f63d941b8a1c94c1d8bf

Post

fika/api/fleaban

Bans a player from the flea for X amount of days. 0 = infinite.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Flea Ban Request",
  "description": "Schema for banning a player from the flea market for a specified number of days.",
  "type": "object",
  "properties": {
    "profileId": {
      "type": "string",
      "description": "Unique identifier for the player's profile."
    },
    "amountOfDays": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of days the player is banned. 0 means the ban is infinite."
    }
  },
  "required": ["profileId", "amountOfDays"],
  "additionalProperties": false
}

fika/api/createheadlessprofile

Creates one headless profile. Used by the installer, not recommended to be used.

fika/api/logout

Logs out the given MongoID from the game.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Logout Request",
  "description": "Schema for logging out a player from the game using their MongoID profile ID.",
  "type": "object",
  "properties": {
    "profileId": {
      "type": "string",
      "description": "The MongoDB ObjectID of the player to log out."
    }
  },
  "required": ["profileId"],
  "additionalProperties": false
}

fika/api/restartheadless

Restarts the headless with the given MongoID.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Restart Headless Request",
  "description": "Schema for restarting the headless instance associated with a given player profile ID.",
  "type": "object",
  "properties": {
    "profileId": {
      "type": "string",
      "description": "The MongoDB ObjectID of the player whose headless instance should be restarted."
    }
  },
  "required": ["profileId"],
  "additionalProperties": false
}

fika/api/senditem

Sends X amount of items to the given MongoID.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Send Item Request",
  "description": "Schema for sending an item to a player with a given MongoID profile ID.",
  "type": "object",
  "properties": {
    "itemTpl": {
      "type": "string",
      "description": "Template ID of the item being sent."
    },
    "amount": {
      "type": "integer",
      "minimum": 1,
      "description": "Number of items to send."
    },
    "message": {
      "type": "string",
      "maxLength": 255,
      "description": "Optional message sent with the item. Can be empty."
    },
    "fir": {
      "type": "boolean",
      "description": "Whether the item is marked as Found In Raid (FIR)."
    },
    "expirationDays": {
      "type": "integer",
      "minimum": 1,
      "description": "Number of days before the message expires."
    },
    "profileId": {
      "type": "string",
      "description": "The MongoDB ObjectID of the player to send the item to."
    }
  },
  "required": [
    "itemTpl",
    "amount",
    "message",
    "fir",
    "expirationDays",
    "profileId"
  ],
  "additionalProperties": false
}

fika/api/senditemtoall

Sends X amount of items to the given MongoIDs.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Send Item To Multiple Players Request",
  "description": "Schema for sending items to multiple players using their MongoID profile IDs.",
  "type": "object",
  "properties": {
    "itemTpl": {
      "type": "string",
      "description": "Template ID of the item being sent."
    },
    "amount": {
      "type": "integer",
      "minimum": 1,
      "description": "Number of items to send to each player."
    },
    "message": {
      "type": "string",
      "maxLength": 255,
      "description": "Optional message sent with the item. Can be empty."
    },
    "fir": {
      "type": "boolean",
      "description": "Whether the item is marked as Found In Raid (FIR)."
    },
    "expirationDays": {
      "type": "integer",
      "minimum": 1,
      "description": "Number of days before the message expires."
    },
    "profileIds": {
      "type": "array",
      "description": "List of MongoDB ObjectIDs representing the player profiles to send the items to.",
      "items": {
        "type": "string"
      },
      "minItems": 1
    }
  },
  "required": [
    "itemTpl",
    "amount",
    "message",
    "fir",
    "expirationDays",
    "profileIds"
  ],
  "additionalProperties": false
}

fika/api/sendmessage

Sends a message to a MongoID.

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Send Message Request",
  "description": "Schema for sending a message to a player using their MongoID profile ID.",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 255,
      "description": "Message to send to the player. Can be empty."
    },
    "profileId": {
      "type": "string",
      "description": "The MongoDB ObjectID of the player to send the message to."
    }
  },
  "required": ["message", "profileId"],
  "additionalProperties": false
}