ESI (EVE Swagger Interface)

https://docs.esi.evetech.net/docs/esi_introduction.html
Admin
The official RESTful API for EVE third-party development, providing a multi-tenant interface to...
Tokens:12,403
Snippets:111
Trust Score:6.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example EVE SSO OAuth 2.0 PKCE Authorization URL

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/native_sso_flow

An example of a complete authorization URL for the EVE SSO OAuth 2.0 PKCE flow, demonstrating how parameters like `response_type`, `redirect_uri`, `client_id`, `scope`, `code_challenge`, `code_challenge_method`, and `state` are combined.

```APIDOC
https://login.eveonline.com/v2/oauth/authorize/?response_type=code&redirect_uri=https%3A%2F%2Flocalhost%2Fcallback%2F&client_id=<your-client-id>&scope=esi-characters.read_blueprints.v1&code_challenge=<URL safe Base64(SHA256(URL safe Base64(random 32 byte string)))>&code_challenge_method=S256&state=<unique-string>
```

--------------------------------

### API Endpoint: Opportunities Tasks Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of opportunity tasks. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/opportunities/tasks/
  GET
```

--------------------------------

### Example of Flat Asset List Data Structure

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/asset_location_id

This example illustrates a flat list representation of asset items, showing their `item_id` and `location_id`.

```APIDOC
item_id: 1000000000001, location_id: 60002959
item_id: 1000000000002, location_id: 60002959
item_id: 1000000000003, location_id: 1000000000001
item_id: 1000000000004, location_id: 1000000000003
item_id: 1000000000005, location_id: 1000000000003
```

--------------------------------

### EVE Online Image Server API Reference

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/image_server

Detailed API documentation for the EVE Online Image Server, outlining the base URL, image request format, supported categories, path parameters, query parameters, return types, and usage notes. Includes various example URLs for different entity types.

```APIDOC
Base URL: https://images.evetech.net/

Endpoint: /{category}/{id}/{variation}
  Description: Retrieves an image for a specific EVE Online entity.
  Path Parameters:
    category:
      Type: string
      Description: The type of entity.
      Valid Values: alliances, corporations, characters, types
    id:
      Type: integer
      Description: The unique identifier of the entity.
    variation:
      Type: string
      Description: The specific image variation to retrieve.
      Examples: logo, portrait, icon, render, bp, bpc, relic
      Note: Available variations for an ID can be requested at /{category}/{id} (returns JSON array of strings).
  Query Parameters:
    size:
      Type: integer
      Description: The desired image resolution.
      Valid Values: 32, 64, 128, 256, 512, 1024
      Default: Native resolution
    tenant:
      Type: string
      Description: The server for which to request images.
      Valid Values: tranquility, singularity
      Default: tranquility
  Returns:
    Image data (PNG, except character portraits which are JPEG).

Additional Notes:
  - NPC faction logos: Use faction ID with the 'corporations' category.
  - Default logo/portrait: Use ID 1 with 'alliances', 'corporations', and 'characters' categories.
  - Images are returned as PNGs, except character portraits which are JPEGs.
  - The service can be used directly as a CDN; caching is not required.

Examples:
  - Alliances:
    - https://images.evetech.net/alliances/434243723
    - https://images.evetech.net/alliances/434243723/logo
  - Corporations:
    - https://images.evetech.net/corporations/109299958
    - https://images.evetech.net/corporations/109299958/logo
  - NPC Factions:
    - https://images.evetech.net/corporations/500001
    - https://images.evetech.net/corporations/500001/logo
  - Characters:
    - https://images.evetech.net/characters/1338057886
    - https://images.evetech.net/characters/1338057886/portrait
  - Rifter (type):
    - https://images.evetech.net/types/587
    - https://images.evetech.net/types/587/icon
    - https://images.evetech.net/types/587/render
  - 250mm Railgun II (type):
    - https://images.evetech.net/types/3082
    - https://images.evetech.net/types/3082/icon
  - Avatar Blueprint (type):
    - https://images.evetech.net/types/11568
    - https://images.evetech.net/types/11568/bp
    - https://images.evetech.net/types/11568/bpc
  - Intact Hull Section (type):
    - https://images.evetech.net/types/30752
    - https://images.evetech.net/types/30752/relic
```

--------------------------------

### API Endpoint: Market Prices Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves current market prices for various items. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/prices/
  GET
```

--------------------------------

### Example Authenticated GET Request to ESI

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/sending_esi_auth_request

This example demonstrates how to construct an authenticated GET request to retrieve a character's blueprints from ESI. It shows the full request URL and the necessary 'Authorization: Bearer' header, highlighting where the access token should be inserted.

```HTTP
GET https://esi.evetech.net/latest/characters/2112625428/blueprints/

Authorization: Bearer <access token>
```

--------------------------------

### EVE SSO OAuth 2.0 PKCE Callback URL with Authorization Code

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/native_sso_flow

An example of the callback URL structure that EVE SSO uses to return the authorization `code` and `state` parameters to the native application after successful user authorization.

```APIDOC
https://<your-callback-url>/?code=<super-secret-code>&state=<unique-state-string-from-you>
```

--------------------------------

### API Endpoint: Specific Opportunities Task Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific opportunity task by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/opportunities/tasks/{taskID:integerType}/
  GET
```

--------------------------------

### Legacy `dgmExpressions` Table Entry Example

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/dogma

This example illustrates a typical entry from the `dgmExpressions` table, used for legacy effect definitions. It highlights `arg1`, `arg2`, and `operandID`, where `operandID` dictates the operation between arguments (often references to other expressions). Other fields like `expression*ID` provide final modifier data, and `expressionName` offers an overview of the expression tree. Note that `operandID` definitions are not publicly documented by CCP.

```json
"expressionGroupID": null,
"expressionAttributeID": null,
"description": null,
"expressionValue": null,
"arg1": 3487,
"arg2": 105,
"expressionName": "((CurrentTarget->maxVelocity).(PostPercent)).AddItemModifier (speedFactor)",
"operandID": 6,
"expressionID": 3489,
"expressionTypeID": null
```

--------------------------------

### API Endpoint: Opportunities Groups Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of opportunity groups. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/opportunities/groups/
  GET
```

--------------------------------

### API Endpoint: Industry Systems Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves information about industry-related systems in EVE Online. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/industry/systems/
  GET
```

--------------------------------

### Example of Hierarchical Asset Tree Data Structure

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/asset_location_id

This example illustrates a hierarchical tree representation of asset items, showing parent-child relationships based on `location_id`.

```APIDOC
item_id: 1000000000001, location_id: 60002959
  item_id: 1000000000003, location_id: 1000000000001
    item_id: 1000000000004, location_id: 1000000000003
    item_id: 1000000000005, location_id: 1000000000003
item_id: 1000000000002, location_id: 60002959
```

--------------------------------

### API Endpoint: All Market Orders Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves all market orders (buy and sell) for a specific region. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/{regionID:integerType}/orders/all/
  GET (order_type=all)
```

--------------------------------

### API Endpoint: Sovereignty Campaigns Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves information about sovereignty campaigns. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/sovereignty/campaigns/
  GET
```

--------------------------------

### API Endpoint: Sovereignty Structures Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves information about sovereignty structures. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/sovereignty/structures/
  GET
```

--------------------------------

### API Endpoint: Market History Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves historical market data for a specific region. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/{regionID:integerType}/history/
  GET
```

--------------------------------

### API Endpoint: Fleets Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides access to general fleet information and allows for modification of fleet properties. This endpoint supports GET and PUT operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/
  GET
  PUT
```

--------------------------------

### API Endpoint: Killmail Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves details for a specific killmail using its ID and hash. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/killmails/{killID:integerType}/{killHash:stringType}/
  GET
```

--------------------------------

### API Endpoint: Market Groups Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of market groups available in EVE Online. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/groups/
  GET
```

--------------------------------

### API Endpoint: Industry Facilities Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of industry facilities available in EVE Online. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/industry/facilities/
  GET
```

--------------------------------

### API Endpoint: Incursions Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves information about active incursions in EVE Online. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/incursions/
  GET
```

--------------------------------

### API Endpoint: Specific Opportunities Group Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific opportunity group by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/opportunities/groups/{groupID:integerType}/
  GET
```

--------------------------------

### API Endpoint: Inventory Categories Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of inventory categories from the EVE Online universe. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/categories/
  GET
```

--------------------------------

### API Endpoint: Inventory Groups Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of inventory groups from the EVE Online universe. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/groups/
  GET
```

--------------------------------

### API Endpoint: Specific Market Group Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific market group by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/groups/{groupID:integerType}/
  GET
```

--------------------------------

### API Endpoint: Market Buy Orders Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves buy market orders for a specific region and type ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/{regionID:integerType}/orders/buy/
  GET (order_type=buy, type_id)
```

--------------------------------

### Example Base64 Encoding for Client Credentials

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/web_based_sso_flow

Demonstrates the Base64 encoding process for the client ID and secret key, which are combined as CLIENT_ID:CLIENT_SECRET. The resulting encoded string is used in the Authorization: Basic header for the token exchange request.

```Text
Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=
```

--------------------------------

### API Endpoint: Inventory Types Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves a list of inventory types (items) from the EVE Online universe. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/types/
  GET
```

--------------------------------

### API Endpoint: Fleet Members Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Manages members within a specific fleet, allowing for retrieval and addition of members. This endpoint supports GET and POST operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/members/
  GET
  POST
```

--------------------------------

### API Endpoint: Fleet Wings Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Manages wings within a specific fleet, allowing for retrieval and addition of wings. This endpoint supports GET and POST operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/wings/
  GET
  POST
```

--------------------------------

### API Endpoint: Specific Inventory Group Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific inventory group by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/groups/{groupID:integerType}/
  GET
```

--------------------------------

### API Endpoint: Specific Inventory Category Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific inventory category by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/categories/{categoryID:integerType}/
  GET
```

--------------------------------

### API Endpoint: Market Sell Orders Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves sell market orders for a specific region and type ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/{regionID:integerType}/orders/
  GET (order_type=sell, type_id)
```

--------------------------------

### EVE SSO OAuth 2.0 Authorization Code Callback URL Example

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/web_based_sso_flow

After successful user authorization, EVE SSO redirects the user back to the application's defined callback URL. This URL contains the code (authorization code) and state parameters as query strings, which the application must extract for the next step.

```URL
https://<your-callback-url>/?code=<super-secret-code>&state=<unique-state-string-from-you>
```

--------------------------------

### API Endpoint: Specific Inventory Type Retrieval

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves detailed information for a specific inventory type (item) by its ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/inventory/types/{typeID:integerType}/
  GET
```

--------------------------------

### API Endpoint: Market Sell Orders Retrieval (Explicit)

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Retrieves sell market orders for a specific region and type ID. This endpoint supports GET operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/market/{regionID:integerType}/orders/sell/
  GET (order_type=sell, type_id)
```

--------------------------------

### Local JWT Token Decoding for EVE SSO v2 in Python

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/migrate_v1_v2

This example illustrates how to decode an EVE SSO JWT token locally in Python, replacing the deprecated `/oauth/verify` endpoint. It uses `base64` and `json` to extract header, payload, and signature components from the token string.

```Python
from base64 import urlsafe_b64decode
import json

token = "ey<...>n0.eyJ<...>In0.fh0<...>-WKA"

# Split the token into its encoded components
[header,payload,verify] = token.split(".")
```

--------------------------------

### Example EVE SSO JWT Token Payload

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/validating_eve_jwt

A typical payload structure for a JWT token issued by the EVE Online SSO, illustrating the various claims such as scopes (scp), unique identifier (jti), key ID (kid), subject (sub), authorized party (azp), tenant, tier, region, audience (aud), name, owner, expiration (exp), issued at (iat), and issuer (iss).

```json
{
  "scp": [
    "esi-skills.read_skills.v1",
    "esi-skills.read_skillqueue.v1"
  ],
  "jti": "998e12c7-3241-43c5-8355-2c48822e0a1b",
  "kid": "JWT-Signature-Key",
  "sub": "CHARACTER:EVE:123123",
  "azp": "my3rdpartyclientid",
  "tenant": "tranquility",
  "tier": "live",
  "region": "world",
  "aud": ["my3rdpartyclientid", "EVE Online"],
  "name": "Some Bloke",
  "owner": "8PmzCeTKb4VFUDrHLc/AeZXDSWM=",
  "exp": 1648563218,
  "iat": 1648562018,
  "iss": "login.eveonline.com"
}
```

--------------------------------

### Opportunities API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides API endpoints for retrieving information about opportunities, including groups and specific tasks.

```APIDOC
/opportunities/groups/
```

```APIDOC
/opportunities/groups/{groupID:integerType}/
```

```APIDOC
/opportunities/tasks/
```

```APIDOC
/opportunities/tasks/{taskID:integerType}/
```

--------------------------------

### EVE SSO OAuth 2.0 PKCE Authorization Request Parameters

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/native_sso_flow

Details the required query parameters for initiating the OAuth 2.0 PKCE authorization flow with EVE SSO for native applications. Each parameter's purpose, expected format, and security implications are explained.

```APIDOC
response_type: code
  Description: Specifies the expected response type, indicating an authorization code handshake.
redirect_uri: <your application's defined callback>
  Description: The full callback URL defined for your application, URL encoded. Must match the SSO application's registered URL.
client_id: <your application's client ID>
  Description: The client ID assigned to your application by EVE SSO.
scope: <A URL encoded, space delimited list of ESI scopes you would like to request permissions for>
  Description: A space-delimited list of ESI scopes, URL encoded, for which your application requests permissions.
code_challenge: <base64url(SHA-256(code verifier))>
  Description: A code challenge derived from a one-time use code verifier (32 random bytes, base64url encoded), then SHA-256 hashed and base64url encoded. Used in PKCE to protect against secret key exposure.
code_challenge_method: S256
  Description: Indicates that the code challenge was hashed using SHA-256, currently the only accepted method.
state: <something-unique>
  Description: A unique string chosen by your application for security, required by EVE SSO to prevent CSRF attacks.
```

--------------------------------

### ESI Multi-Tenancy and Data Source Configuration

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/esi_introduction

Explains ESI's multi-tenant design, allowing users to change the 'datasource' query parameter on any route to query different server names. It details the three ESI environments: esi-dev, esi-test, and production esi, and how developers can query local development servers.

```APIDOC
Fundamentals:
  Multi-tenant to the core:
    Description: Single interface for all EVE information.
    Configuration: Change 'datasource' query parameter on any route (including /swagger.json) to desired server name.
    Environments:
      - esi-dev
      - esi-test
      - production esi
    UI Representation: Select menu in header/nav bar, datasource enum in spec.
```

--------------------------------

### Wars API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Lists API endpoints for accessing war-related data, including general war information and killmails associated with specific wars.

```APIDOC
/wars/
```

```APIDOC
/wars/{warID:integerType}/
```

```APIDOC
/wars/{warID:integerType}/killmails/all/
```

--------------------------------

### Character UI Interaction API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for interacting with the EVE Online client UI on behalf of a character, such as opening specific windows or setting autopilot waypoints.

```APIDOC
/characters/{characterID:characterIdType}/ui/openwindow/contract/
  https://esi.evetech.net/ui/?version=latest#/User32Interface/post_ui_openwindow_contract

/characters/{characterID:characterIdType}/ui/openwindow/marketdetails/
  https://esi.evetech.net/ui/?version=latest#/User32Interface/post_ui_openwindow_marketdetails

/characters/{characterID:characterIdType}/ui/openwindow/newmail/
  https://esi.evetech.net/ui/?version=latest#/User32Interface/post_ui_openwindow_newmail

/characters/{characterID:characterIdType}/ui/openwindow/ownerdetails/
  https://esi.evetech.net/ui/?version=latest#/User32Interface/post_ui_openwindow_information

/characters/{characterID:characterIdType}/ui/autopilot/waypoints/
  https://esi.evetech.net/ui/?version=latest#/User32Interface/post_ui_autopilot_waypoint
```

--------------------------------

### ESI Individual Route Versioning and Deprecation

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/esi_introduction

Explains ESI's unique approach to versioning, where each route is versioned individually rather than a global API version. It describes the three complete APIs (/dev/, /latest/, /legacy/) and numbered paths (e.g., /v1/). It also covers how changes are announced, how previous versions become /legacy/, and the use of 'warning: 199' and 'warning: 299' headers for updates and deprecation, respectively.

```APIDOC
Fundamentals:
  Versioning:
    API Version (ESI-lib): Defined in spec, mostly irrelevant to API consumers.
    Route Versioning: Each route versioned individually.
    Available APIs:
      - /dev/: Can change at any point.
      - /latest/: Changes announced; previous /latest/ becomes /legacy/.
      - /legacy/: Previous /latest/ version.
    Numbered Paths: Routes start with /v1/ (e.g., /v1/hello/<string>/).
    Deprecation:
      Indicator: Line through endpoint in Swagger UI, 'warning: 299' header.
      Purpose: Broadcasts intent to delete route; may include alternate source.
      Action: Move away immediately.
    Updates:
      Indicator: 'warning: 199' header if a newer version is available.
    Swagger UI Access:
      - Browse via /dev/, /latest/, or /legacy/.
      - /v1/swagger.json (or other numbered versions) can be fed into own Swagger UI for overview.
    Route Path Convention: All ESI routes end with a '/', except /<version>/swagger.json and Swagger UI internal routes.
```

--------------------------------

### EVE Online ESI Wars API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Details API endpoints for retrieving war-related information in EVE Online, including general war listings, specific war details, and associated killmails. Each endpoint is linked to its interactive documentation in the ESI UI.

```APIDOC
/wars/
  UI: https://esi.evetech.net/ui/?version=latest#/Wars/get_wars
```

```APIDOC
/wars/{warID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Wars/get_wars_war_id
```

```APIDOC
/wars/{warID:integerType}/killmails/all/
  UI: https://esi.evetech.net/ui/?version=latest#/Wars/get_wars_war_id_killmails
```

--------------------------------

### Killmails API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides API endpoints for retrieving killmail details using a kill ID and hash.

```APIDOC
/killmails/{killID:integerType}/{killHash:stringType}/
```

--------------------------------

### Character Fittings API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for managing a character's ship fittings, including retrieving current fittings, adding new ones, and deleting existing fittings.

```APIDOC
/characters/{characterID:characterIdType}/fittings/
  https://esi.evetech.net/ui/?version=latest#/Fittings/get_characters_character_id_fittings
  https://esi.evetech.net/ui/?version=latest#/Fittings/post_characters_character_id_fittings

/characters/{characterID:characterIdType}/fittings/{fittingID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Fittings/delete_characters_character_id_fittings_fitting_id
```

--------------------------------

### ESI API Overview and Access

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/esi_introduction

Describes the EVE Swagger Interface (ESI) as the official RESTful API for EVE third-party development, highlighting its use of Swagger for documentation and the availability of a UI to explore endpoints.

```APIDOC
ESI (EVE Swagger Interface)
  Description: Official RESTful API for EVE third party development.
  Technology: Leverages Swagger for documentation.
  UI Access: https://esi.evetech.net/ui/
```

--------------------------------

### Sovereignty API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Lists API endpoints for accessing sovereignty-related data, such as campaigns and structures.

```APIDOC
/sovereignty/campaigns/
```

```APIDOC
/sovereignty/structures/
```

--------------------------------

### Character Opportunities API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve a character's completed and available opportunities.

```APIDOC
/characters/{characterID:characterIdType}/opportunities/
  https://esi.evetech.net/ui/?version=latest#/Opportunities/get_characters_character_id_opportunities
```

--------------------------------

### Tournaments API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Offers a comprehensive set of API endpoints for tournament data, including general tournament information, series, matches, bans, pilot statistics, real-time frames, static data, and team details.

```APIDOC
/tournaments/
```

```APIDOC
/tournaments/{tournamentID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/pilots/{pilotID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/bans/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/pilotstats/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/realtime/{frameID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/static/
```

```APIDOC
/tournaments/{tournamentID:integerType}/teams/{teamID:integerType}/
```

```APIDOC
/tournaments/teams/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/members/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/members/{memberID:integerType}/
```

--------------------------------

### Market API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Lists API endpoints for accessing market-related data, including groups, types, historical data, and various order types (all, buy, sell) within specific regions, as well as global market prices.

```APIDOC
/market/groups/
```

```APIDOC
/market/groups/{groupID:integerType}/
```

```APIDOC
/market/types/
```

```APIDOC
/market/types/{marketTypeID:integerType}/
```

```APIDOC
/market/{regionID:integerType}/history/
```

```APIDOC
/market/{regionID:integerType}/orders/all/
```

```APIDOC
/market/{regionID:integerType}/orders/
```

```APIDOC
/market/{regionID:integerType}/orders/buy/
```

```APIDOC
/market/{regionID:integerType}/orders/sell/
```

```APIDOC
/market/prices/
```

--------------------------------

### Corporation Loyalty Points Offers API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve loyalty store offers for a specific corporation, detailing items available for loyalty points.

```APIDOC
/loyaltypoints/{corporationID:corporationIdType}/
  https://esi.evetech.net/ui/?version=latest#/Loyalty/get_loyalty_stores_corporation_id_offers
```

--------------------------------

### Alliances API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for retrieving information about alliances, including a list of all alliances and details for a specific alliance ID.

```APIDOC
/alliances/
  https://esi.evetech.net/ui/?version=latest#/Alliance/get_alliances

/alliances/{allianceID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Alliance/get_alliances_alliance_id
```

--------------------------------

### Structures API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides an API endpoint for retrieving details about specific structures using their ID.

```APIDOC
/structures/{structID:integerType}/
```

--------------------------------

### Universe API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides API endpoints for retrieving various universe-related data, including constellations, locations, moons, planets, regions, stargates, stations, and solar systems.

```APIDOC
/constellations/
```

```APIDOC
/constellations/{constellationID:integerType}/
```

```APIDOC
/universe/locations/{locationID:integerType}/
```

```APIDOC
/moons/{moonID:integerType}/
```

```APIDOC
/planets/{planetID:integerType}/
```

```APIDOC
/regions/
```

```APIDOC
/regions/{regionID:integerType}/
```

```APIDOC
/stargates/{stargateID:integerType}/
```

```APIDOC
/stations/{stationID:integerType}/
```

```APIDOC
/solarsystems/
```

```APIDOC
/solarsystems/{solarSystemID:integerType}/
```

--------------------------------

### Factions API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides an API endpoint for retrieving details about a specific faction using its ID.

```APIDOC
/factions/{factionID:integerType}/
```

--------------------------------

### EVE Online ESI Universe API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides API endpoints for retrieving static universe data in EVE Online, such as constellations, moons, planets, regions, stargates, stations, and solar systems. Each endpoint is linked to its interactive documentation in the ESI UI.

```APIDOC
/constellations/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_constellations
```

```APIDOC
/constellations/{constellationID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_constellations_constellation_id
```

```APIDOC
/universe/locations/{locationID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_stations_station_id
```

```APIDOC
/moons/{moonID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_moons_moon_id
```

```APIDOC
/planets/{planetID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_planets_planet_id
```

```APIDOC
/regions/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_regions
```

```APIDOC
/regions/{regionID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_regions_region_id
```

```APIDOC
/stargates/{stargateID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_stargates_stargate_id
```

```APIDOC
/stations/{stationID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_stations_station_id
```

```APIDOC
/solarsystems/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_systems
```

```APIDOC
/solarsystems/{solarSystemID:integerType}/
  UI: https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_systems_system_id
```

--------------------------------

### Corporations API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for retrieving various corporation-related information, including general details, structures, loyalty store offers, and NPC corporations.

```APIDOC
/corporations/{corporationID:corporationIdType}/
  https://esi.evetech.net/ui/?version=latest#/Corporation/get_corporations_corporation_id

/corporations/{corporationID:corporationIdType}/structures/
  https://esi.evetech.net/ui/?version=latest#/Corporation/get_corporations_corporation_id_structures

/corporations/{corporationID:corporationIdType}/loyaltystore/
  https://esi.evetech.net/ui/?version=latest#/Loyalty/get_loyalty_stores_corporation_id_offers

/corporations/npccorps/
  https://esi.evetech.net/ui/?version=latest#/Corporation/get_corporations_npccorps
```

--------------------------------

### Universe Graphics API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for retrieving information about universe graphics, including a list of all graphic IDs and details for a specific graphic ID.

```APIDOC
/graphicids/
  https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_graphics

/graphicids/{graphicID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_graphics_graphic_id
```

--------------------------------

### EVE Online ESI Tournaments API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Lists API endpoints for accessing tournament-related data in EVE Online, including general tournament information, specific tournament details, pilot statistics, series, matches, bans, and team information.

```APIDOC
/tournaments/
```

```APIDOC
/tournaments/{tournamentID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/pilots/{pilotID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/bans/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/pilotstats/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/realtime/{frameID:integerType}/
```

```APIDOC
/tournaments/{tournamentID:integerType}/series/{seriesID:integerType}/matches/{matchID:integerType}/static/
```

```APIDOC
/tournaments/{tournamentID:integerType}/teams/{teamID:integerType}/
```

```APIDOC
/tournaments/teams/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/members/
```

```APIDOC
/tournaments/teams/{teamID:integerType}/members/{memberID:integerType}/
```

--------------------------------

### API Endpoint: Fleet Wing Squads Creation

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Allows for the creation of new squads within a specific fleet wing. This endpoint supports POST operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/wings/{wingID:integerType}/squads/
  POST
```

--------------------------------

### Universe Races API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for retrieving information about the various races in the EVE Online universe, including a list of all races and details for a specific race ID.

```APIDOC
/races/
  https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_races

/races/{raceID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Universe/get_universe_races
```

--------------------------------

### Dogma API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for accessing EVE Online's Dogma system, which defines attributes and effects of items and modules, including lists of attributes/effects and details for specific IDs.

```APIDOC
/dogma/attributes/
  https://esi.evetech.net/ui/?version=latest#/Dogma/get_dogma_attributes

/dogma/attributes/{attributeID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Dogma/get_dogma_attributes_attribute_id

/dogma/effects/
  https://esi.evetech.net/ui/?version=latest#/Dogma/get_dogma_effects

/dogma/effects/{effectID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Dogma/get_dogma_effects_effect_id
```

--------------------------------

### Characters API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for retrieving general character information, including resolving character IDs to names and fetching details or portraits for a specific character.

```APIDOC
/characters/
  https://esi.evetech.net/ui/?version=latest#/Universe/post_universe_names

/characters/{characterID:characterIdType}/
  https://esi.evetech.net/ui/?version=latest#/Character/get_characters_character_id
  https://esi.evetech.net/ui/?version=latest#/Character/get_characters_character_id_portrait
```

--------------------------------

### Character Ship API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve information about the ship a character is currently piloting.

```APIDOC
/characters/{characterID:characterIdType}/ship/
  https://esi.evetech.net/ui/?version=latest#/Location/get_characters_character_id_ship
```

--------------------------------

### Character Loyalty Points API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve the loyalty points balance for a specific character.

```APIDOC
/characters/{characterID:characterIdType}/loyaltypoints/
  https://esi.evetech.net/ui/?version=latest#/Loyalty/get_characters_character_id_loyalty_points
```

--------------------------------

### Bloodlines API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Provides API endpoints for retrieving information about bloodlines, including a list of all bloodlines or details for a specific bloodline ID.

```APIDOC
/bloodlines/
```

```APIDOC
/bloodlines/{bloodlineID:integerType}/
```

--------------------------------

### Server Time API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint for retrieving the current server time. Note: The original document indicates this endpoint might not be needed.

```APIDOC
/time/
  Not needed?
```

--------------------------------

### Character Contacts API Endpoints

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoints for managing a character's contacts, including retrieving, adding, updating, and deleting contacts.

```APIDOC
/characters/{characterID:characterIdType}/contacts/
  https://esi.evetech.net/ui/?version=latest#/Contacts/get_characters_character_id_contacts
  https://esi.evetech.net/ui/?version=latest#/Contacts/post_characters_character_id_contacts

/characters/{characterID:characterIdType}/contacts/{contactID:integerType}/
  https://esi.evetech.net/ui/?version=latest#/Contacts/put_characters_character_id_contacts
  https://esi.evetech.net/ui/?version=latest#/Contacts/delete_characters_character_id_contacts
```

--------------------------------

### Insurance Prices API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve current insurance prices for various ship types in EVE Online.

```APIDOC
/insuranceprices/
  https://esi.evetech.net/ui/?version=latest#/Insurance/get_insurance_prices
```

--------------------------------

### ESI HTTP Warning Response Header Specification

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/warning_header

Details the structure and meaning of the HTTP `Warning` header returned by ESI, including specific warning codes and their associated messages and implications for API consumers.

```APIDOC
HTTP Header: Warning
Purpose: Provides important information regarding the status of the requested ESI route, such as deprecation or available upgrades.

Warning Types:
  - Code: 299
    Description: Deprecated Route
    Default Message: "299 - This route is deprecated."
    Implication: The requested route is deprecated and may be removed. Developers should update their applications to use a newer version of the route as soon as possible to avoid 404 errors.

  - Code: 199
    Description: Route Upgrade Available
    Default Message: "199 - This route has an upgrade available."
    Implication: An updated version of the requested route is available. Developers should check the changelog and consider updating their applications to take advantage of new features or changes before the upgrade is promoted to 'latest'.
```

--------------------------------

### ESI Authentication via SSO

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/esi_introduction

Details how authentication for ESI is handled by SSO, including the use of new scopes. It explains how to identify required scopes in the Swagger UI and how ESI redirects authentication headers. It also notes that SSO is not multi-tenant, requiring separate app keys for each SSO backend.

```APIDOC
Fundamentals:
  Authentication:
    Method: Handled by SSO (Single Sign-On).
    Scopes: New scopes used by ESI; create/alter developer keys.
    Requirement Indicator: Gray lock icon on route description in Swagger UI (mouse hover reveals scope).
    Header Handling: ESI redirects authentication header to correct SSO based on datasource.
    SSO Multi-tenancy: SSO is NOT multi-tenant; requires app keys on each SSO backend.
```

--------------------------------

### Querying Individual EVE Online Structure Markets API

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/scenarios/structure_markets

This API endpoint allows retrieval of all market orders within a single Upwell structure. It requires an authenticated character with docking access to the structure and the 'esi-markets.structure_markets.v1' scope. The endpoint returns all orders without filtering and supports pagination via the 'page' query parameter and 'X-Pages' header.

```APIDOC
Endpoint: GET /markets/structures/{structure_id}/
Description: Retrieve market orders for a single Upwell structure.

Authentication:
  Type: Access Token
  Scope: esi-markets.structure_markets.v1
  Requirement: Character must have docking access to the structure.

Path Parameters:
  structure_id: integer
    Description: The ID of the Upwell structure.

Query Parameters:
  page: integer (optional)
    Description: Page number to retrieve. Used for pagination.

Response Headers:
  X-Pages: integer
    Description: Total number of pages available for the response.

Behavior:
  - Returns all orders in the specified structure.
  - Does not support filtering by order type or type ID.
  - Multiple requests may be necessary to retrieve all orders due to pagination.
```

--------------------------------

### Character Location API Endpoint

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

API endpoint to retrieve the current location of a specific character.

```APIDOC
/characters/{characterID:characterIdType}/location/
  https://esi.evetech.net/ui/?version=latest#/Location/get_characters_character_id_location
```

--------------------------------

### API Endpoint: Structure Modification

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Allows for the modification of a specific structure by its ID. This endpoint supports PUT operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/structures/{structID:integerType}/
  PUT
```

--------------------------------

### Python: Decode and Parse URL-Safe Base64 JWT Payload

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/migrate_v1_v2

This Python snippet demonstrates the process of decoding a URL-safe base64 encoded JWT payload. It includes padding the payload to ensure it's a multiple of 4 bytes, performing the base64 decoding, and then parsing the resulting byte string as a JSON object into a Python dictionary. This is a crucial step for accessing the token's claims.

```Python
padded = payload + "="*(-len(payload) % 4)
decoded = urlsafe_b64decode(padded)
data = json.loads(decoded)
```

--------------------------------

### API Endpoint: Specific Fleet Wing Squad Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Manages a specific squad within a fleet wing, allowing for its removal or modification. This endpoint supports DELETE and PUT operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/wings/{wingID:integerType}/squads/{squadID:integerType}/
  DELETE
  PUT
```

--------------------------------

### API Endpoint: Specific Fleet Wing Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Manages a specific wing within a fleet, allowing for its removal or modification. This endpoint supports DELETE and PUT operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/wings/{wingID:integerType}/
  DELETE
  PUT
```

--------------------------------

### Constructing EVE SSO OAuth 2.0 Authorization Request URL

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/web_based_sso_flow

This URL is used to redirect the user to the EVE SSO login page to initiate the authorization process. It includes essential query parameters such as response_type, redirect_uri, client_id, scope, and a unique state parameter for security.

```URL
https://login.eveonline.com/v2/oauth/authorize/?response_type=code&redirect_uri=https%3A%2F%2Flocalhost%2Fcallback%2F&client_id=<your-client-id>&scope=esi-characters.read_blueprints.v1&state=<unique-string>
```

--------------------------------

### Calculate Skillpoints Gained Per Minute

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/useful_formulae

Formula for calculating the rate of skillpoint gain per minute. This rate depends on the primary and secondary attributes associated with the skill, providing insight into training efficiency.

```Formula
y_{skillpointsPerMinute} = a_{primary} + {a_{secondary} \over 2}
```

--------------------------------

### Add Authorization Header to ESI Requests

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/sending_esi_auth_request

This snippet illustrates the required format for the Authorization header when making authenticated requests to ESI. The '<access token>' placeholder must be replaced with the actual valid access token obtained from EVE's SSO.

```HTTP
Authorization: Bearer <access token>
```

--------------------------------

### Discover Corporation Upwell Structures (ESI API)

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/scenarios/resolve_structure_ids

Explains the authenticated ESI endpoint for retrieving all structures owned by a specific corporation. Provides detailed information about the structure, including services, fuel expiration, and state, but currently does not include the structure's name. Requires `esi-corporations.read_structures.v1` scope and Director role.

```APIDOC
Endpoint: GET /corporations/{corporation_id}/structures/
Authentication: Required (token with esi-corporations.read_structures.v1 scope)
Parameters:
  corporation_id: int32 (Path Parameter) - The ID of the corporation.
Returns:
  List of Structure Objects:
    - services: List of service details
    - fuel_expires: datetime
    - state: string
    ... (other details, but NOT structure name)
Requirements: Character with Director role in the corporation.
```

--------------------------------

### ESI Caching Headers

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/esi_introduction

Headers related to ESI's caching mechanism, indicating when new data will be available and when the data was last updated. Clients should respect these headers to avoid wasting resources or circumventing caching, which can lead to bans.

```APIDOC
`expires`: when new data is available.
`last-modified`: when the data was last updated
```

--------------------------------

### Resolve Structure IDs via ESI

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/asset_location_id

Structure IDs can be resolved using the ESI structure endpoint (requires docking rights) or the ESI bookmark endpoint (for bookmarked structures, regardless of docking rights).

```APIDOC
ESI structure endpoint: https://esi.evetech.net/ui/#/Universe/get_universe_structures_structure_id
ESI bookmark endpoint: https://esi.evetech.net/ui/#/Bookmarks/get_characters_character_id_bookmarks
```

--------------------------------

### Python: Reformat Decoded JWT Data for EVE Online OAuth Verification

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/migrate_v1_v2

This Python code block illustrates how to transform the previously decoded JWT data into a specific JSON structure that aligns with the requirements of EVE Online's /oauth/verify endpoint. It extracts and maps various claims such as CharacterID, CharacterName, Expiration (converted to ISO format), Scopes, and ClientID from the data dictionary, preparing it for further API calls.

```Python
from datetime import datetime

{
  "CharacterID": data["sub"].split(":")[2],
  "CharacterName": data["name"],
  "ExpiresOn": datetime.fromtimestamp(data["exp"]).isoformat(),
  "Scopes": data["scp"],
  "TokenType": "JWT",
  "CharacterOwnerHash": data["owner"],
  "ClientID": data["azp"]
}
```

--------------------------------

### Required HTTP Headers for OAuth Token Exchange

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/native_sso_flow

These are the essential HTTP headers that must be included in the POST request to the EVE SSO token endpoint. They specify the content type of the request body and the target host for the authentication server.

```HTTP
Content-Type: application/x-www-form-urlencoded
Host: login.eveonline.com
```

--------------------------------

### API Endpoint: Specific Fleet Member Management

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/CREST_to_ESI

Manages a specific member within a fleet, allowing for their removal or modification. This endpoint supports DELETE and PUT operations. Refer to the linked Swagger UI for detailed parameters and responses.

```APIDOC
/fleets/{fleetID:integerType}/members/{memberID:characterIdType}/
  DELETE
  PUT
```

--------------------------------

### Migrating Python Requests for SSO v2 Token Requests

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/sso/migrate_v1_v2

This snippet demonstrates how to update Python `requests` calls for the `/oauth/token` endpoint when migrating to EVE SSO v2. It shows the change from sending payload as JSON to using form-urlencoded data, which is required by SSO v2.

```Python
payload = {"client_id": 12345678, grant_type: "authorization_code" [...]}

# From this
- requests.post("https://login.eveonline.com/oauth/token", json=payload)

# To this
+ requests.post("https://login.eveonline.com/v2/oauth/token", data=payload)
```

--------------------------------

### Resolve Upwell Structure ID to Name (ESI API)

Source: https://docs.esi.evetech.net/docs/esi_introduction.html/docs/scenarios/resolve_structure_ids

Details the authenticated ESI endpoint for resolving an Upwell structure ID into its name and other details like system ID, type ID, and owner corporation ID. Requires `esi-universe.read_structures.v1` scope and docking access.

```APIDOC
Endpoint: GET /universe/structures/{structure_id}/
Authentication: Required (token with esi-universe.read_structures.v1 scope)
Parameters:
  structure_id: int64 (Path Parameter) - The ID of the Upwell structure.
Returns:
  name: string - The name of the structure.
  system_id: int32 - The ID of the system the structure is in.
  type_id: int32 - The type ID of the structure.
  owner_corporation_id: int32 - The ID of the owning corporation.
Requirements: Character with docking access to the structure.
```
Tokens:
Raw