Skip to content

Latest commit

 

History

History
134 lines (91 loc) · 5.75 KB

LocationApi.md

File metadata and controls

134 lines (91 loc) · 5.75 KB

\LocationApi

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

Method HTTP request Description
GetCharactersCharacterIdLocation Get /v1/characters/{character_id}/location/ Get character location
GetCharactersCharacterIdOnline Get /v2/characters/{character_id}/online/ Get character online
GetCharactersCharacterIdShip Get /v1/characters/{character_id}/ship/ Get current ship

GetCharactersCharacterIdLocation

GetCharactersCharacterIdLocationOk GetCharactersCharacterIdLocation(ctx, characterId, optional) Get character location

Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable. --- This route is cached for up to 5 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
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

GetCharactersCharacterIdLocationOk

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]

GetCharactersCharacterIdOnline

GetCharactersCharacterIdOnlineOk GetCharactersCharacterIdOnline(ctx, characterId, optional) Get character online

Checks if the character is currently online --- This route is cached for up to 60 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
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

GetCharactersCharacterIdOnlineOk

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]

GetCharactersCharacterIdShip

GetCharactersCharacterIdShipOk GetCharactersCharacterIdShip(ctx, characterId, optional) Get current ship

Get the current ship type, name and id --- This route is cached for up to 5 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
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

GetCharactersCharacterIdShipOk

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]