/ 
WG-API-v0.13
River stage zero No dependents
/ WG::API::WoT

NAME

WG::API::WoT - Module to work with Wargaming.net Public API for World of Tanks

VERSION

Version v0.13

SYNOPSIS

Wargaming.net Public API is a set of API methods that provide access to Wargaming.net content, including in-game and game-related content, as well as player statistics.

This module provide access to WG Public API

use WG::API;

my $wot = WG::API->new( application_id => 'demo' )->wot();
...
my $player = $wot->account_info( account_id => '1' );

CONSTRUCTOR

new

Create new object with params. Rerquired application id: https://developers.wargaming.net/documentation/guide/getting-started/

Params:

- application_id *
- languare
- api_uri

METHODS

Account

account_list( [ %params ] )

Method returns partial list of players. The list is filtered by initial characters of user name and sorted alphabetically

required fields:
search - Player name search string. Parameter "type" defines minimum length and type of search. Using the exact search type, you can enter several names, separated with commas. Maximum length: 24.
account_info( [ %params ] )

Method returns player details.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
account_tanks( [ %params ] )

Method returns details on player's vehicles.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
account_achievements( [ %params ] )

Method returns players' achievement details.

Achievement properties define the achievements field values:

1-4 for Mastery Badges and Stage Achievements (type: "class");
maximum value of Achievement series (type: "series");
number of achievements earned from sections: Battle Hero, Epic Achievements, Group Achievements, Special Achievements, etc. (type: "repeatable, single, custom").
required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
stronghold_claninfo( [ %params ] )

Method returns general information and the battle statistics of clans in the Stronghold mode. Please note that information about the number of battles fought as well as the number of defeats and victories is updated once every 24 hours.

required_fields:
clan_id - Clan IDs. Maximum limit: 100
stronghold_clanreserves( [ %params ] )

Method returns information about available Reserves and their current status.

required_fields:
access_token - Access token for the private data of a user's account; can be received via the authorization method; valid within a stated time period

Encyclopedia

encyclopedia_vehicles( [ %params ] )

Method returns list of available vehicles.

encyclopedia_vehicleprofile( [ %params ] )
required fields
tank_id - vehicle id
encyclopedia_achievements( [ %params ] )

Method returns information about achievements.

encyclopedia_info( [ %params ] )

Method returns information about Tankopedia.

encyclopedia_arenas( [ %params ] )

Method returns information about maps.

encyclopedia_provisions( [ %params ] )

Method returns a list of available equipment and consumables.

encyclopedia_personalmissions( [ %params ] )

Method returns details on Personal Missions on the basis of specified campaign IDs, operation IDs, mission branch and tag IDs.

encyclopedia_boosters( [ %params ] )

Method returns information about Personal Reserves.

encyclopedia_vehicleprofiles( [ %params ] )

Method returns vehicle configuration characteristics.

required fields
tank_id - vehicle id.
encyclopedia_modules( [ %params ] )

Method returns list of available modules that can be installed on vehicles, such as engines, turrets, etc. At least one input filter parameter (module ID, type) is required to be indicated.

encyclopedia_badges( [ %params ] )

Method returns list of available badges a player can gain in Ranked Battles.

encyclopedia_crewroles( [ %params ] )

Method returns full description of all crew qualifications.

encyclopedia_crewskills( [ %params ] )

Method returns full description of all crew skills.

Clan ratings

clanratings_types()

Method returns details on ratings types and categories.

calnratings_dates( [ %params ] )

Method returns dates with available rating data.

clanratings_clans

Method returns clan ratings by specified IDs.

required_fields:
clan_id - Clan IDs. Maximum limit: 100
clanratings_neighbors( [ %params ] )

Method returns list of adjacent positions in specified clan rating

required_fields:
clan_id - Clan IDs. Maximum limit: 100
rank_field - Rating category
clanratings_top( [ %params ] )

Method returns the list of top clans by specified parameters

required_fields:
rank_field - Rating category

Player's vehicles

tanks_stats( [ %params ] )

Method returns overall statistics, Tank Company statistics, and clan statistics per each vehicle for each user.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
tanks_achievements( [ %params ] )

Method returns list of achievements on all vehicles.

Achievement properties define the achievements field values:

1-4 for Mastery Badges and Stage Achievements (type: "class");
maximum value of Achievement series (type: "series");
number of achievements earned from sections: Battle Hero, Epic Achievements, Group Achievements, Special Achievements, etc. (type: "repeatable, single, custom").
required fields:
account_id - Account ID. Max limit is 100. Min value is 1.

BUGS

Please report any bugs or feature requests to cynovg at cpan.org, or through the web interface at https://gitlab.com/cynovg/WG-API/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WG::API

You can also look for information at:

ACKNOWLEDGEMENTS

...

SEE ALSO

WG API Reference https://developers.wargaming.net/

AUTHOR

Cyrill Novgorodcev , <cynovg at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Cyrill Novgorodcev.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.