api-docs/models/MarketTradeGood.json

55 lines
1.4 KiB
JSON
Raw Normal View History

2022-10-06 01:42:15 +02:00
{
"type": "object",
"properties": {
"symbol": {
2023-11-01 00:31:35 +01:00
"$ref": "./TradeSymbol.json"
2022-10-06 01:42:15 +02:00
},
"type": {
2022-10-06 01:42:15 +02:00
"type": "string",
"description": "The type of trade good (export, import, or exchange).",
"enum": [
2023-11-11 21:24:54 +01:00
"EXPORT",
"IMPORT",
"EXCHANGE"
]
2022-10-06 01:42:15 +02:00
},
2023-10-26 02:27:37 +02:00
"type": {
"type": "string",
"description": "The type of trade good (export, import, or exchange).",
"enum": [
"EXPORT",
"IMPORT",
"EXCHANGE"
]
},
2022-10-06 01:42:15 +02:00
"tradeVolume": {
"type": "integer",
2023-10-26 02:27:37 +02:00
"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.",
2022-12-26 18:50:36 +01:00
"minimum": 1
2022-10-06 01:42:15 +02:00
},
"supply": {
2023-10-26 02:27:37 +02:00
"$ref": "./SupplyLevel.json"
},
"activity": {
"$ref": "./ActivityLevel.json"
2022-10-06 01:42:15 +02:00
},
"purchasePrice": {
"type": "integer",
2022-12-08 07:12:49 +01:00
"description": "The price at which this good can be purchased from the market.",
2022-10-06 01:42:15 +02:00
"minimum": 0
},
"sellPrice": {
"type": "integer",
2022-12-08 07:12:49 +01:00
"description": "The price at which this good can be sold to the market.",
2022-10-06 01:42:15 +02:00
"minimum": 0
}
2022-10-22 18:05:01 +02:00
},
"required": [
"symbol",
2023-10-26 02:27:37 +02:00
"type",
2022-10-22 18:05:01 +02:00
"tradeVolume",
"supply",
"purchasePrice",
"sellPrice"
]
2022-10-06 01:42:15 +02:00
}