EveESI.Api.Industry (EveESI v1.0.0)

View Source

API calls for all endpoints tagged Industry.

Summary

Functions

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

List character industry jobs List industry jobs placed by a character --- Alternate route: /dev/characters/{character_id}/industry/jobs/ Alternate route: /legacy/characters/{character_id}/industry/jobs/ Alternate route: /v1/characters/{character_id}/industry/jobs/ --- This route is cached for up to 300 seconds

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

Character mining ledger Paginated record of all mining done by a character for the past 30 days --- Alternate route: /dev/characters/{character_id}/mining/ Alternate route: /legacy/characters/{character_id}/mining/ Alternate route: /v1/characters/{character_id}/mining/ --- This route is cached for up to 600 seconds

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

Moon extraction timers Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. --- Alternate route: /dev/corporation/{corporation_id}/mining/extractions/ Alternate route: /legacy/corporation/{corporation_id}/mining/extractions/ Alternate route: /v1/corporation/{corporation_id}/mining/extractions/ --- This route is cached for up to 1800 seconds --- Requires one of the following EVE corporation role(s): Station_Manager

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

Corporation mining observers Paginated list of all entities capable of observing and recording mining for a corporation --- Alternate route: /dev/corporation/{corporation_id}/mining/observers/ Alternate route: /legacy/corporation/{corporation_id}/mining/observers/ Alternate route: /v1/corporation/{corporation_id}/mining/observers/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant

get_corporation_corporation_id_mining_observers_observer_id(connection, corporation_id, observer_id, opts \\ [])

Observed corporation mining Paginated record of all mining seen by an observer --- Alternate route: /dev/corporation/{corporation_id}/mining/observers/{observer_id}/ Alternate route: /legacy/corporation/{corporation_id}/mining/observers/{observer_id}/ Alternate route: /v1/corporation/{corporation_id}/mining/observers/{observer_id}/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant

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

List corporation industry jobs List industry jobs run by a corporation --- Alternate route: /dev/corporations/{corporation_id}/industry/jobs/ Alternate route: /legacy/corporations/{corporation_id}/industry/jobs/ Alternate route: /v1/corporations/{corporation_id}/industry/jobs/ --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Factory_Manager

get_industry_facilities(connection, opts \\ [])

List industry facilities Return a list of industry facilities --- Alternate route: /dev/industry/facilities/ Alternate route: /legacy/industry/facilities/ Alternate route: /v1/industry/facilities/ --- This route is cached for up to 3600 seconds

get_industry_systems(connection, opts \\ [])

List solar system cost indices Return cost indices for solar systems --- Alternate route: /dev/industry/systems/ Alternate route: /legacy/industry/systems/ Alternate route: /v1/industry/systems/ --- This route is cached for up to 3600 seconds

Functions

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

@spec get_characters_character_id_industry_jobs(
  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, [EveESI.Model.GetCharactersCharacterIdIndustryJobs200Ok.t()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List character industry jobs List industry jobs placed by a character --- Alternate route: /dev/characters/{character_id}/industry/jobs/ Alternate route: /legacy/characters/{character_id}/industry/jobs/ Alternate route: /v1/characters/{character_id}/industry/jobs/ --- This route is cached for up to 300 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
    • :include_completed (boolean()): Whether to retrieve completed character industry jobs. Only includes jobs from the past 90 days
    • :token (String.t): Access token to use if unable to set a header

Returns

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

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

@spec get_characters_character_id_mining(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.GetCharactersCharacterIdMining200Ok.t()]}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Character mining ledger Paginated record of all mining done by a character for the past 30 days --- Alternate route: /dev/characters/{character_id}/mining/ Alternate route: /legacy/characters/{character_id}/mining/ Alternate route: /v1/characters/{character_id}/mining/ --- This route is cached for up to 600 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, [%GetCharactersCharacterIdMining200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

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

@spec get_corporation_corporation_id_mining_extractions(
  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.GetCorporationCorporationIdMiningExtractions200Ok.t()]}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Moon extraction timers Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. --- Alternate route: /dev/corporation/{corporation_id}/mining/extractions/ Alternate route: /legacy/corporation/{corporation_id}/mining/extractions/ Alternate route: /v1/corporation/{corporation_id}/mining/extractions/ --- This route is cached for up to 1800 seconds --- Requires one of the following EVE corporation role(s): Station_Manager

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
    • :page (integer()): Which page of results to return
    • :token (String.t): Access token to use if unable to set a header

Returns

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

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

@spec get_corporation_corporation_id_mining_observers(
  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.GetCorporationCorporationIdMiningObservers200Ok.t()]}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Corporation mining observers Paginated list of all entities capable of observing and recording mining for a corporation --- Alternate route: /dev/corporation/{corporation_id}/mining/observers/ Alternate route: /legacy/corporation/{corporation_id}/mining/observers/ Alternate route: /v1/corporation/{corporation_id}/mining/observers/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): 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
    • :page (integer()): Which page of results to return
    • :token (String.t): Access token to use if unable to set a header

Returns

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

get_corporation_corporation_id_mining_observers_observer_id(connection, corporation_id, observer_id, opts \\ [])

@spec get_corporation_corporation_id_mining_observers_observer_id(
  Tesla.Env.client(),
  integer(),
  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,
     [
       EveESI.Model.GetCorporationCorporationIdMiningObserversObserverId200Ok.t()
     ]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Observed corporation mining Paginated record of all mining seen by an observer --- Alternate route: /dev/corporation/{corporation_id}/mining/observers/{observer_id}/ Alternate route: /legacy/corporation/{corporation_id}/mining/observers/{observer_id}/ Alternate route: /v1/corporation/{corporation_id}/mining/observers/{observer_id}/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant

Parameters

  • connection (EveESI.Connection): Connection to server
  • corporation_id (integer()): An EVE corporation ID
  • observer_id (integer()): A mining observer 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, [%GetCorporationCorporationIdMiningObserversObserverId200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

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

@spec get_corporations_corporation_id_industry_jobs(
  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, [EveESI.Model.GetCorporationsCorporationIdIndustryJobs200Ok.t()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List corporation industry jobs List industry jobs run by a corporation --- Alternate route: /dev/corporations/{corporation_id}/industry/jobs/ Alternate route: /legacy/corporations/{corporation_id}/industry/jobs/ Alternate route: /v1/corporations/{corporation_id}/industry/jobs/ --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Factory_Manager

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
    • :include_completed (boolean()): Whether to retrieve completed corporation industry jobs. Only includes jobs from the past 90 days
    • :page (integer()): Which page of results to return
    • :token (String.t): Access token to use if unable to set a header

Returns

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

get_industry_facilities(connection, opts \\ [])

@spec get_industry_facilities(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, [EveESI.Model.GetIndustryFacilities200Ok.t()]}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List industry facilities Return a list of industry facilities --- Alternate route: /dev/industry/facilities/ Alternate route: /legacy/industry/facilities/ Alternate route: /v1/industry/facilities/ --- This route is cached for up to 3600 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • 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

Returns

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

get_industry_systems(connection, opts \\ [])

@spec get_industry_systems(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, [EveESI.Model.GetIndustrySystems200Ok.t()]}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List solar system cost indices Return cost indices for solar systems --- Alternate route: /dev/industry/systems/ Alternate route: /legacy/industry/systems/ Alternate route: /v1/industry/systems/ --- This route is cached for up to 3600 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • 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

Returns

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