EveESI.Api.Wallet (EveESI v1.0.0)

View Source

API calls for all endpoints tagged Wallet.

Summary

Functions

Get a character's wallet balance Returns a character's wallet balance --- Alternate route: /legacy/characters/{character_id}/wallet/ Alternate route: /v1/characters/{character_id}/wallet/ --- This route is cached for up to 120 seconds --- Diff of the upcoming changes

Get character wallet journal Retrieve the given character's wallet journal going 30 days back --- Alternate route: /dev/characters/{character_id}/wallet/journal/ Alternate route: /v6/characters/{character_id}/wallet/journal/ --- This route is cached for up to 3600 seconds

Get wallet transactions Get wallet transactions of a character --- Alternate route: /dev/characters/{character_id}/wallet/transactions/ Alternate route: /legacy/characters/{character_id}/wallet/transactions/ Alternate route: /v1/characters/{character_id}/wallet/transactions/ --- This route is cached for up to 3600 seconds

Returns a corporation's wallet balance Get a corporation's wallets --- Alternate route: /dev/corporations/{corporation_id}/wallets/ Alternate route: /legacy/corporations/{corporation_id}/wallets/ Alternate route: /v1/corporations/{corporation_id}/wallets/ --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Get corporation wallet journal Retrieve the given corporation's wallet journal for the given division going 30 days back --- Alternate route: /dev/corporations/{corporation_id}/wallets/{division}/journal/ Alternate route: /v4/corporations/{corporation_id}/wallets/{division}/journal/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Get corporation wallet transactions Get wallet transactions of a corporation --- Alternate route: /dev/corporations/{corporation_id}/wallets/{division}/transactions/ Alternate route: /legacy/corporations/{corporation_id}/wallets/{division}/transactions/ Alternate route: /v1/corporations/{corporation_id}/wallets/{division}/transactions/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Functions

get_characters_character_id_wallet(connection, character_id, opts \\ [])

@spec get_characters_character_id_wallet(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, float()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Get a character's wallet balance Returns a character's wallet balance --- Alternate route: /legacy/characters/{character_id}/wallet/ Alternate route: /v1/characters/{character_id}/wallet/ --- This route is cached for up to 120 seconds --- Diff of the upcoming changes

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character ID
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, float()} on success
  • {:error, Tesla.Env.t} on failure

get_characters_character_id_wallet_journal(connection, character_id, opts \\ [])

Get character wallet journal Retrieve the given character's wallet journal going 30 days back --- Alternate route: /dev/characters/{character_id}/wallet/journal/ Alternate route: /v6/characters/{character_id}/wallet/journal/ --- This route is cached for up to 3600 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character ID
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :page (integer()): Which page of results to return
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, [%GetCharactersCharacterIdWalletJournal200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_characters_character_id_wallet_transactions(connection, character_id, opts \\ [])

Get wallet transactions Get wallet transactions of a character --- Alternate route: /dev/characters/{character_id}/wallet/transactions/ Alternate route: /legacy/characters/{character_id}/wallet/transactions/ Alternate route: /v1/characters/{character_id}/wallet/transactions/ --- This route is cached for up to 3600 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character ID
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :from_id (integer()): Only show transactions happened before the one referenced by this id
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, [%GetCharactersCharacterIdWalletTransactions200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_corporations_corporation_id_wallets(connection, corporation_id, opts \\ [])

Returns a corporation's wallet balance Get a corporation's wallets --- Alternate route: /dev/corporations/{corporation_id}/wallets/ Alternate route: /legacy/corporations/{corporation_id}/wallets/ Alternate route: /v1/corporations/{corporation_id}/wallets/ --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters

  • connection (EveESI.Connection): Connection to server
  • corporation_id (integer()): An EVE corporation ID
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, [%GetCorporationsCorporationIdWallets200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_corporations_corporation_id_wallets_division_journal(connection, corporation_id, division, opts \\ [])

Get corporation wallet journal Retrieve the given corporation's wallet journal for the given division going 30 days back --- Alternate route: /dev/corporations/{corporation_id}/wallets/{division}/journal/ Alternate route: /v4/corporations/{corporation_id}/wallets/{division}/journal/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters

  • connection (EveESI.Connection): Connection to server
  • corporation_id (integer()): An EVE corporation ID
  • division (integer()): Wallet key of the division to fetch journals from
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :page (integer()): Which page of results to return
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, [%GetCorporationsCorporationIdWalletsDivisionJournal200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_corporations_corporation_id_wallets_division_transactions(connection, corporation_id, division, opts \\ [])

@spec get_corporations_corporation_id_wallets_division_transactions(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   [
     EveESI.Model.GetCorporationsCorporationIdWalletsDivisionTransactions200Ok.t()
   ]}
  | {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Get corporation wallet transactions Get wallet transactions of a corporation --- Alternate route: /dev/corporations/{corporation_id}/wallets/{division}/transactions/ Alternate route: /legacy/corporations/{corporation_id}/wallets/{division}/transactions/ Alternate route: /v1/corporations/{corporation_id}/wallets/{division}/transactions/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters

  • connection (EveESI.Connection): Connection to server
  • corporation_id (integer()): An EVE corporation ID
  • division (integer()): Wallet key of the division to fetch journals from
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :from_id (integer()): Only show journal entries happened before the transaction referenced by this id
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, [%GetCorporationsCorporationIdWalletsDivisionTransactions200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure