api-docs/models/Agent.json

{
  "description": "Agent details.",
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "minLength": 1,
      "description": "Account ID that is tied to this agent."
    },
    "symbol": {
      "type": "string",
      "minLength": 1,
      "description": "Symbol of the agent."
    },
    "headquarters": {
      "type": "string",
      "minLength": 1,
      "description": "The headquarters of the agent."
    },
    "credits": {
      "type": "integer",
      "format": "int64",
      "description": "The number of credits the agent has available. Credits can be negative if funds have been overdrawn."
    },
    "startingFaction": {
      "type": "string",
      "minLength": 1,
      "description": "The faction the agent started with."
    }
  },
  "required": [
    "accountId",
    "symbol",
    "headquarters",
    "credits",
    "startingFaction"
  ]
}