Skip to content

WalletApi.md

Latest commit

 

History

History
382 lines (274 loc) · 16.2 KB

WalletApi.md

File metadata and controls

382 lines (274 loc) · 16.2 KB

EveSwaggerInterface.WalletApi

All URIs are relative to https://esi.evetech.net/latest

Method HTTP request Description
getCharactersCharacterIdWallet GET /characters/{character_id}/wallet/ Get a character's wallet balance
getCharactersCharacterIdWalletJournal GET /characters/{character_id}/wallet/journal/ Get character wallet journal
getCharactersCharacterIdWalletTransactions GET /characters/{character_id}/wallet/transactions/ Get wallet transactions
getCorporationsCorporationIdWallets GET /corporations/{corporation_id}/wallets/ Returns a corporation's wallet balance
getCorporationsCorporationIdWalletsDivisionJournal GET /corporations/{corporation_id}/wallets/{division}/journal/ Get corporation wallet journal
getCorporationsCorporationIdWalletsDivisionTransactions GET /corporations/{corporation_id}/wallets/{division}/transactions/ Get corporation wallet transactions

getCharactersCharacterIdWallet

'Number' getCharactersCharacterIdWallet(characterId, opts)

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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdWallet(characterId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

'Number'

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCharactersCharacterIdWalletJournal

[GetCharactersCharacterIdWalletJournal200Ok] getCharactersCharacterIdWalletJournal(characterId, 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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdWalletJournal(characterId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page Number Which page of results to return [optional] [default to 1]
token String Access token to use if unable to set a header [optional]

Return type

[GetCharactersCharacterIdWalletJournal200Ok]

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCharactersCharacterIdWalletTransactions

[GetCharactersCharacterIdWalletTransactions200Ok] getCharactersCharacterIdWalletTransactions(characterId, 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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'fromId': 789, // Number | Only show transactions happened before the one referenced by this id
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdWalletTransactions(characterId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility]
fromId Number Only show transactions happened before the one referenced by this id [optional]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

[GetCharactersCharacterIdWalletTransactions200Ok]

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCorporationsCorporationIdWallets

[GetCorporationsCorporationIdWallets200Ok] getCorporationsCorporationIdWallets(corporationId, 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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdWallets(corporationId, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

[GetCorporationsCorporationIdWallets200Ok]

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCorporationsCorporationIdWalletsDivisionJournal

[GetCorporationsCorporationIdWalletsDivisionJournal200Ok] getCorporationsCorporationIdWalletsDivisionJournal(corporationIddivision, 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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var corporationId = 56; // Number | An EVE corporation ID

var division = 56; // Number | Wallet key of the division to fetch journals from

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdWalletsDivisionJournal(corporationIddivision, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
division Number Wallet key of the division to fetch journals from
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page Number Which page of results to return [optional] [default to 1]
token String Access token to use if unable to set a header [optional]

Return type

[GetCorporationsCorporationIdWalletsDivisionJournal200Ok]

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCorporationsCorporationIdWalletsDivisionTransactions

[GetCorporationsCorporationIdWalletsDivisionTransactions200Ok] getCorporationsCorporationIdWalletsDivisionTransactions(corporationIddivision, opts)

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

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.WalletApi();

var corporationId = 56; // Number | An EVE corporation ID

var division = 56; // Number | Wallet key of the division to fetch journals from

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'fromId': 789, // Number | Only show journal entries happened before the transaction referenced by this id
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdWalletsDivisionTransactions(corporationIddivision, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
division Number Wallet key of the division to fetch journals from
datasource String The server name you would like data from [optional] [default to tranquility]
fromId Number Only show journal entries happened before the transaction referenced by this id [optional]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

[GetCorporationsCorporationIdWalletsDivisionTransactions200Ok]

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json