torngen.path

class Faction(base_query.BaseQuery):

A collection of paths representing Faction.

revives = <base_path.Path object>

/faction/revives: Get your faction's detailed revives Requires limited access key with faction API access permissions.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
search = <base_path.Path object>

/faction/search: Search factions by name or other criteria Requires public access key.
This selection is standalone and cannot be used together with other selections.

Parameters

  • name : Name to search for.
  • filters : A filtering query parameter allowing a comma-separated list of filters. * Each filter can be one of the following: * Fixed options: 'destroyed', 'notDestroyed', 'recruiting', 'notRecruiting' * Dynamic options: fieldName+condition+number, where: * * fieldName is one of: id, respect, members * * condition is one of: Equal, NotEqual, Less, LessOrEqual, GreaterOrEqual, Greater * * number: any integer value * Examples: filters=destroyed, filters=notDestroyed,recruiting, filters=respectLessOrEqual20000,idGreater100,notRecruiting
  • limit : N/A
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
news = <base_path.Path object>

/faction/news: Get your faction's news details Requires minimal access key with faction API access permissions.
It is possible to pass up to 10 categories at the time (comma separated). Categories 'attack', 'depositFunds' and 'giveFunds' are only available with 'Custom', 'Limited' or 'Full' access keys.

Parameters

  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • cat : News category type
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
rankedwars = <base_path.Path object>

/faction/rankedwars: Get ranked wars history for your faction Requires public access key.

Parameters

  • cat : This parameter is deprecated. The ranked wars list can now instead be fetched via 'faction' -> 'warfare' endpoint. This functionality will be removed on 1st of September 2025. (DEPRECATED)
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • sort : Sorted by the greatest timestamps
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
lookup = <base_path.Path object>

/faction/lookup: Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
revivesFull = <base_path.Path object>

/faction/revivesFull: Get your faction's simplified revives Requires limited access key with faction API access permissions.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
reports = <base_path.Path object>

/faction/reports: Get faction reports Requires limited access key.

  • The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.

# Parameters

  • cat : Used to filter reports with a specific type.
  • target : Get reports for a specific player by passing their player ID.
  • limit : N/A
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
hof = <base_path.Path object>

/faction/hof: Get your faction's hall of fame rankings. Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
wars = <base_path.Path object>

/faction/wars: Get your faction's wars & pacts details Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
chain = <base_path.Path object>

/faction/chain: Get your faction's current chain Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
territory = <base_path.Path object>

/faction/territory: Get a list of your faction's territories Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
members = <base_path.Path object>

/faction/members: Get a list of your faction's members Requires public access key.
The 'revive_setting' value will be populated (not Unknown) if you have faction permissions (with custom, limited or full access keys), otherwise it will be set as 'Unknown'.

Parameters

  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/faction/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
rackets = <base_path.Path object>

/faction/rackets: Get a list of current rackets Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
applications = <base_path.Path object>

/faction/applications: Get your faction's applications Requires minimal access key with faction API access permissions.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
basic = <base_path.Path object>

/faction/basic: Get your faction's basic details Requires public access key.
The 'is_enlisted' value will be populated if you have API faction permissions (with custom, limited or full access keys), otherwise it will be set as null.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
chainreport = <base_path.Path object>

/faction/chainreport: Get your faction's latest chain report Requires public access key.
This includes currently ongoing chains.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
attacksfull = <base_path.Path object>

/faction/attacksfull: Get your faction's simplified attacks Requires limited access key with faction API access permissions.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
positions = <base_path.Path object>

/faction/positions: Get your faction's positions details Requires minimal access key with faction API access permissions.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
attacks = <base_path.Path object>

/faction/attacks: Get your faction's detailed attacks Requires limited access key with faction API access permissions.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
warfare = <base_path.Path object>

/faction/warfare: Get faction warfare Requires public access key.
The response depends on the selected category.

Parameters

  • cat : N/A
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
chains = <base_path.Path object>

/faction/chains: Get a list of your faction's completed chains Requires public access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
balance = <base_path.Path object>

/faction/balance: Get your faction's & member's balance details Requires limited access key with faction API access permissions.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
contributors = <base_path.Path object>

/faction/contributors: Get your faction's challenge contributors Requires limiteed access key with faction API access permissions.

Parameters

  • stat : Get contributors for this field.
  • cat : By default, this selection will return only current faction's member contributions, and the option 'all' will return all contributors.
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
raids = <base_path.Path object>

/faction/raids: Get raids history for your faction Requires public access key.

Parameters

  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • sort : Sorted by the greatest timestamps
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
territorywars = <base_path.Path object>

/faction/territorywars: Get territory wars history for your faction Requires public access key.

Parameters

  • cat : This parameter is deprecated. The territory wars list can now instead be fetched via 'faction' -> 'warfare' endpoint. This functionality will be removed on 1st of September 2025. (DEPRECATED)
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • sort : Sorted by the greatest timestamps
  • limit : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
stats = <base_path.Path object>

/faction/stats: Get your faction's challenges stats Requires minimal access key with faction API access permissions.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
territoryownership = <base_path.Path object>

/faction/territoryownership: Get a list of your faction's territories Requires public access key.

Parameters

  • offset : N/A
  • limit : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
upgrades = <base_path.Path object>

/faction/upgrades: Get your faction's upgrades Requires minimal access key with faction API access permissions.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
crimes = <base_path.Path object>

/faction/crimes: Get your faction's organized crimes Requires minimal access key with faction API access permissions.
It's possible to get older entries either by timestamp range (from, to) or with offset.
Crimes are ordered depending on the category chosen:

  • For categories 'all' & 'available', the ordering field is 'created_at'.
  • For categories 'successful', 'failed' & 'completed', the ordering field is 'executed_at'.
  • For categories 'recruiting' & 'expired', the ordering field is 'expired_at'.
  • For category 'planning', the ordering field is 'ready_at'.

# Parameters

  • cat : Category of organized crimes returned. Category 'available' includes both 'recruiting' & 'planning', and category 'completed' includes both 'successful' & 'failure' Default category is 'all'.
  • filters : It's possible to set this parameter to specify a field used for the sort, from & to query parameters. If not specified, the field will default to the category sorting as described above.
  • offset : N/A
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • sort : Sorted by the greatest timestamps
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionChainId(base_query.BaseQuery):

A collection of paths representing FactionChainId.

chainreport = <base_path.Path object>

/faction/{chainId}/chainreport: Get a chain report Requires public access key.
Chain reports for ongoing chains are available only for your own faction.

Parameters

  • chainId : Chain id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionCrimeId(base_query.BaseQuery):

A collection of paths representing FactionCrimeId.

crime = <base_path.Path object>

/faction/{crimeId}/crime: Get a specific organized crime Requires minimal access key with faction API access permissions.

Parameters

  • crimeId : Crime id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionId(base_query.BaseQuery):

A collection of paths representing FactionId.

hof = <base_path.Path object>

/faction/{id}/hof: Get a faction's hall of fame rankings. Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
wars = <base_path.Path object>

/faction/{id}/wars: Get a faction's wars & pacts details Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
rankedwars = <base_path.Path object>

/faction/{id}/rankedwars: Get a faction's ranked wars history Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
chains = <base_path.Path object>

/faction/{id}/chains: Get a list of a faction's completed chains Requires public access key.

Parameters

  • id : Faction id
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
raids = <base_path.Path object>

/faction/{id}/raids: Get a faction's raids history Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
chain = <base_path.Path object>

/faction/{id}/chain: Get a faction's current chain Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
members = <base_path.Path object>

/faction/{id}/members: Get a list of a faction's members Requires public access key.
The 'revive_setting' value will be populated (not Unknown) if you're requesting data for your own faction and have faction permissions (with custom, limited or full access keys), otherwise it will be set as 'Unknown'.

Parameters

  • id : Faction id
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
territory = <base_path.Path object>

/faction/{id}/territory: Get a list of a faction's territories Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
basic = <base_path.Path object>

/faction/{id}/basic: Get a faction's basic details Requires public access key.
The 'is_enlisted' value will be populated if you're requesting data for your faction and have faction permissions (with custom, limited or full access keys), otherwise it will be set as null.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
territorywars = <base_path.Path object>

/faction/{id}/territorywars: Get a faction's territory wars history Requires public access key.

Parameters

  • id : Faction id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionRaidWarId(base_query.BaseQuery):

A collection of paths representing FactionRaidWarId.

raidreport = <base_path.Path object>

/faction/{raidWarId}/raidreport: Get raid war details Requires public access key.

Parameters

  • raidWarId : Raid war id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionRankedWarId(base_query.BaseQuery):

A collection of paths representing FactionRankedWarId.

rankedwarreport = <base_path.Path object>

/faction/{rankedWarId}/rankedwarreport: Get ranked war details Requires public access key.

Parameters

  • rankedWarId : Ranked war id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class FactionTerritoryWarId(base_query.BaseQuery):

A collection of paths representing FactionTerritoryWarId.

territorywarreport = <base_path.Path object>

/faction/{territoryWarId}/territorywarreport: Get territory war details Requires public access key.

Parameters

  • territoryWarId : Territory war id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Forum(base_query.BaseQuery):

A collection of paths representing Forum.

lookup = <base_path.Path object>

/forum/lookup: Get all available forum selections Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
threads = <base_path.Path object>

/forum/threads: Get threads across all forum categories Requires public access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/forum/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
categories = <base_path.Path object>

/forum/categories: Get publicly available forum categories Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class ForumCategoryIds(base_query.BaseQuery):

A collection of paths representing ForumCategoryIds.

threads = <base_path.Path object>

/forum/{categoryIds}/threads: Get threads for specific public forum category or categories Requires public access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • categoryIds : Category id or a list of category ids (comma separated)
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class ForumThreadId(base_query.BaseQuery):

A collection of paths representing ForumThreadId.

thread = <base_path.Path object>

/forum/{threadId}/thread: Get specific thread details Requires public access key.
Contains details of a thread including topic content and poll (if any).

Parameters

  • threadId : Thread id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
posts = <base_path.Path object>

/forum/{threadId}/posts: Get specific forum thread posts Requires public access key.
Returns 20 posts per page for a specific thread.

Parameters

  • offset : N/A
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • threadId : Thread id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Key(base_query.BaseQuery):

A collection of paths representing Key.

info = <base_path.Path object>

/key/info: Get current key info Available for any key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
log = <base_path.Path object>

/key/log: Get current key log history Available for any key.

  • This selection contains up to last 250 request logs.

# Parameters

  • limit : N/A
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Market(base_query.BaseQuery):

A collection of paths representing Market.

bazaar = <base_path.Path object>

/market/bazaar: Get bazaar directory Requires public access key.
The default response is of type 'BazaarWeekly', but if a category is chosen, the response will be of type 'BazaarSpecialized'.

Parameters

  • cat : Category of specialized bazaars returned
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
lookup = <base_path.Path object>

/market/lookup: Get all available market selections Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/market/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class MarketId(base_query.BaseQuery):

A collection of paths representing MarketId.

itemmarket = <base_path.Path object>

/market/{id}/itemmarket: Get item market listings Requires public access key.

Parameters

  • id : Item id
  • bonus : Used to filter weapons with a specific bonus.
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
bazaar = <base_path.Path object>

/market/{id}/bazaar: Get item specialized bazaar directory Requires public access key.

Parameters

  • id : Item id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class MarketPropertyTypeId(base_query.BaseQuery):

A collection of paths representing MarketPropertyTypeId.

properties = <base_path.Path object>

/market/{propertyTypeId}/properties: Get properties market listings Requires public access key.

Parameters

  • propertyTypeId : Property type id
  • offset : N/A
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
rentals = <base_path.Path object>

/market/{propertyTypeId}/rentals: Get properties rental listings Requires public access key.

Parameters

  • propertyTypeId : Property type id
  • offset : N/A
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Property(base_query.BaseQuery):

A collection of paths representing Property.

lookup = <base_path.Path object>

/property/lookup: Get all available property selections Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/property/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class PropertyId(base_query.BaseQuery):

A collection of paths representing PropertyId.

property = <base_path.Path object>

/property/{id}/property: Get a specific property Requires public access key.

Parameters

  • id : Property id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Racing(base_query.BaseQuery):

A collection of paths representing Racing.

tracks = <base_path.Path object>

/racing/tracks: Get race tracks and descriptions Requires public access key.
Returns the details about racing tracks.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/racing/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
carupgrades = <base_path.Path object>

/racing/carupgrades: Get all possible car upgrades Requires public access key.
Returns the details about all possible car upgrades.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
lookup = <base_path.Path object>

/racing/lookup: Get all available racing selections Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
cars = <base_path.Path object>

/racing/cars: Get cars and their racing stats Requires public access key.
Returns the stat details about racing cars.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
races = <base_path.Path object>

/racing/races: Get races Requires public access key.
Returns a list of races, ordered by race start timestamp.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • cat : Category of races returned
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class RacingRaceId(base_query.BaseQuery):

A collection of paths representing RacingRaceId.

race = <base_path.Path object>

/racing/{raceId}/race: Get specific race details Requires public access key.
Returns the details of a race.

Parameters

  • raceId : Race id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class RacingTrackId(base_query.BaseQuery):

A collection of paths representing RacingTrackId.

records = <base_path.Path object>

/racing/{trackId}/records: Get track records Requires public access key.
Returns a list of 5 best lap records for the chosen track and car class.

Parameters

  • trackId : Track id
  • cat : Car class
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class Torn(base_query.BaseQuery):

A collection of paths representing Torn.

logtypes = <base_path.Path object>

/torn/logtypes: Get all available log ids Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
attacklog = <base_path.Path object>

/torn/attacklog: Get attack log details Requires public key.

Parameters

  • log : Code of the attack log. E.g. d51ad4fe6be884b309b142e2d1d4f807
  • offset : N/A
  • sort : Sorted by the greatest timestamps
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
bounties = <base_path.Path object>

/torn/bounties: Get bounties Requires public key.

Parameters

  • limit : N/A
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
properties = <base_path.Path object>

/torn/properties: Get properties details Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
education = <base_path.Path object>

/torn/education: Get education information Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
itemmods = <base_path.Path object>

/torn/itemmods: Get information about weapon upgrades Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/torn/timestamp: Get current server time Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
territory = <base_path.Path object>

/torn/territory: Get territory details Requires public access key.

Parameters

  • ids : Specific territory id or a list of territory ids (comma separated)
  • offset : N/A
  • limit : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
factiontree = <base_path.Path object>

/torn/factiontree: Get full faction tree Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
lookup = <base_path.Path object>

/torn/lookup: Get all available torn selections Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
itemammo = <base_path.Path object>

/torn/itemammo: Get information about ammo Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
factionhof = <base_path.Path object>

/torn/factionhof: Get faction hall of fame positions for a specific category Requires public access key.

Parameters

  • limit : N/A
  • offset : N/A
  • cat : Leaderboards category
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
items = <base_path.Path object>

/torn/items: Get information about items Requires public key.
Default category is 'All'.
Details are not populated when requesting the category 'All'.

Parameters

  • cat : Item category type
  • sort : Sort rows from newest to oldest Default ordering is ascending
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
crimes = <base_path.Path object>

/torn/crimes: Get crimes information Requires public access key.
Return the details about released crimes.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
calendar = <base_path.Path object>

/torn/calendar: Get calendar information Requires public access key.
Get the details about competitions & events in the running year.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
hof = <base_path.Path object>

/torn/hof: Get player hall of fame positions for a specific category Requires public key.

Parameters

  • limit : N/A
  • offset : N/A
  • cat : Leaderboards category
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
organizedcrimes = <base_path.Path object>

/torn/organizedcrimes: Get organized crimes information Requires public access key.
Return the details about released faction organized crimes.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
logcategories = <base_path.Path object>

/torn/logcategories: Get available log categories Requires public key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class TornCrimeId(base_query.BaseQuery):

A collection of paths representing TornCrimeId.

subcrimes = <base_path.Path object>

/torn/{crimeId}/subcrimes: Get Subcrimes information Requires public access key.
Return the details about possible actions for a specific crime.

Parameters

  • crimeId : Crime id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class TornIds(base_query.BaseQuery):

A collection of paths representing TornIds.

items = <base_path.Path object>

/torn/{ids}/items: Get information about items Requires public key.
Details are always populated when available.

Parameters

  • ids : Item id or a list of item ids (comma separated)
  • sort : Sort rows from newest to oldest Default ordering is ascending
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class TornLogCategoryId(base_query.BaseQuery):

A collection of paths representing TornLogCategoryId.

logtypes = <base_path.Path object>

/torn/{logCategoryId}/logtypes: Get available log ids for a specific log category Requires public key.

Parameters

  • logCategoryId : Log category id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
class User(base_query.BaseQuery):

A collection of paths representing User.

education = <base_path.Path object>

/user/education: Get your education information The response contains a list of complete eduactions and of a current education (if any).

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
forumfriends = <base_path.Path object>

/user/forumfriends: Get updates on your friends' activity Requires minimal access key.
This selection returns data visible in 'Friends' section on forum page. Feed is sorted by timestamp descending. Only a maximum of 100 rows are returned.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
attacks = <base_path.Path object>

/user/attacks: Get your detailed attacks Requires limited access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
bounties = <base_path.Path object>

/user/bounties: Get bounties placed on you Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
lookup = <base_path.Path object>

/user/lookup: Get all available user selections Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
racingrecords = <base_path.Path object>

/user/racingrecords: Get your current racing records Requires minimal access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
forumposts = <base_path.Path object>

/user/forumposts: Get your posts Requires public access key.
Returns 20 posts per page.

Parameters

  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
list = <base_path.Path object>

/user/list: Get your friends, enemies or targets list Requires limited access key.

Parameters

  • cat : Select list type
  • limit : N/A
  • offset : N/A
  • sort : Sort rows from newest to oldest Default ordering is ascending
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
factionbalance = <base_path.Path object>

/user/factionbalance: Get your current faction balance Requires limited access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
personalstats = <base_path.Path object>

/user/personalstats: Get your personal stats Requires public access key.

  • UserPersonalStatsFull is returned only when this selection is requested with Limited, Full or Custom key access key.
  • UserPersonalStatsFullPublic is returned when the requested category is 'all'.
  • UserPersonalStatsPopular is returned when the requested category is 'popular'. Please try to use UserPersonalStatsPopular over UserPersonalStatsFullPublic wherever possible in order to reduce the server load.
  • Otherwise, UserPersonalStatsCategory is returned for the matched category.
  • It's possible to request specific stats via 'stat' parameter. In this case the response will vary depending on the stats requested. Private stats are still available only to the key owner (with Limited or higher key).
  • Additionally, historical stats can also be fetched via 'stat' query parameter, but 'timestamp' parameter must be provided as well. It's only possible to pass up to 10 historical stats at once (the rest is trimmed). When requesting historical stats the response will be of type UserPersonalStatsHistoric.

# Parameters

  • cat : Stats category. Required unless requesting specific stats via 'stat' query parameter
  • stat : Stat names (10 maximum). Used to fetch historical stat values
  • timestamp : Returns stats until this timestamp (converted to nearest date).
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
properties = <base_path.Path object>

/user/properties: Get your own properties Requires public access key.
Extended responses are available when requesting the data with Limited or higher access keys.

Parameters

  • offset : N/A
  • limit : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
property = <base_path.Path object>

/user/property: Get your current property Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
forumsubscribedthreads = <base_path.Path object>

/user/forumsubscribedthreads: Get updates on threads you subscribed to Requires minimal access key.
This selection returns data visible in 'Subscribed Threads' section on forum page. Threads are sorted in the same way as on site.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
reports = <base_path.Path object>

/user/reports: Get your reports Requires limited access key.

  • The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.

# Parameters

  • cat : Used to filter reports with a specific type.
  • target : Get reports for a specific player by passing their player ID.
  • limit : N/A
  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
races = <base_path.Path object>

/user/races: Get user races Requires minimal access key.
Returns a list of user races, ordered by race start timestamp.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • cat : Category of races returned
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
calendar = <base_path.Path object>

/user/calendar: Get your competition's event start time Requires minimal access key.
Only available to yourself.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
forumfeed = <base_path.Path object>

/user/forumfeed: Get updates on your threads and posts Requires minimal access key.
This selection returns data visible in 'Feed' section on forum page. Feed is sorted by timestamp descending. Only a maximum of 100 rows are returned.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
hof = <base_path.Path object>

/user/hof: Get your hall of fame rankings Requires public access key.
When requesting selection with Limited, Full or Custom key, battle_stats selection will be populated.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
jobranks = <base_path.Path object>

/user/jobranks: Get your starter job positions Requires minimal access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
forumthreads = <base_path.Path object>

/user/forumthreads: Get your threads Requires public access key.
Returns 100 threads per page. The field 'new_posts' is also available, indicating the amount of unread posts with a Minimum API key (or higher).

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
enlistedcars = <base_path.Path object>

/user/enlistedcars: Get user enlisted cars Requires minimal access key.
Returns a list of all user enlisted cars.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
attacksfull = <base_path.Path object>

/user/attacksfull: Get your simplified attacks Requires limited access key.
Returns up to 1,000 rows.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
timestamp = <base_path.Path object>

/user/timestamp: Get current server time Requires public access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
itemmarket = <base_path.Path object>

/user/itemmarket: Get your item market listings for a specific item Requires limited access key.

Parameters

  • offset : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
organizedcrime = <base_path.Path object>

/user/organizedcrime: Get your current ongoing organized crime Requires minimal access key.

Parameters

  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
revives = <base_path.Path object>

/user/revives: Get your detailed revives Requires limited access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
revivesFull = <base_path.Path object>

/user/revivesFull: Get your simplified revives Requires limited access key.

Parameters

  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
class UserCrimeId(base_query.BaseQuery):

A collection of paths representing UserCrimeId.

crimes = <base_path.Path object>

/user/{crimeId}/crimes: Get your crime statistics Requires minimal access key.
Return the details and statistics about for a specific crime.

Parameters

  • crimeId : Crime id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Minimal). It's not required to use this parameter when passing the API key via the Authorization header.
class UserId(base_query.BaseQuery):

A collection of paths representing UserId.

personalstats = <base_path.Path object>

/user/{id}/personalstats: Get a player's personal stats Requires public access key.

  • UserPersonalStatsFull is returned only when this selection is requested for the key owner with Limited, Full or Custom key.
  • UserPersonalStatsFullPublic is returned when the requested category is 'all'.
  • UserPersonalStatsPopular is returned when the requested category is 'popular'. Please try to use UserPersonalStatsPopular over UserPersonalStatsFullPublic wherever possible in order to reduce the server load.
  • Otherwise, UserPersonalStatsCategory is returned for the matched category.
  • It's possible to request specific stats via 'stat' parameter. In this case the response will vary depending on the stats requested. Private stats are still available only to the key owner (with Limited or higher key).
  • Additionally, historical stats can also be fetched via 'stat' query parameter, but 'timestamp' parameter must be provided as well. It's only possible to pass up to 10 historical stats at once (the rest is trimmed). When requesting historical stats the response will be of type UserPersonalStatsHistoric.

# Parameters

  • id : User id
  • cat :
  • stat : Stat names (10 maximum). Used to fetch historical stat values
  • timestamp : Returns stats until this timestamp (converted to nearest date).
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
forumposts = <base_path.Path object>

/user/{id}/forumposts: Get posts for a specific player Requires public access key.
Returns 20 posts per page for a specific player.

Parameters

  • striptags : Determines if fields include HTML or not ('Hospitalized by <a href=...>user</a>' vs 'Hospitalized by user').
  • id : User id
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
bounties = <base_path.Path object>

/user/{id}/bounties: Get bounties placed on a specific user Requires public access key.

Parameters

  • id : User id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
properties = <base_path.Path object>

/user/{id}/properties: Get specific user's properties Requires public access key.
Extended responses are available when requesting the data with Limited or higher access keys for yourself or your spouse.

Parameters

  • id : User id
  • offset : N/A
  • limit : N/A
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
hof = <base_path.Path object>

/user/{id}/hof: Get hall of fame rankings for a specific player Requires public access key.
The battle_stats selection will be populated only when requesting selection with Limited, Full or Custom key and for yourself.

Parameters

  • id : User id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
property = <base_path.Path object>

/user/{id}/property: Get specific user's property Requires public access key.

Parameters

  • id : User id
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.
forumthreads = <base_path.Path object>

/user/{id}/forumthreads: Get threads for a specific player Requires public access key.
Returns 100 threads per page for a specific player. When requesting data for the key owner, a field 'new_posts' is also available, indicating the amount of unread posts. Minimum API key is required for that.

Parameters

  • id : User id
  • limit : N/A
  • sort : Sorted by the greatest timestamps
  • from_ : Timestamp that sets the lower limit for the data returned. Data returned will be after this time
  • to : Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
  • timestamp : Timestamp to bypass cache
  • comment : Comment for your tool/service/bot/website to be visible in the logs.
  • key : API key (Public). It's not required to use this parameter when passing the API key via the Authorization header.