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

NAME

WG::API::WoWs - Module for work with Wargaming.net Public API for Worlf of Warships

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 $wows = WG::API->new( application_id => 'demo' )->wows();
...
my $player = $wows->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. Players may hide their game profiles, use field hidden_profile for determination.

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

Method returns information about players' achievements. Accounts with hidden game profiles are excluded from response. Hidden profiles are listed in the field meta.hidden.

account_statsbydate( [ %params ] )

Method returns statistics slices by dates in specified time span.

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

Encyclopedia

encyclopedia_info( [ %params ] )

Method returns information about encyclopedia.

encyclopedia_ships( [ %params ] )

Method returns list of ships available.

encyclopedia_achievements( [ %params ] )

Method returns information about achievements.

encyclopedia_shipprofile( [ %params ] )

Method returns parameters of ships in all existing configurations.

required fields
ship_id - ship id
encyclopedia_modules( [ %params ] )

Method returns list of available modules that can be mounted on a ship (hull, engines, etc.).

encyclopedia_accountlevels( [ %params ] )

Method returns information about Service Record levels.

encyclopedia_crews( [ %params ] )

Method returns information about Commanders.

encyclopedia_crewskills( [ %params ] )

Method returns information about Commangers' skills.

encyclopedia_crewranks( [ %params ] )

Method returns information about Commanders' skills.

encyclopedia_battletypes( [ %params ] )

Method returns information about battle types.

encyclopedia_consumables( [ %params ] )

Method returns information about consumables: camouflages, flags, and upgrades.

encyclopedia_collections( [ %params ] )

Method returns information about collections.

encyclopedia_collectioncards( [ %params ] )

Method returns information about items that are included in the collection.

encyclopedia_battlearenas( [ %params ] )

Method returns the information about maps.

Warships

ships_stats( [ %params ] )

Method returns general statistics for each ship of a player. Accounts with hidden game profiles are excluded from response. Hidden profiles are listed in the field meta.hidden.

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

Seasons

seasons_info( [ %params ] )
seasons_shipstats( [ %params ] )

Method returns players' ships statistics in Ranked Battles seasons. Accounts with hidden game profiles are excluded from response. Hidden profiles are listed in the field meta.hidden.

required_fields:
account_id - Account ID. Max limit is 100. Min value is 1.
seasons_accountinfo( [ %params ] )

Method returns players' statistics in Ranked Battles seasons. Accounts with hidden game profiles are excluded from response. Hidden profiles are listed in the field meta.hidden.

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

Clans

clans( [ %params ] )

Method searches through clans and sorts them in a specified order

clans_details( [ %params ] )

Method returns detailed clan information

required_fields:
clan_id - Clan ID. Max limit is 100.
clans_accountinfo( [ $params ] )

Method returns player clan data. Player clan data exist only for accounts, that were participating in clan activities: sent join requests, were clan members etc.

required_fields:
account_id - Account ID. Max limit is 100. Min value is 1.
clans_glossary( [ %params ] )

Method returns information on clan entities.

clans_season( [ %params ] )

Method returns information about Clan Battles season.

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.