api-docs/models/MarketTradeGood.json

{
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string",
      "description": "The symbol of the trade good."
    },
    "type": {
      "type": "string",
      "description": "The type of trade good (export, import, or exchange).",
      "enum": [
        "EXPORT",
        "IMPORT",
        "EXCHANGE"
      ]
    },
    "tradeVolume": {
      "type": "integer",
      "description": "This is the maximum number of units that can be purchased or sold at this market in a single trade for this good. Trade volume also gives an indication of price volatility. A market with a low trade volume will have large price swings, while high trade volume will be more resilient to price changes.",
      "minimum": 1
    },
    "supply": {
      "$ref": "./SupplyLevel.json"
    },
    "activity": {
      "$ref": "./ActivityLevel.json"
    },
    "purchasePrice": {
      "type": "integer",
      "description": "The price at which this good can be purchased from the market.",
      "minimum": 0
    },
    "sellPrice": {
      "type": "integer",
      "description": "The price at which this good can be sold to the market.",
      "minimum": 0
    }
  },
  "required": [
    "symbol",
    "type",
    "tradeVolume",
    "supply",
    "purchasePrice",
    "sellPrice"
  ]
}