tornapi-typescript 5.2.3 → 5.4.1

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Torn API",
     "description": "\n * The development of Torn's API v2 is still ongoing.\n * If selections remain unaltered, they will default to the API v1 version.\n * Unlike API v1, API v2 accepts both selections and IDs as path and query parameters.\n * If any discrepancies or errors are found, please submit a [bug report](https://www.torn.com/forums.php#/p=forums&f=19&b=0&a=0) on the Torn Forums.\n * In case you're using bots to check for changes on openapi.json file, make sure to specificy a custom user-agent header - CloudFlare sometimes prevents requests from default user-agents.",
-    "version": "5.2.3"
+    "version": "5.4.1"
   },
   "servers": [
     {
@@ -2243,6 +2243,45 @@
         "x-stability": "Stable"
       }
     },
+    "/user/organizedcrimes": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get available slots for organized crimes with status 'Recruiting'",
+        "description": "Requires minimal access key. <br>Unlike 'faction' -> 'crimes', this selection only shows empty slots, and only for crimes with the 'Recruiting' status.",
+        "operationId": "getMyAvailableOrganizedCrimes",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyMinimal"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserOrganizedCrimesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/user/personalstats": {
       "get": {
         "tags": [
@@ -3032,6 +3071,45 @@
         "x-stability": "Stable"
       }
     },
+    "/user/stocks": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your stocks",
+        "description": "Requires limited access key. <br>",
+        "operationId": "getMyStocks",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserStocksResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/travel": {
       "get": {
         "tags": [
@@ -3447,6 +3525,9 @@
                     {
                       "$ref": "#/components/schemas/UserEducationResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserStocksResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserBountiesResponse"
                     },
@@ -9162,6 +9243,93 @@
         "x-stability": "Stable"
       }
     },
+    "/torn/stocks": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get all stocks",
+        "description": "Requires public access key. <br>",
+        "operationId": "getTornStocks",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornStocksResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
+    "/torn/{stockId}/stocks": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get specific stock with chart history",
+        "description": "Requires public access key. <br>",
+        "operationId": "getSpecificTornStock",
+        "parameters": [
+          {
+            "name": "stockId",
+            "in": "path",
+            "description": "Stock id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/StockId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornStockDetailedResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/torn/{crimeId}/subcrimes": {
       "get": {
         "tags": [
@@ -9383,6 +9551,9 @@
                 {
                   "$ref": "#/components/schemas/TornCrimeId"
                 },
+                {
+                  "$ref": "#/components/schemas/StockId"
+                },
                 {
                   "$ref": "#/components/schemas/EliminationTeamId"
                 },
@@ -9547,6 +9718,12 @@
                     {
                       "$ref": "#/components/schemas/AttackLogResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/TornStockDetailedResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/TornStocksResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/TornTerritoriesResponse"
                     },
@@ -14020,10 +14197,7 @@
           "attacksdamaging",
           "attacksrunaway",
           "highestterritories",
-          "territoryrespect",
-          "membersamount",
-          "factionage",
-          "upgradesamount"
+          "territoryrespect"
         ]
       },
       "FactionBranchStateEnum": {
@@ -14195,6 +14369,19 @@
           "P6"
         ]
       },
+      "TornOrganizedCrimePositionIdDeprecated": {
+        "description": "This field is now available in 'position_info' object as 'id' field.<br>This field will be removed on 1st of June 2026.",
+        "type": "string",
+        "enum": [
+          "P1",
+          "P2",
+          "P3",
+          "P4",
+          "P5",
+          "P6"
+        ],
+        "deprecated": true
+      },
       "FactionTerritoryWarResultEnum": {
         "type": "string",
         "enum": [
@@ -14597,6 +14784,10 @@
         "type": "integer",
         "format": "int32"
       },
+      "StockId": {
+        "type": "integer",
+        "format": "int32"
+      },
       "DiscordId": {
         "type": "string"
       },
@@ -16825,6 +17016,115 @@
           }
         ]
       },
+      "UserStockTransaction": {
+        "required": [
+          "id",
+          "shares",
+          "price",
+          "timestamp"
+        ],
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "shares": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "price": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserStock": {
+        "required": [
+          "id",
+          "shares",
+          "bonus",
+          "transactions"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/StockId"
+          },
+          "shares": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "transactions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserStockTransaction"
+            }
+          },
+          "bonus": {
+            "required": [
+              "available",
+              "increment",
+              "progress",
+              "frequency"
+            ],
+            "properties": {
+              "available": {
+                "type": "boolean"
+              },
+              "increment": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "progress": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "frequency": {
+                "type": "integer",
+                "format": "int32"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "UserStocksResponse": {
+        "required": [
+          "stocks"
+        ],
+        "properties": {
+          "stocks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserStock"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserOrganizedCrimesResponse": {
+        "required": [
+          "organizedcrimes",
+          "_metadata"
+        ],
+        "properties": {
+          "organizedcrimes": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FactionCrime"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
       "UserEquipment": {
         "allOf": [
           {
@@ -20161,7 +20461,8 @@
       },
       "UserBountiesResponse": {
         "required": [
-          "bounties"
+          "bounties",
+          "bounties_timestamp"
         ],
         "properties": {
           "bounties": {
@@ -20169,6 +20470,10 @@
             "items": {
               "$ref": "#/components/schemas/Bounty"
             }
+          },
+          "bounties_timestamp": {
+            "type": "integer",
+            "format": "int32"
           }
         },
         "type": "object"
@@ -20474,7 +20779,7 @@
       "UserSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks','stocks'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks'.",
             "type": "string",
             "enum": [
               "ammo",
@@ -20529,6 +20834,7 @@
               "revives",
               "revivesfull",
               "skills",
+              "stocks",
               "timestamp",
               "travel",
               "weaponexp",
@@ -20540,8 +20846,7 @@
               "gym",
               "inventory",
               "networth",
-              "perks",
-              "stocks"
+              "perks"
             ]
           },
           {
@@ -23758,6 +24063,26 @@
         },
         "type": "object"
       },
+      "FactionSlotPositionInfo": {
+        "required": [
+          "id",
+          "label",
+          "number"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/TornOrganizedCrimePositionId"
+          },
+          "label": {
+            "type": "string"
+          },
+          "number": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
       "FactionRaidReportFaction": {
         "required": [
           "id",
@@ -26254,8 +26579,7 @@
       "FactionCrimeSlot": {
         "required": [
           "position",
-          "position_id",
-          "position_number",
+          "position_info",
           "item_requirement",
           "user",
           "checkpoint_pass_rate"
@@ -26264,12 +26588,17 @@
           "position": {
             "type": "string"
           },
+          "position_info": {
+            "$ref": "#/components/schemas/FactionSlotPositionInfo"
+          },
           "position_id": {
-            "$ref": "#/components/schemas/TornOrganizedCrimePositionId"
+            "$ref": "#/components/schemas/TornOrganizedCrimePositionIdDeprecated"
           },
           "position_number": {
+            "description": "This field is now available in 'position_info' object as 'number' field.<br>This field will be removed on 1st of June 2026.",
             "type": "integer",
-            "format": "int32"
+            "format": "int32",
+            "deprecated": true
           },
           "item_requirement": {
             "description": "Details of item required for the slot, if applicable.",
@@ -27791,12 +28120,17 @@
       "MarketRentalsResponse": {
         "required": [
           "rentals",
+          "rentals_timestamp",
           "_metadata"
         ],
         "properties": {
           "rentals": {
             "$ref": "#/components/schemas/MarketRentalDetails"
           },
+          "rentals_timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }
@@ -27855,12 +28189,17 @@
       "MarketPropertiesResponse": {
         "required": [
           "properties",
+          "properties_timestamp",
           "_metadata"
         ],
         "properties": {
           "properties": {
             "$ref": "#/components/schemas/MarketPropertyDetails"
           },
+          "properties_timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }
@@ -29077,6 +29416,240 @@
         },
         "type": "object"
       },
+      "TornStock": {
+        "required": [
+          "id",
+          "name",
+          "images",
+          "acronym",
+          "market",
+          "bonus"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/StockId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "acronym": {
+            "type": "string"
+          },
+          "images": {
+            "required": [
+              "logo",
+              "full"
+            ],
+            "properties": {
+              "logo": {
+                "type": "string"
+              },
+              "full": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "market": {
+            "required": [
+              "price",
+              "cap",
+              "shares",
+              "investors"
+            ],
+            "properties": {
+              "price": {
+                "type": "number",
+                "format": "float"
+              },
+              "cap": {
+                "type": "integer",
+                "format": "int64"
+              },
+              "shares": {
+                "type": "integer",
+                "format": "int64"
+              },
+              "investors": {
+                "type": "integer",
+                "format": "int64"
+              }
+            },
+            "type": "object"
+          },
+          "bonus": {
+            "required": [
+              "passive",
+              "frequency",
+              "requirement",
+              "description"
+            ],
+            "properties": {
+              "passive": {
+                "type": "boolean"
+              },
+              "frequency": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "requirement": {
+                "type": "integer",
+                "format": "int64"
+              },
+              "description": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TornStockPerformance": {
+        "required": [
+          "change",
+          "change_percentage",
+          "start",
+          "end",
+          "high",
+          "low"
+        ],
+        "properties": {
+          "change": {
+            "type": "number",
+            "format": "float"
+          },
+          "change_percentage": {
+            "type": "number",
+            "format": "float"
+          },
+          "start": {
+            "type": "number",
+            "format": "float"
+          },
+          "end": {
+            "type": "number",
+            "format": "float"
+          },
+          "high": {
+            "type": "number",
+            "format": "float"
+          },
+          "low": {
+            "type": "number",
+            "format": "float"
+          }
+        },
+        "type": "object"
+      },
+      "TornStockHistory": {
+        "required": [
+          "price",
+          "change",
+          "timestamp"
+        ],
+        "properties": {
+          "price": {
+            "type": "number",
+            "format": "float"
+          },
+          "change": {
+            "type": "number",
+            "format": "float"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "TornStockDetailed": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/TornStock"
+          },
+          {
+            "required": [
+              "chart"
+            ],
+            "properties": {
+              "chart": {
+                "required": [
+                  "performance",
+                  "history"
+                ],
+                "properties": {
+                  "performance": {
+                    "required": [
+                      "last_hour",
+                      "last_day",
+                      "last_week",
+                      "last_month",
+                      "last_year",
+                      "all_time"
+                    ],
+                    "properties": {
+                      "last_hour": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      },
+                      "last_day": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      },
+                      "last_week": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      },
+                      "last_month": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      },
+                      "last_year": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      },
+                      "all_time": {
+                        "$ref": "#/components/schemas/TornStockPerformance"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "history": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/TornStockHistory"
+                    }
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          }
+        ]
+      },
+      "TornStocksResponse": {
+        "required": [
+          "stocks"
+        ],
+        "properties": {
+          "stocks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornStock"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornStockDetailedResponse": {
+        "required": [
+          "stocks"
+        ],
+        "properties": {
+          "stocks": {
+            "$ref": "#/components/schemas/TornStockDetailed"
+          }
+        },
+        "type": "object"
+      },
       "TornEliminationTeamLeader": {
         "allOf": [
           {
@@ -29538,13 +30111,16 @@
       },
       "TornOrganizedCrimeSlot": {
         "required": [
-          "id",
+          "position_info",
           "name",
           "required_item"
         ],
         "properties": {
           "id": {
-            "$ref": "#/components/schemas/TornOrganizedCrimePositionId"
+            "$ref": "#/components/schemas/TornOrganizedCrimePositionIdDeprecated"
+          },
+          "position_info": {
+            "$ref": "#/components/schemas/FactionSlotPositionInfo"
           },
           "name": {
             "type": "string"
@@ -30595,6 +31171,7 @@
       "TornBountiesResponse": {
         "required": [
           "bounties",
+          "bounties_timestamp",
           "_metadata"
         ],
         "properties": {
@@ -30604,6 +31181,10 @@
               "$ref": "#/components/schemas/Bounty"
             }
           },
+          "bounties_timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }
@@ -31100,7 +31681,7 @@
       "TornSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.\n *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats'.\n *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
             "type": "string",
             "enum": [
               "attacklog",
@@ -31124,6 +31705,7 @@
               "merits",
               "organizedcrimes",
               "properties",
+              "stocks",
               "subcrimes",
               "territory",
               "timestamp",
@@ -31141,8 +31723,7 @@
               "rockpaperscissors",
               "searchforcash",
               "shoplifting",
-              "stats",
-              "stocks"
+              "stats"
             ]
           },
           {