esi v0.1.1 ESI.API.Character

Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate)

assets(character_id, opts \\ [])

Return a list of the characters assets

attendees(character_id, event_id, opts \\ [])

Get all invited attendees for a given event

attributes(character_id, opts \\ [])

Return attributes of a character

bids(character_id, contract_id, opts \\ [])

Lists bids on a particular auction contract

blueprints(character_id, opts \\ [])

Return a list of blueprints the character owns

bookmark_folders(character_id, opts \\ [])

A list of your character’s personal bookmark folders

bookmarks(character_id, opts \\ [])

A list of your character’s personal bookmarks

calendar(character_id, opts \\ [])

Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event

calendar_event(character_id, event_id, opts \\ [])

Get all the information for a specific event

character(character_id)

Public information about a character

chat_channels(character_id, opts \\ [])

Return chat channels that a character is the owner or operator of

clones(character_id, opts \\ [])

A list of the character’s clones

contact_labels(character_id, opts \\ [])

Return custom labels for contacts the character defined

contacts(character_id, opts \\ [])

Return contacts of a character

contracts(character_id, opts \\ [])

Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is “in_progress”

corporation_history(character_id)

Get a list of all the corporations a character has been a member of

create_affiliation(opts \\ [])

Bulk lookup of character IDs to corporation, alliance and faction

create_asset_locations(character_id, opts \\ [])

Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)

create_asset_names(character_id, opts \\ [])

Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships

create_contacts(character_id, opts \\ [])

Bulk add contacts with same settings

create_cspa(character_id, opts \\ [])

Takes a source character ID in the url and a set of target character ID’s in the body, returns a CSPA charge cost

create_fittings(character_id, opts \\ [])

Save a new fitting for a character

create_mail(character_id, opts \\ [])

Create and send a new mail

create_mail_labels(character_id, opts \\ [])

Create a mail label

delete_contacts(character_id, opts \\ [])

Bulk delete contacts

delete_fitting(character_id, fitting_id, opts \\ [])

Delete a fitting from a character

delete_mail_item(character_id, mail_id, opts \\ [])

Delete a mail

delete_mail_label(character_id, label_id, opts \\ [])

Delete a mail label

fatigue(character_id, opts \\ [])

Return a character’s jump activation and fatigue information

fittings(character_id, opts \\ [])

Return fittings of a character

fleet(character_id, opts \\ [])

Return the fleet ID the character is in, if any

fw_stats(character_id, opts \\ [])

Statistical overview of a character involved in faction warfare

implants(character_id, opts \\ [])

Return implants on the active clone of a character

industry_jobs(character_id, opts \\ [])

List industry jobs placed by a character

items(character_id, contract_id, opts \\ [])

Lists items of a particular contract

killmail_recent(character_id, opts \\ [])

Return a list of character’s recent kills and losses

location(character_id, opts \\ [])

Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable

loyalty_points(character_id, opts \\ [])

Return a list of loyalty points for all corporations the character has worked for

mail(character_id, opts \\ [])

Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards

mail_item(character_id, mail_id, opts \\ [])

Return the contents of an EVE mail

mail_labels(character_id, opts \\ [])

Return a list of the users mail labels, unread counts for each label and a total unread count

mail_lists(character_id, opts \\ [])

Return all mailing lists that the character is subscribed to

medals(character_id, opts \\ [])

Return a list of medals the character has

mining(character_id, opts \\ [])

Paginated record of all mining done by a character for the past 30 days

names(opts \\ [])

Resolve a set of character IDs to character names

notification_contacts(character_id, opts \\ [])

Return notifications about having been added to someone’s contact list

notifications(character_id, opts \\ [])

Return character notifications

online(character_id, opts \\ [])

Checks if the character is currently online

opportunities(character_id, opts \\ [])

Return a list of tasks finished by a character

orders(character_id, opts \\ [])

List market orders placed by a character

planet(character_id, planet_id, opts \\ [])

Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met

planets(character_id, opts \\ [])

Returns a list of all planetary colonies owned by a character

portrait(character_id)

Get portrait urls for a character

roles(character_id, opts \\ [])

Returns a character’s corporation roles

search(character_id, opts \\ [])

Search for entities that match a given sub-string

ship(character_id, opts \\ [])

Get the current ship type, name and id

skillqueue(character_id, opts \\ [])

List the configured skill queue for the given character

skills(character_id, opts \\ [])

List all trained skills for the given character

standings(character_id, opts \\ [])

Return character standings from agents, NPC corporations, and factions

titles(character_id, opts \\ [])

Returns a character’s titles

update_calendar_event(character_id, event_id, opts \\ [])

Set your response status to an event

update_contacts(character_id, opts \\ [])

Bulk edit contacts with same settings

update_mail_item(character_id, mail_id, opts \\ [])

Update metadata about a mail

wallet(character_id, opts \\ [])

Returns a character’s wallet balance

wallet_journal(character_id, opts \\ [])

Retrieve character wallet journal

wallet_transactions(character_id, opts \\ [])

Get wallet transactions of a character

Types

agents_research_opt()

agents_research_opt() :: {:token, nil | String.t}

agents_research_opts()

agents_research_opts() :: [agents_research_opt]

Options for Character.agents_research/2.

:token — Access token to use if unable to set a header

assets_opt()

assets_opt() :: {:page, nil | integer} | {:token, nil | String.t}

assets_opts()

assets_opts() :: [assets_opt]

Options for Character.assets/2.

:page (DEFAULT: 1) — Which page of results to return
:token — Access token to use if unable to set a header

attendees_opt()

attendees_opt() :: {:token, nil | String.t}

attendees_opts()

attendees_opts() :: [attendees_opt]

Options for Character.attendees/3.

:token — Access token to use if unable to set a header

attributes_opt()

attributes_opt() :: {:token, nil | String.t}

attributes_opts()

attributes_opts() :: [attributes_opt]

Options for Character.attributes/2.

:token — Access token to use if unable to set a header

bids_opt()

bids_opt() :: {:token, nil | String.t}

bids_opts()

bids_opts() :: [bids_opt]

Options for Character.bids/3.

:token — Access token to use if unable to set a header

blueprints_opt()

blueprints_opt ::
  {:page, nil | integer} |
  {:token, nil | String.t}

blueprints_opts()

blueprints_opts() :: [blueprints_opt]

Options for Character.blueprints/2.

:page (DEFAULT: 1) — Which page of results to return
:token — Access token to use if unable to set a header

bookmark_folders_opt()

bookmark_folders_opt ::
  {:page, nil | integer} |
  {:token, nil | String.t}

bookmark_folders_opts()

bookmark_folders_opts() :: [bookmark_folders_opt]

Options for Character.bookmark_folders/2.

:page (DEFAULT: 1) — Which page of results to return
:token — Access token to use if unable to set a header

bookmarks_opt()

bookmarks_opt ::
  {:page, nil | integer} |
  {:token, nil | String.t}

bookmarks_opts()

bookmarks_opts() :: [bookmarks_opt]

Options for Character.bookmarks/2.

:page (DEFAULT: 1) — Which page of results to return
:token — Access token to use if unable to set a header

calendar_event_opt()

calendar_event_opt() :: {:token, nil | String.t}

calendar_event_opts()

calendar_event_opts() :: [calendar_event_opt]

Options for Character.calendar_event/3.

:token — Access token to use if unable to set a header

calendar_opt()

calendar_opt ::
  {:from_event, nil | integer} |
  {:token, nil | String.t}

calendar_opts()

calendar_opts() :: [calendar_opt]

Options for Character.calendar/2.

:from_event — The event ID to retrieve events from
:token — Access token to use if unable to set a header

chat_channels_opt()

chat_channels_opt() :: {:token, nil | String.t}

chat_channels_opts()

chat_channels_opts() :: [chat_channels_opt]

Options for Character.chat_channels/2.

:token — Access token to use if unable to set a header

clones_opt()

clones_opt() :: {:token, nil | String.t}

clones_opts()

clones_opts() :: [clones_opt]

Options for Character.clones/2.

:token — Access token to use if unable to set a header

contact_labels_opt()

contact_labels_opt() :: {:token, nil | String.t}

contact_labels_opts()

contact_labels_opts() :: [contact_labels_opt]

Options for Character.contact_labels/2.

:token — Access token to use if unable to set a header

contacts_opt()

contacts_opt ::
  {:page, nil | integer} |
  {:token, nil | String.t}

contacts_opts()

contacts_opts() :: [contacts_opt]

Options for Character.contacts/2.

:page (DEFAULT: 1) — Which page of results to return
:token — Access token to use if unable to set a header

contracts_opt()

contracts_opt() :: {:token, nil | String.t}

contracts_opts()

contracts_opts() :: [contracts_opt]

Options for Character.contracts/2.

:token — Access token to use if unable to set a header

create_affiliation_opt()

create_affiliation_opt() :: {:characters, [nil | integer]}

create_affiliation_opts()

create_affiliation_opts() :: [create_affiliation_opt]

Options for Character.create_affiliation/1.

:characters (REQUIRED) — The character IDs to fetch affiliations for. All characters must exist, or none will be returned.

create_asset_locations_opt()

create_asset_locations_opt ::
  {:item_ids, [nil | integer]} |
  {:token, nil | String.t}

create_asset_locations_opts()

create_asset_locations_opts() :: [create_asset_locations_opt]

Options for Character.create_asset_locations/2.

:item_ids (REQUIRED) — A list of item ids
:token — Access token to use if unable to set a header

create_asset_names_opt()

create_asset_names_opt ::
  {:item_ids, [nil | integer]} |
  {:token, nil | String.t}

create_asset_names_opts()

create_asset_names_opts() :: [create_asset_names_opt]

Options for Character.create_asset_names/2.

:item_ids (REQUIRED) — A list of item ids
:token — Access token to use if unable to set a header

create_contacts_opt()

create_contacts_opt ::
  {:contact_ids, [nil | integer]} |
  {:label_id, nil | integer} |
  {:standing, float} |
  {:token, nil | String.t} |
  {:watched, nil | boolean}

create_contacts_opts()

create_contacts_opts() :: [create_contacts_opt]

Options for Character.create_contacts/2.

:contact_ids (REQUIRED) — A list of contacts to add
:label_id (DEFAULT: 0) — Add a custom label to the new contact
:standing (REQUIRED) — Standing for the new contact
:token — Access token to use if unable to set a header
:watched (DEFAULT: false) — Whether the new contact should be watched, note this is only effective on characters

create_cspa_opt()

create_cspa_opt ::
  {:characters, [{:characters, [integer]}]} |
  {:token, nil | String.t}

create_cspa_opts()

create_cspa_opts() :: [create_cspa_opt]

Options for Character.create_cspa/2.

:characters (REQUIRED) — The target characters to calculate the charge for
:token — Access token to use if unable to set a header

create_fittings_opt()

create_fittings_opt ::
  {:fitting, nil | [description: String.t, items: [[flag: integer, quantity: integer, type_id: integer]], name: String.t, ship_type_id: integer]} |
  {:token, nil | String.t}

create_fittings_opts()

create_fittings_opts() :: [create_fittings_opt]

Options for Character.create_fittings/2.

:fitting — Details about the new fitting
:token — Access token to use if unable to set a header

create_mail_labels_opt()

create_mail_labels_opt ::
  {:label, nil | [color: nil | :"#0000fe" | :"#006634" | :"#0099ff" | :"#00ff33" | :"#01ffff" | :"#349800" | :"#660066" | :"#666666" | :"#999999" | :"#99ffff" | :"#9a0000" | :"#ccff9a" | :"#e6e6e6" | :"#fe0000" | :"#ff6600" | :"#ffff01" | :"#ffffcd" | :"#ffffff", name: String.t]} |
  {:token, nil | String.t}

create_mail_labels_opts()

create_mail_labels_opts() :: [create_mail_labels_opt]

Options for Character.create_mail_labels/2.

:label — Label to create
:token — Access token to use if unable to set a header

create_mail_opt()

create_mail_opt ::
  {:mail, [approved_cost: nil | integer, body: String.t, recipients: [[recipient_id: integer, recipient_type: :alliance | :character | :corporation | :mailing_list]], subject: String.t]} |
  {:token, nil | String.t}

create_mail_opts()

create_mail_opts() :: [create_mail_opt]

Options for Character.create_mail/2.

:mail (REQUIRED) — The mail to send
:token — Access token to use if unable to set a header

delete_contacts_opt()

delete_contacts_opt ::
  {:contact_ids, [nil | integer]} |
  {:token, nil | String.t}

delete_contacts_opts()

delete_contacts_opts() :: [delete_contacts_opt]

Options for Character.delete_contacts/2.

:contact_ids (REQUIRED) — A list of contacts to delete
:token — Access token to use if unable to set a header

delete_fitting_opt()

delete_fitting_opt() :: {:token, nil | String.t}

delete_fitting_opts()

delete_fitting_opts() :: [delete_fitting_opt]

Options for Character.delete_fitting/3.

:token — Access token to use if unable to set a header

delete_mail_item_opt()

delete_mail_item_opt() :: {:token, nil | String.t}

delete_mail_item_opts()

delete_mail_item_opts() :: [delete_mail_item_opt]

Options for Character.delete_mail_item/3.

:token — Access token to use if unable to set a header

delete_mail_label_opt()

delete_mail_label_opt() :: {:token, nil | String.t}

delete_mail_label_opts()

delete_mail_label_opts() :: [delete_mail_label_opt]

Options for Character.delete_mail_label/3.

:token — Access token to use if unable to set a header

fatigue_opt()

fatigue_opt() :: {:token, nil | String.t}

fatigue_opts()

fatigue_opts() :: [fatigue_opt]

Options for Character.fatigue/2.

:token — Access token to use if unable to set a header

fittings_opt()

fittings_opt() :: {:token, nil | String.t}

fittings_opts()

fittings_opts() :: [fittings_opt]

Options for Character.fittings/2.

:token — Access token to use if unable to set a header

fleet_opt()

fleet_opt() :: {:token, nil | String.t}

fleet_opts()

fleet_opts() :: [fleet_opt]

Options for Character.fleet/2.

:token — Access token to use if unable to set a header

fw_stats_opt()

fw_stats_opt() :: {:token, nil | String.t}

fw_stats_opts()

fw_stats_opts() :: [fw_stats_opt]

Options for Character.fw_stats/2.

:token — Access token to use if unable to set a header

implants_opt()

implants_opt() :: {:token, nil | String.t}

implants_opts()

implants_opts() :: [implants_opt]

Options for Character.implants/2.

:token — Access token to use if unable to set a header

industry_jobs_opt()

industry_jobs_opt ::
  {:include_completed, nil | boolean} |
  {:token, nil | String.t}

industry_jobs_opts()

industry_jobs_opts() :: [industry_jobs_opt]

Options for Character.industry_jobs/2.

:include_completed — Whether retrieve completed character industry jobs as well
:token — Access token to use if unable to set a header

items_opt()

items_opt() :: {:token, nil | String.t}

items_opts()

items_opts() :: [items_opt]

Options for Character.items/3.

:token — Access token to use if unable to set a header

killmail_recent_opt()

killmail_recent_opt ::
  {:max_count, nil | integer} |
  {:max_kill_id, nil | integer} |
  {:token, nil | String.t}

killmail_recent_opts()

killmail_recent_opts() :: [killmail_recent_opt]

Options for Character.killmail_recent/2.

:max_count (DEFAULT: 50) — How many killmails to return at maximum
:max_kill_id — Only return killmails with ID smaller than this.
:token — Access token to use if unable to set a header

location_opt()

location_opt() :: {:token, nil | String.t}

location_opts()

location_opts() :: [location_opt]

Options for Character.location/2.

:token — Access token to use if unable to set a header

loyalty_points_opt()

loyalty_points_opt() :: {:token, nil | String.t}

loyalty_points_opts()

loyalty_points_opts() :: [loyalty_points_opt]

Options for Character.loyalty_points/2.

:token — Access token to use if unable to set a header

mail_item_opt()

mail_item_opt() :: {:token, nil | String.t}

mail_item_opts()

mail_item_opts() :: [mail_item_opt]

Options for Character.mail_item/3.

:token — Access token to use if unable to set a header

mail_labels_opt()

mail_labels_opt() :: {:token, nil | String.t}

mail_labels_opts()

mail_labels_opts() :: [mail_labels_opt]

Options for Character.mail_labels/2.

:token — Access token to use if unable to set a header

mail_lists_opt()

mail_lists_opt() :: {:token, nil | String.t}

mail_lists_opts()

mail_lists_opts() :: [mail_lists_opt]

Options for Character.mail_lists/2.

:token — Access token to use if unable to set a header

mail_opt()

mail_opt ::
  {:labels, nil | [integer]} |
  {:last_mail_id, nil | integer} |
  {:token, nil | String.t}

mail_opts()

mail_opts() :: [mail_opt]

Options for Character.mail/2.

:labels — Fetch only mails that match one or more of the given labels
:last_mail_id — List only mail with an ID lower than the given ID, if present
:token — Access token to use if unable to set a header

medals_opt()

medals_opt() :: {:token, nil | String.t}

medals_opts()

medals_opts() :: [medals_opt]

Options for Character.medals/2.

:token — Access token to use if unable to set a header

mining_opt()

mining_opt() :: {:page, nil | integer} | {:token, nil | String.t}

mining_opts()

mining_opts() :: [mining_opt]

Options for Character.mining/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() :: {:character_ids, [integer]}

names_opts()

names_opts() :: [names_opt]

Options for Character.names/1.

:character_ids (REQUIRED) — A comma separated list of character IDs

notification_contacts_opt()

notification_contacts_opt() :: {:token, nil | String.t}

notification_contacts_opts()

notification_contacts_opts() :: [notification_contacts_opt]

Options for Character.notification_contacts/2.

:token — Access token to use if unable to set a header

notifications_opt()

notifications_opt() :: {:token, nil | String.t}

notifications_opts()

notifications_opts() :: [notifications_opt]

Options for Character.notifications/2.

:token — Access token to use if unable to set a header

online_opt()

online_opt() :: {:token, nil | String.t}

online_opts()

online_opts() :: [online_opt]

Options for Character.online/2.

:token — Access token to use if unable to set a header

opportunities_opt()

opportunities_opt() :: {:token, nil | String.t}

opportunities_opts()

opportunities_opts() :: [opportunities_opt]

Options for Character.opportunities/2.

:token — Access token to use if unable to set a header

orders_opt()

orders_opt() :: {:token, nil | String.t}

orders_opts()

orders_opts() :: [orders_opt]

Options for Character.orders/2.

:token — Access token to use if unable to set a header

planet_opt()

planet_opt() :: {:token, nil | String.t}

planet_opts()

planet_opts() :: [planet_opt]

Options for Character.planet/3.

:token — Access token to use if unable to set a header

planets_opt()

planets_opt() :: {:token, nil | String.t}

planets_opts()

planets_opts() :: [planets_opt]

Options for Character.planets/2.

:token — Access token to use if unable to set a header

roles_opt()

roles_opt() :: {:token, nil | String.t}

roles_opts()

roles_opts() :: [roles_opt]

Options for Character.roles/2.

:token — Access token to use if unable to set a header

search_opt()

search_opt ::
  {:categories, [:agent | :alliance | :character | :constellation | :corporation | :faction | :inventorytype | :region | :solarsystem | :station | :structure | :wormhole]} |
  {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh} |
  {:search, String.t} |
  {:strict, nil | boolean} |
  {:token, nil | String.t}

search_opts()

search_opts() :: [search_opt]

Options for Character.search/2.

:categories (REQUIRED) — Type of entities to search for
:language (DEFAULT: :"en-us") — Language to use in the response
:search (REQUIRED) — The string to search on
:strict (DEFAULT: false) — Whether the search should be a strict match
:token — Access token to use if unable to set a header

ship_opt()

ship_opt() :: {:token, nil | String.t}

ship_opts()

ship_opts() :: [ship_opt]

Options for Character.ship/2.

:token — Access token to use if unable to set a header

skillqueue_opt()

skillqueue_opt() :: {:token, nil | String.t}

skillqueue_opts()

skillqueue_opts() :: [skillqueue_opt]

Options for Character.skillqueue/2.

:token — Access token to use if unable to set a header

skills_opt()

skills_opt() :: {:token, nil | String.t}

skills_opts()

skills_opts() :: [skills_opt]

Options for Character.skills/2.

:token — Access token to use if unable to set a header

standings_opt()

standings_opt() :: {:token, nil | String.t}

standings_opts()

standings_opts() :: [standings_opt]

Options for Character.standings/2.

:token — Access token to use if unable to set a header

titles_opt()

titles_opt() :: {:token, nil | String.t}

titles_opts()

titles_opts() :: [titles_opt]

Options for Character.titles/2.

:token — Access token to use if unable to set a header

update_calendar_event_opt()

update_calendar_event_opt ::
  {:response, [{:response, :accepted | :declined | :tentative}]} |
  {:token, nil | String.t}

update_calendar_event_opts()

update_calendar_event_opts() :: [update_calendar_event_opt]

Options for Character.update_calendar_event/3.

:response (REQUIRED) — The response value to set, overriding current value.
:token — Access token to use if unable to set a header

update_contacts_opt()

update_contacts_opt ::
  {:contact_ids, [nil | integer]} |
  {:label_id, nil | integer} |
  {:standing, float} |
  {:token, nil | String.t} |
  {:watched, nil | boolean}

update_contacts_opts()

update_contacts_opts() :: [update_contacts_opt]

Options for Character.update_contacts/2.

:contact_ids (REQUIRED) — A list of contacts to edit
:label_id (DEFAULT: 0) — Add a custom label to the contact, use 0 for clearing label
:standing (REQUIRED) — Standing for the contact
:token — Access token to use if unable to set a header
:watched (DEFAULT: false) — Whether the contact should be watched, note this is only effective on characters

update_mail_item_opt()

update_mail_item_opt ::
  {:contents, [labels: nil | [integer], read: nil | boolean]} |
  {:token, nil | String.t}

update_mail_item_opts()

update_mail_item_opts() :: [update_mail_item_opt]

Options for Character.update_mail_item/3.

:contents (REQUIRED) — Data used to update the mail
:token — Access token to use if unable to set a header

wallet_journal_opt()

wallet_journal_opt ::
  {:from_id, nil | integer} |
  {:token, nil | String.t}

wallet_journal_opts()

wallet_journal_opts() :: [wallet_journal_opt]

Options for Character.wallet_journal/2.

:from_id — Only show journal entries happened before the transaction referenced by this id
:token — Access token to use if unable to set a header

wallet_opt()

wallet_opt() :: {:token, nil | String.t}

wallet_opts()

wallet_opts() :: [wallet_opt]

Options for Character.wallet/2.

:token — Access token to use if unable to set a header

wallet_transactions_opt()

wallet_transactions_opt ::
  {:from_id, nil | integer} |
  {:token, nil | String.t}

wallet_transactions_opts()

wallet_transactions_opts() :: [wallet_transactions_opt]

Options for Character.wallet_transactions/2.

:from_id — Only show transactions happened before the one referenced by this id
:token — Access token to use if unable to set a header

Functions

agents_research(character_id, opts \\ [])

agents_research(character_id :: integer, opts :: agents_research_opts) :: ESI.Request.t

Response Example

A list of agents research information:

[%{"agent_id" => 3009358, "points_per_day" => 53.5346162146776,
   "remainder_points" => 53604.0634303189, "skill_type_id" => 11450,
   "started_at" => "2017-03-23T14:47:00Z"}]

Swagger Source

This function was generated from the following Swagger operation:

operationId — get_characters_character_id_agents_research
path — /characters/{character_id}/agents_research/