NAME

WG::API::WoWp - Module to work with Wargaming.net Public API for World of Warplanes

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 $wowp = WG::API->new( application_id => 'demo' )->wowp();
...
my $player = $wowp->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

Accounts

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_planes( [ %params ] )

Method returns details on player's aircrafts.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.

Encyclopedia

encyclopedia_planes( [ %params ] )

Method returns list of all aircrafts from Encyclopedia

encyclopedia_planeinfo( [ %params ] )

Method returns aircraft details from Encyclopedia.

required fields
plane_id - aircraft id
encyclopedia_planemodules( [ %params ] )

Method returns information from Encyclopedia about modules available for specified aircrafts.

required fields
plane_id - aircraft id
encyclopedia_planeupgrades( [ %params ] )

Method returns information from Encyclopedia about slots of aircrafts and lists of modules which are compatible with specified slots.

required fields
plane_id - aircraft id
encyclopedia_planespecification( [ %params ] )
required fields
plane_id - aircraft id
encyclopedia_achievements( [ %params ] )

Method returns dictionary of achievements from Encyclopedia.

encyclopedia_info( [ %params ] )

Method returns information about Encyclopedia.

Ratings

ratings_types( [ %params ] )

Method returns dictionary of rating periods and ratings details.

ratings_accounts( [ %params ] )

Method returns player ratings by specified IDs.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
type - Rating period. For valid values, check the Types of ratings method.
ratings_neighbors( [ %params ] )

Method returns list of adjacent positions in specified rating.

required fields:
account_id - Account ID. Max limit is 100. Min value is 1.
type - Rating period. For valid values, check the Types of ratings method.
rank_field - Rating category.
ratings_top( [ %params ] )

Method returns the list of top players by specified parameter.

required fields:
type - Rating period. For valid values, check the Types of ratings method.
rank_field - Rating category.
ratings_dates( [ %params ] )

Method returns dates with available rating data.

required fields:
type - Rating period. For valid values, check the Types of ratings method.

Aircraft

planes_stats( [ %params ] )

Method returns statistics on player's aircraft.

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

Method returns achievements on player's aircraft.

requires_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.