esi

v0.1.1

esi v0.1.1 ESI.API.Alliance

Summary

Types

contacts_opt()
contacts_opts()

Options for Alliance.contacts/2

names_opt()
names_opts()

Options for Alliance.names/1

Functions

alliance(alliance_id)

Public information about an alliance

alliances()

List all active player alliances

contacts(alliance_id, opts \\ [])

Return contacts of an alliance

corporations(alliance_id)

List all current member corporations of an alliance

icons(alliance_id)

Get the icon urls for a alliance

names(opts \\ [])

Resolve a set of alliance IDs to alliance names

Types

contacts_opt() 
contacts_opt ::
  {:page, nil | integer} |
  {:token, nil | String.t}
contacts_opts() 
contacts_opts() :: [contacts_opt]

Options for Alliance.contacts/2.

  • :page (DEFAULT: 1) — Which page of results to return
  • :token — Access token to use if unable to set a header
names_opt() 
names_opt() :: {:alliance_ids, [integer]}
names_opts() 
names_opts() :: [names_opt]

Options for Alliance.names/1.

  • :alliance_ids (REQUIRED) — A comma separated list of alliance IDs

Functions

alliance(alliance_id) 
alliance(alliance_id :: integer) :: ESI.Request.t

Public information about an alliance.

Response Example

Public data about an alliance:

%{"alliance_name" => "C C P Alliance", "date_founded" => "2016-06-26T21:00:00Z",
  "executor_corp" => 98356193, "ticker" => "<C C P>"}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances_alliance_id
  • path — /alliances/{alliance_id}/

View on ESI Site

alliances() 
alliances() :: ESI.Request.t

List all active player alliances.

Response Example

List of Alliance IDs:

[99000001, 99000002]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances
  • path — /alliances/

View on ESI Site

contacts(alliance_id, opts \\ []) 
contacts(alliance_id :: integer, opts :: contacts_opts) :: ESI.Request.t

Return contacts of an alliance.

Response Example

A list of contacts:

[%{"contact_id" => 2112625428, "contact_type" => "character",
   "standing" => 10.0}]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances_alliance_id_contacts
  • path — /alliances/{alliance_id}/contacts/

View on ESI Site

corporations(alliance_id) 
corporations(alliance_id :: integer) :: ESI.Request.t

List all current member corporations of an alliance.

Response Example

List of corporation IDs:

[98000001]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances_alliance_id_corporations
  • path — /alliances/{alliance_id}/corporations/

View on ESI Site

icons(alliance_id) 
icons(alliance_id :: integer) :: ESI.Request.t

Get the icon urls for a alliance.

Response Example

Icon URLs for the given alliance id and server:

%{"px128x128" => "https://imageserver.eveonline.com/Alliance/503818424_128.png",
  "px64x64" => "https://imageserver.eveonline.com/Alliance/503818424_64.png"}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances_alliance_id_icons
  • path — /alliances/{alliance_id}/icons/

View on ESI Site

names(opts \\ []) 
names(opts :: names_opts) :: ESI.Request.t

Resolve a set of alliance IDs to alliance names.

Response Example

List of id/name associations:

[%{"alliance_id" => 1000171, "alliance_name" => "Republic University"}]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_alliances_names
  • path — /alliances/names/

View on ESI Site