Skip to content

Latest commit

 

History

History
565 lines (379 loc) · 24.2 KB

CharacterApi.md

File metadata and controls

565 lines (379 loc) · 24.2 KB

\CharacterApi

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

Method HTTP request Description
GetCharactersCharacterId Get /v5/characters/{character_id}/ Get character's public information
GetCharactersCharacterIdAgentsResearch Get /v2/characters/{character_id}/agents_research/ Get agents research
GetCharactersCharacterIdBlueprints Get /v3/characters/{character_id}/blueprints/ Get blueprints
GetCharactersCharacterIdCorporationhistory Get /v2/characters/{character_id}/corporationhistory/ Get corporation history
GetCharactersCharacterIdFatigue Get /v2/characters/{character_id}/fatigue/ Get jump fatigue
GetCharactersCharacterIdMedals Get /v2/characters/{character_id}/medals/ Get medals
GetCharactersCharacterIdNotifications Get /v5/characters/{character_id}/notifications/ Get character notifications
GetCharactersCharacterIdNotificationsContacts Get /v2/characters/{character_id}/notifications/contacts/ Get new contact notifications
GetCharactersCharacterIdPortrait Get /v2/characters/{character_id}/portrait/ Get character portraits
GetCharactersCharacterIdRoles Get /v3/characters/{character_id}/roles/ Get character corporation roles
GetCharactersCharacterIdStandings Get /v2/characters/{character_id}/standings/ Get standings
GetCharactersCharacterIdTitles Get /v2/characters/{character_id}/titles/ Get character corporation titles
PostCharactersAffiliation Post /v2/characters/affiliation/ Character affiliation
PostCharactersCharacterIdCspa Post /v5/characters/{character_id}/cspa/ Calculate a CSPA charge cost

GetCharactersCharacterId

GetCharactersCharacterIdOk GetCharactersCharacterId(ctx, characterId, optional) Get character's public information

Public information about a character --- This route is cached for up to 604800 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag

Return type

GetCharactersCharacterIdOk

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdAgentsResearch

[]GetCharactersCharacterIdAgentsResearch200Ok GetCharactersCharacterIdAgentsResearch(ctx, characterId, optional) Get agents research

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) --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdAgentsResearch200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdBlueprints

[]GetCharactersCharacterIdBlueprints200Ok GetCharactersCharacterIdBlueprints(ctx, characterId, optional) Get blueprints

Return a list of blueprints the character owns --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdBlueprints200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdCorporationhistory

[]GetCharactersCharacterIdCorporationhistory200Ok GetCharactersCharacterIdCorporationhistory(ctx, characterId, optional) Get corporation history

Get a list of all the corporations a character has been a member of --- This route is cached for up to 86400 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag

Return type

[]GetCharactersCharacterIdCorporationhistory200Ok

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdFatigue

GetCharactersCharacterIdFatigueOk GetCharactersCharacterIdFatigue(ctx, characterId, optional) Get jump fatigue

Return a character's jump activation and fatigue information --- This route is cached for up to 300 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

GetCharactersCharacterIdFatigueOk

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdMedals

[]GetCharactersCharacterIdMedals200Ok GetCharactersCharacterIdMedals(ctx, characterId, optional) Get medals

Return a list of medals the character has --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdMedals200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdNotifications

[]GetCharactersCharacterIdNotifications200Ok GetCharactersCharacterIdNotifications(ctx, characterId, optional) Get character notifications

Return character notifications --- This route is cached for up to 600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdNotifications200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdNotificationsContacts

[]GetCharactersCharacterIdNotificationsContacts200Ok GetCharactersCharacterIdNotificationsContacts(ctx, characterId, optional) Get new contact notifications

Return notifications about having been added to someone's contact list --- This route is cached for up to 600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdNotificationsContacts200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdPortrait

GetCharactersCharacterIdPortraitOk GetCharactersCharacterIdPortrait(ctx, characterId, optional) Get character portraits

Get portrait urls for a character --- This route expires daily at 11:05

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag

Return type

GetCharactersCharacterIdPortraitOk

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdRoles

GetCharactersCharacterIdRolesOk GetCharactersCharacterIdRoles(ctx, characterId, optional) Get character corporation roles

Returns a character's corporation roles --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

GetCharactersCharacterIdRolesOk

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdStandings

[]GetCharactersCharacterIdStandings200Ok GetCharactersCharacterIdStandings(ctx, characterId, optional) Get standings

Return character standings from agents, NPC corporations, and factions --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdStandings200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdTitles

[]GetCharactersCharacterIdTitles200Ok GetCharactersCharacterIdTitles(ctx, characterId, optional) Get character corporation titles

Returns a character's titles --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

[]GetCharactersCharacterIdTitles200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCharactersAffiliation

[]PostCharactersAffiliation200Ok PostCharactersAffiliation(ctx, characters, optional) Character affiliation

Bulk lookup of character IDs to corporation, alliance and faction --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characters []int32 The character IDs to fetch affiliations for. All characters must exist, or none will be returned
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characters []int32 The character IDs to fetch affiliations for. All characters must exist, or none will be returned
datasource string The server name you would like data from [default to tranquility]

Return type

[]PostCharactersAffiliation200Ok

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCharactersCharacterIdCspa

float32 PostCharactersCharacterIdCspa(ctx, characterId, characters, optional) Calculate a CSPA charge cost

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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
characters []int32 The target characters to calculate the charge for
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
characters []int32 The target characters to calculate the charge for
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header

Return type

float32

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]