Wargaming v0.1.0 Wargaming.Warships.Account View Source

Account provides functions for interacting with the WarGaming.net World of Warships Account API.

Link to this section Summary

Functions

Account.achievements/2 returns information about a players in-game achievements

Account.search/2 searches WarGaming accounts (in the configured region) based on a list of account_ids and returns detailed information

Account.search/2 searches WarGaming accounts (in the configured region) and returns a list of matching nicknames with account IDs

Account.stats_for_dates/3 returns the stats for the given accounts in the given date or date range

See stats_for_dates. Returns default API value of yesterday

Link to this section Functions

Link to this function achievements(account_ids, opts \\ %{}) View Source

Account.achievements/2 returns information about a players in-game achievements.

Official References

Returns {:ok, response_map} or {:error, error_map}

Available Options

  • access_token : Token for accessing private data on account.
  • fields : Comma separated list of fields. Embedded fields separated by periods. To exclude a field, prefix it with a -. Returns all fields if one of the fields is undefined.
  • language : Default “en”. Available options:

    • “cs” — Čeština
    • “de” — Deutsch
    • “en” — English (by default)
    • “es” — Español
    • “fr” — Français
    • “ja” — 日本語
    • “pl” — Polski
    • “ru” — Русский
    • “th” — ไทย
    • “zh-tw” — 繁體中文
Link to this function by_id(account_ids, opts \\ %{}) View Source

Account.search/2 searches WarGaming accounts (in the configured region) based on a list of account_ids and returns detailed information.

Official Reference

Returns {:ok, response_map} or {:error, error_map}

Available Options

  • access_token : Token for accessing private data on account.
  • extra : Additional fields to return. See Official Reference for more information.
  • fields : Comma separated list of fields. Embedded fields separated by periods. To exclude a field, prefix it with a -. Returns all fields if one of the fields is undefined.
  • language : Default “en”. Available options:

    • “cs” — Čeština
    • “de” — Deutsch
    • “en” — English (by default)
    • “es” — Español
    • “fr” — Français
    • “ja” — 日本語
    • “pl” — Polski
    • “ru” — Русский
    • “th” — ไทย
    • “zh-tw” — 繁體中文
Link to this function search(names, opts \\ %{}) View Source

Account.search/2 searches WarGaming accounts (in the configured region) and returns a list of matching nicknames with account IDs.

Official Reference

Returns {:ok, response_map} or {:error, error_map}

Available Options

  • fields : Comma separated list of fields. Embedded fields separated by periods. To exclude a field, prefix it with a -. Returns all fields if one of the fields is undefined.
  • language : Default “en”. Available options:

    • “cs” — Čeština
    • “de” — Deutsch
    • “en” — English (by default)
    • “es” — Español
    • “fr” — Français
    • “ja” — 日本語
    • “pl” — Polski
    • “ru” — Русский
    • “th” — ไทย
    • “zh-tw” — 繁體中文
  • limit : Number of entries to return. No more than 100, but fewer can be returned.
  • type : Search type. Default is “startswith”. Available options:

    • “startswith” — Search by initial characters of name. Min-length: 3. Max-length: 24
    • “exact” - Search by exact (case-insensitive)
Link to this function stats_for_dates(account_ids, dates, opts \\ %{}) View Source

Account.stats_for_dates/3 returns the stats for the given accounts in the given date or date range.

Official Reference

Returns {:ok, response_map} or {:error, error_map}

Available Options

  • access_token : Token for accessing private data on account.
  • dates : List of dates to return statistics for. Max date range of 28 days from the current date. Defaults to yesterday. Maximum number of days is 10.
  • extra : Additional fields to return. See Official Reference for more information.
  • fields : Comma separated list of fields. Embedded fields separated by periods. To exclude a field, prefix it with a -. Returns all fields if one of the fields is undefined.
  • language : Default “en”. Available options:

    • “cs” — Čeština
    • “de” — Deutsch
    • “en” — English (by default)
    • “es” — Español
    • “fr” — Français
    • “ja” — 日本語
    • “pl” — Polski
    • “ru” — Русский
    • “th” — ไทย
    • “zh-tw” — 繁體中文
Link to this function stats_for_yesterday(account_ids, opts \\ %{}) View Source

See stats_for_dates. Returns default API value of yesterday.