tschwery/eve-goclient
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
This repository has been archived on 2025-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
eve-goclient/esi_swagger.json

18980 lines
666 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"basePath": "/latest",
"host": "esi.tech.ccp.is",
"info": {
"description": "An OpenAPI for EVE Online",
"title": "EVE Swagger Interface",
"version": "0.4.1.dev1"
},
"paths": {
"/alliances/": {
"get": {
"description": "List all active player alliances\n\n---\n\nAlternate route: `/v1/alliances/`\n\nAlternate route: `/legacy/alliances/`\n\nAlternate route: `/dev/alliances/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_alliances",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of Alliance IDs",
"examples": {
"application/json": [
99000001,
99000002
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"minimum": 0,
"title": "get_alliances_200_ok",
"type": "integer",
"uniqueItems": true
},
"title": "get_alliances_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_alliances_500_internal_server_error",
"type": "string"
}
},
"title": "get_alliances_internal_server_error",
"type": "object"
}
}
},
"summary": "List all alliances",
"tags": [
"Alliance"
]
}
},
"/alliances/names/": {
"get": {
"description": "Resolve a set of alliance IDs to alliance names\n\n---\n\nAlternate route: `/v1/alliances/names/`\n\nAlternate route: `/legacy/alliances/names/`\n\nAlternate route: `/dev/alliances/names/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_alliances_names",
"parameters": [
{
"description": "A comma separated list of alliance IDs",
"in": "query",
"items": {
"format": "int64",
"type": "integer"
},
"minItems": 1,
"name": "alliance_ids",
"required": true,
"type": "array"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of id/name associations",
"examples": {
"application/json": [
{
"alliance_id": 1000171,
"alliance_name": "Republic University"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"alliance_id": {
"description": "alliance_id integer",
"format": "int32",
"title": "get_alliances_names_alliance_id",
"type": "integer"
},
"alliance_name": {
"description": "alliance_name string",
"title": "get_alliances_names_alliance_name",
"type": "string"
}
},
"required": [
"alliance_id",
"alliance_name"
],
"title": "get_alliances_names_200_ok",
"type": "object"
},
"title": "get_alliances_names_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_alliances_names_500_internal_server_error",
"type": "string"
}
},
"title": "get_alliances_names_internal_server_error",
"type": "object"
}
}
},
"summary": "Get alliance names",
"tags": [
"Alliance"
]
}
},
"/alliances/{alliance_id}/": {
"get": {
"description": "Public information about an alliance\n\n---\n\nAlternate route: `/v2/alliances/{alliance_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_alliances_alliance_id",
"parameters": [
{
"description": "An Eve alliance ID",
"format": "int32",
"in": "path",
"name": "alliance_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Public data about an alliance",
"examples": {
"application/json": {
"alliance_name": "C C P Alliance",
"date_founded": "2016-06-26T21:00:00Z",
"executor_corp": 98356193,
"ticker": "<C C P>"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"alliance_name": {
"description": "the full name of the alliance",
"title": "get_alliances_alliance_id_alliance_name",
"type": "string"
},
"date_founded": {
"description": "date_founded string",
"format": "date-time",
"title": "get_alliances_alliance_id_date_founded",
"type": "string"
},
"executor_corp": {
"description": "the executor corporation ID, if this alliance is not closed",
"format": "int32",
"title": "get_alliances_alliance_id_executor_corp",
"type": "integer"
},
"ticker": {
"description": "the short name of the alliance",
"title": "get_alliances_alliance_id_ticker",
"type": "string"
}
},
"required": [
"alliance_name",
"ticker",
"date_founded"
],
"title": "get_alliances_alliance_id_ok",
"type": "object"
}
},
"404": {
"description": "Alliance not found",
"examples": {
"application/json": {
"error": "Alliance not found"
}
},
"schema": {
"description": "Alliance not found",
"properties": {
"error": {
"description": "error message",
"title": "get_alliances_alliance_id_error",
"type": "string"
}
},
"title": "get_alliances_alliance_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_alliances_alliance_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_alliances_alliance_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get alliance information",
"tags": [
"Alliance"
]
}
},
"/alliances/{alliance_id}/corporations/": {
"get": {
"description": "List all current member corporations of an alliance\n\n---\n\nAlternate route: `/v1/alliances/{alliance_id}/corporations/`\n\nAlternate route: `/legacy/alliances/{alliance_id}/corporations/`\n\nAlternate route: `/dev/alliances/{alliance_id}/corporations/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_alliances_alliance_id_corporations",
"parameters": [
{
"description": "An EVE alliance ID",
"format": "int32",
"in": "path",
"name": "alliance_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of corporation IDs",
"examples": {
"application/json": [
98000001
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"minimum": 0,
"title": "get_alliances_alliance_id_corporations_200_ok",
"type": "integer",
"uniqueItems": true
},
"title": "get_alliances_alliance_id_corporations_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_alliances_alliance_id_corporations_500_internal_server_error",
"type": "string"
}
},
"title": "get_alliances_alliance_id_corporations_internal_server_error",
"type": "object"
}
}
},
"summary": "List alliance's corporations",
"tags": [
"Alliance"
]
}
},
"/alliances/{alliance_id}/icons/": {
"get": {
"description": "Get the icon urls for a alliance\n\n---\n\nAlternate route: `/v1/alliances/{alliance_id}/icons/`\n\nAlternate route: `/legacy/alliances/{alliance_id}/icons/`\n\nAlternate route: `/dev/alliances/{alliance_id}/icons/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_alliances_alliance_id_icons",
"parameters": [
{
"description": "An EVE alliance ID",
"format": "int32",
"in": "path",
"name": "alliance_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Urls for icons for the given alliance id and server",
"examples": {
"application/json": {
"px128x128": "https://imageserver.eveonline.com/Alliance/503818424_128.png",
"px64x64": "https://imageserver.eveonline.com/Alliance/503818424_64.png"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"px128x128": {
"description": "px128x128 string",
"title": "get_alliances_alliance_id_icons_px128x128",
"type": "string"
},
"px64x64": {
"description": "px64x64 string",
"title": "get_alliances_alliance_id_icons_px64x64",
"type": "string"
}
},
"title": "get_alliances_alliance_id_icons_ok",
"type": "object"
}
},
"404": {
"description": "No image server for this datasource",
"examples": {
"application/json": {
"error": "No image server for this datasource"
}
},
"schema": {
"description": "No image server for this datasource",
"properties": {
"error": {
"description": "error message",
"title": "get_alliances_alliance_id_icons_error",
"type": "string"
}
},
"title": "get_alliances_alliance_id_icons_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_alliances_alliance_id_icons_500_internal_server_error",
"type": "string"
}
},
"title": "get_alliances_alliance_id_icons_internal_server_error",
"type": "object"
}
}
},
"summary": "Get alliance icon",
"tags": [
"Alliance"
]
}
},
"/characters/names/": {
"get": {
"description": "Resolve a set of character IDs to character names\n\n---\n\nAlternate route: `/v1/characters/names/`\n\nAlternate route: `/legacy/characters/names/`\n\nAlternate route: `/dev/characters/names/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_names",
"parameters": [
{
"description": "A comma separated list of character IDs",
"in": "query",
"items": {
"format": "int64",
"type": "integer"
},
"minItems": 1,
"name": "character_ids",
"required": true,
"type": "array"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of id/name associations",
"examples": {
"application/json": [
{
"character_id": 95465499,
"character_name": "CCP Bartender"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"character_id": {
"description": "character_id integer",
"format": "int64",
"title": "get_characters_names_character_id",
"type": "integer"
},
"character_name": {
"description": "character_name string",
"title": "get_characters_names_character_name",
"type": "string"
}
},
"required": [
"character_id",
"character_name"
],
"title": "get_characters_names_200_ok",
"type": "object"
},
"title": "get_characters_names_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_names_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_names_internal_server_error",
"type": "object"
}
}
},
"summary": "Get character names",
"tags": [
"Character"
]
}
},
"/characters/{character_id}/": {
"get": {
"description": "Public information about a character\n\n---\n\nAlternate route: `/v4/characters/{character_id}/`\n\nAlternate route: `/dev/characters/{character_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Public data for the given character",
"examples": {
"application/json": {
"ancestry_id": 19,
"birthday": "2015-03-24T11:37:00Z",
"bloodline_id": 3,
"corporation_id": 109299958,
"description": "",
"gender": "male",
"name": "CCP Bartender",
"race_id": 2
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"alliance_id": {
"description": "The character's alliance ID",
"format": "int32",
"title": "get_characters_character_id_alliance_id",
"type": "integer"
},
"ancestry_id": {
"description": "ancestry_id integer",
"format": "int32",
"title": "get_characters_character_id_ancestry_id",
"type": "integer"
},
"birthday": {
"description": "Creation date of the character",
"format": "date-time",
"title": "get_characters_character_id_birthday",
"type": "string"
},
"bloodline_id": {
"description": "bloodline_id integer",
"format": "int32",
"title": "get_characters_character_id_bloodline_id",
"type": "integer"
},
"corporation_id": {
"description": "The character's corporation ID",
"format": "int32",
"title": "get_characters_character_id_corporation_id",
"type": "integer"
},
"description": {
"description": "description string",
"title": "get_characters_character_id_description",
"type": "string"
},
"gender": {
"description": "gender string",
"enum": [
"female",
"male"
],
"title": "get_characters_character_id_gender",
"type": "string"
},
"name": {
"description": "name string",
"title": "get_characters_character_id_name",
"type": "string"
},
"race_id": {
"description": "race_id integer",
"format": "int32",
"title": "get_characters_character_id_race_id",
"type": "integer"
},
"security_status": {
"description": "security_status number",
"format": "float",
"maximum": 10,
"minimum": -10,
"title": "get_characters_character_id_security_status",
"type": "number"
}
},
"required": [
"corporation_id",
"birthday",
"name",
"gender",
"race_id",
"bloodline_id"
],
"title": "get_characters_character_id_ok",
"type": "object"
}
},
"404": {
"description": "Character not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_characters_character_id_404_not_found",
"type": "string"
}
},
"title": "get_characters_character_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get character's public information",
"tags": [
"Character"
]
}
},
"/characters/{character_id}/assets/": {
"get": {
"description": "Return a list of the characters assets\n\n---\n\nAlternate route: `/v1/characters/{character_id}/assets/`\n\nAlternate route: `/legacy/characters/{character_id}/assets/`\n\nAlternate route: `/dev/characters/{character_id}/assets/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_assets",
"parameters": [
{
"description": "Character id of the target character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A flat list of the users assets",
"examples": {
"application/json": [
{
"is_singleton": true,
"item_id": 1000000016835,
"location_flag": "Hangar",
"location_id": 60002959,
"location_type": "station",
"type_id": 3516
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"is_singleton": {
"description": "is_singleton boolean",
"title": "get_characters_character_id_assets_is_singleton",
"type": "boolean"
},
"item_id": {
"description": "item_id integer",
"format": "int64",
"title": "get_characters_character_id_assets_item_id",
"type": "integer"
},
"location_flag": {
"description": "location_flag string",
"enum": [
"AutoFit",
"Cargo",
"CorpseBay",
"DroneBay",
"FleetHangar",
"Deliveries",
"HiddenModifiers",
"Hangar",
"HangarAll",
"LoSlot0",
"LoSlot1",
"LoSlot2",
"LoSlot3",
"LoSlot4",
"LoSlot5",
"LoSlot6",
"LoSlot7",
"MedSlot0",
"MedSlot1",
"MedSlot2",
"MedSlot3",
"MedSlot4",
"MedSlot5",
"MedSlot6",
"MedSlot7",
"HiSlot0",
"HiSlot1",
"HiSlot2",
"HiSlot3",
"HiSlot4",
"HiSlot5",
"HiSlot6",
"HiSlot7",
"AssetSafety",
"Locked",
"Unlocked",
"Implant",
"QuafeBay",
"RigSlot0",
"RigSlot1",
"RigSlot2",
"RigSlot3",
"RigSlot4",
"RigSlot5",
"RigSlot6",
"RigSlot7",
"ShipHangar",
"SpecializedFuelBay",
"SpecializedOreHold",
"SpecializedGasHold",
"SpecializedMineralHold",
"SpecializedSalvageHold",
"SpecializedShipHold",
"SpecializedSmallShipHold",
"SpecializedMediumShipHold",
"SpecializedLargeShipHold",
"SpecializedIndustrialShipHold",
"SpecializedAmmoHold",
"SpecializedCommandCenterHold",
"SpecializedPlanetaryCommoditiesHold",
"SpecializedMaterialBay",
"SubSystemSlot0",
"SubSystemSlot1",
"SubSystemSlot2",
"SubSystemSlot3",
"SubSystemSlot4",
"SubSystemSlot5",
"SubSystemSlot6",
"SubSystemSlot7",
"FighterBay",
"FighterTube0",
"FighterTube1",
"FighterTube2",
"FighterTube3",
"FighterTube4",
"Module"
],
"title": "get_characters_character_id_assets_location_flag",
"type": "string"
},
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_characters_character_id_assets_location_id",
"type": "integer"
},
"location_type": {
"description": "location_type string",
"enum": [
"station",
"solar_system",
"other"
],
"title": "get_characters_character_id_assets_location_type",
"type": "string"
},
"quantity": {
"description": "quantity integer",
"format": "int32",
"title": "get_characters_character_id_assets_quantity",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_characters_character_id_assets_type_id",
"type": "integer"
}
},
"required": [
"type_id",
"location_id",
"location_type",
"item_id",
"location_flag",
"is_singleton"
],
"title": "get_characters_character_id_assets_200_ok",
"type": "object"
},
"title": "get_characters_character_id_assets_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-assets.read_assets.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_assets_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_assets_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_assets_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_assets_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-assets.read_assets.v1"
]
}
],
"summary": "Get character assets",
"tags": [
"Assets"
]
}
},
"/characters/{character_id}/bookmarks/": {
"get": {
"description": "List your character's personal bookmarks\n\n---\n\nAlternate route: `/v1/characters/{character_id}/bookmarks/`\n\nAlternate route: `/legacy/characters/{character_id}/bookmarks/`\n\nAlternate route: `/dev/characters/{character_id}/bookmarks/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_bookmarks",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of bookmarks",
"examples": {
"application/json": [
{
"bookmark_id": 32,
"create_date": "2016-08-09T11:57:47Z",
"creator_id": 90000001,
"folder_id": 5,
"memo": "aoeu ( Citadel )",
"note": "",
"owner_id": 90000001,
"target": {
"item": {
"item_id": 1000000012668,
"type_id": 35832
},
"location_id": 30000005
}
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"bookmark_id": {
"description": "bookmark_id integer",
"format": "int64",
"title": "get_characters_character_id_bookmarks_bookmark_id",
"type": "integer"
},
"create_date": {
"description": "create_date string",
"format": "date-time",
"title": "get_characters_character_id_bookmarks_create_date",
"type": "string"
},
"creator_id": {
"description": "creator_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_creator_id",
"type": "integer"
},
"folder_id": {
"description": "folder_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_folder_id",
"type": "integer"
},
"memo": {
"description": "memo string",
"title": "get_characters_character_id_bookmarks_memo",
"type": "string"
},
"note": {
"description": "note string",
"title": "get_characters_character_id_bookmarks_note",
"type": "string"
},
"owner_id": {
"description": "owner_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_owner_id",
"type": "integer"
},
"target": {
"description": "target object",
"properties": {
"coordinates": {
"description": "coordinates object",
"properties": {
"x": {
"description": "x number",
"format": "double",
"title": "get_characters_character_id_bookmarks_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "double",
"title": "get_characters_character_id_bookmarks_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "double",
"title": "get_characters_character_id_bookmarks_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_characters_character_id_bookmarks_coordinates",
"type": "object"
},
"item": {
"description": "item object",
"properties": {
"item_id": {
"description": "item_id integer",
"format": "int64",
"title": "get_characters_character_id_bookmarks_item_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_type_id",
"type": "integer"
}
},
"required": [
"item_id",
"type_id"
],
"title": "get_characters_character_id_bookmarks_item",
"type": "object"
},
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_characters_character_id_bookmarks_location_id",
"type": "integer"
}
},
"required": [
"location_id"
],
"title": "get_characters_character_id_bookmarks_target",
"type": "object"
}
},
"required": [
"bookmark_id",
"creator_id",
"owner_id",
"create_date",
"memo",
"note",
"target"
],
"title": "get_characters_character_id_bookmarks_200_ok",
"type": "object"
},
"title": "get_characters_character_id_bookmarks_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-bookmarks.read_character_bookmarks.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_bookmarks_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_bookmarks_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_bookmarks_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_bookmarks_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-bookmarks.read_character_bookmarks.v1"
]
}
],
"summary": "List bookmarks",
"tags": [
"Bookmarks"
]
}
},
"/characters/{character_id}/bookmarks/folders/": {
"get": {
"description": "List your character's personal bookmark folders\n\n---\n\nAlternate route: `/v1/characters/{character_id}/bookmarks/folders/`\n\nAlternate route: `/legacy/characters/{character_id}/bookmarks/folders/`\n\nAlternate route: `/dev/characters/{character_id}/bookmarks/folders/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_bookmarks_folders",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of bookmark folders",
"examples": {
"application/json": [
{
"folder_id": 5,
"name": "Icecream",
"owner_id": 90000001
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"folder_id": {
"description": "folder_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_folders_folder_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_characters_character_id_bookmarks_folders_name",
"type": "string"
},
"owner_id": {
"description": "owner_id integer",
"format": "int32",
"title": "get_characters_character_id_bookmarks_folders_owner_id",
"type": "integer"
}
},
"title": "get_characters_character_id_bookmarks_folders_200_ok",
"type": "object"
},
"title": "get_characters_character_id_bookmarks_folders_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-bookmarks.read_character_bookmarks.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_bookmarks_folders_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_bookmarks_folders_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_bookmarks_folders_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_bookmarks_folders_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-bookmarks.read_character_bookmarks.v1"
]
}
],
"summary": "List bookmark folders",
"tags": [
"Bookmarks"
]
}
},
"/characters/{character_id}/calendar/": {
"get": {
"description": "Get 50 event summaries from the calendar. If no event ID is given,\nthe resource will return the next 50 chronological event summaries\nfrom now. If an event ID is specified, it will return the next 50\nchronological event summaries from after that event.\n\n\n---\n\nAlternate route: `/v1/characters/{character_id}/calendar/`\n\nAlternate route: `/legacy/characters/{character_id}/calendar/`\n\nAlternate route: `/dev/characters/{character_id}/calendar/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_characters_character_id_calendar",
"parameters": [
{
"description": "The character to retrieve events from",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The event ID to retrieve events from",
"format": "int32",
"in": "query",
"name": "from_event",
"required": false,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A collection of event summaries",
"examples": {
"application/json": [
{
"event_date": "2016-06-26T20:00:00Z",
"event_id": 1386435,
"event_response": "accepted",
"importance": 0,
"title": "o7 The EVE Online Show"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "Up to 50 events from now or the event you requested\n",
"items": {
"description": "event",
"properties": {
"event_date": {
"description": "event_date string",
"format": "date-time",
"title": "get_characters_character_id_calendar_event_date",
"type": "string"
},
"event_id": {
"description": "event_id integer",
"format": "int32",
"title": "get_characters_character_id_calendar_event_id",
"type": "integer"
},
"event_response": {
"description": "event_response string",
"enum": [
"declined",
"not_responded",
"accepted",
"tentative"
],
"title": "get_characters_character_id_calendar_event_response",
"type": "string"
},
"importance": {
"description": "importance integer",
"format": "int32",
"title": "get_characters_character_id_calendar_importance",
"type": "integer"
},
"title": {
"description": "title string",
"title": "get_characters_character_id_calendar_title",
"type": "string"
}
},
"title": "get_characters_character_id_calendar_200_ok",
"type": "object"
},
"title": "get_characters_character_id_calendar_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-calendar.read_calendar_events.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_calendar_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_calendar_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_calendar_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_calendar_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-calendar.read_calendar_events.v1"
]
}
],
"summary": "List calendar event summaries",
"tags": [
"Calendar"
]
}
},
"/characters/{character_id}/calendar/{event_id}/": {
"get": {
"description": "Get all the information for a specific event\n\n---\n\nAlternate route: `/v3/characters/{character_id}/calendar/{event_id}/`\n\nAlternate route: `/dev/characters/{character_id}/calendar/{event_id}/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_characters_character_id_calendar_event_id",
"parameters": [
{
"description": "The character id requesting the event",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The id of the event requested",
"format": "int32",
"in": "path",
"name": "event_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Full details of a specific event",
"examples": {
"application/json": {
"date": "2016-06-26T21:00:00Z",
"duration": 60,
"event_id": 1386435,
"importance": 1,
"owner_id": 1,
"owner_name": "EVE System",
"owner_type": "eve_server",
"response": "Undecided",
"text": "o7: The EVE Online Show features latest developer news, fast paced action, community overviews and a lot more with CCP Guard and CCP Mimic. Join the thrilling o7 live broadcast at 20:00 EVE time (=UTC) on <a href=\"http://www.twitch.tv/ccp\">EVE TV</a>. Don't miss it!",
"title": "o7 The EVE Online Show"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "Full details of a specific event",
"properties": {
"date": {
"description": "date string",
"format": "date-time",
"title": "get_characters_character_id_calendar_event_id_date",
"type": "string"
},
"duration": {
"description": "Length in minutes",
"format": "int32",
"title": "get_characters_character_id_calendar_event_id_duration",
"type": "integer"
},
"event_id": {
"description": "event_id integer",
"format": "int32",
"title": "get_characters_character_id_calendar_event_id_event_id",
"type": "integer"
},
"importance": {
"description": "importance integer",
"format": "int32",
"title": "get_characters_character_id_calendar_event_id_importance",
"type": "integer"
},
"owner_id": {
"description": "owner_id integer",
"format": "int32",
"title": "get_characters_character_id_calendar_event_id_owner_id",
"type": "integer"
},
"owner_name": {
"description": "owner_name string",
"title": "get_characters_character_id_calendar_event_id_owner_name",
"type": "string"
},
"owner_type": {
"description": "owner_type string",
"enum": [
"eve_server",
"corporation",
"faction",
"character",
"alliance"
],
"title": "get_characters_character_id_calendar_event_id_owner_type",
"type": "string"
},
"response": {
"description": "response string",
"title": "get_characters_character_id_calendar_event_id_response",
"type": "string"
},
"text": {
"description": "text string",
"title": "get_characters_character_id_calendar_event_id_text",
"type": "string"
},
"title": {
"description": "title string",
"title": "get_characters_character_id_calendar_event_id_title",
"type": "string"
}
},
"required": [
"event_id",
"owner_id",
"owner_name",
"date",
"title",
"duration",
"importance",
"response",
"text",
"owner_type"
],
"title": "get_characters_character_id_calendar_event_id_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-calendar.read_calendar_events.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_calendar_event_id_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_calendar_event_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_calendar_event_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_calendar_event_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-calendar.read_calendar_events.v1"
]
}
],
"summary": "Get an event",
"tags": [
"Calendar"
]
},
"put": {
"description": "Set your response status to an event\n\n---\n\nAlternate route: `/v3/characters/{character_id}/calendar/{event_id}/`\n\nAlternate route: `/dev/characters/{character_id}/calendar/{event_id}/`\n",
"operationId": "put_characters_character_id_calendar_event_id",
"parameters": [
{
"description": "The character ID requesting the event",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The ID of the event requested",
"format": "int32",
"in": "path",
"name": "event_id",
"required": true,
"type": "integer"
},
{
"description": "The response value to set, overriding current value.",
"in": "body",
"name": "response",
"required": true,
"schema": {
"description": "response schema",
"properties": {
"response": {
"description": "response string",
"enum": [
"accepted",
"declined",
"tentative"
],
"title": "put_characters_character_id_calendar_event_id_response",
"type": "string"
}
},
"required": [
"response"
],
"title": "put_characters_character_id_calendar_event_id_response"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Event updated"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-calendar.respond_calendar_events.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_characters_character_id_calendar_event_id_403_forbidden",
"type": "string"
}
},
"title": "put_characters_character_id_calendar_event_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_characters_character_id_calendar_event_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_characters_character_id_calendar_event_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-calendar.respond_calendar_events.v1"
]
}
],
"summary": "Respond to an event",
"tags": [
"Calendar"
]
}
},
"/characters/{character_id}/clones/": {
"get": {
"description": "A list of the character's clones\n\n---\n\nAlternate route: `/v2/characters/{character_id}/clones/`\n\nAlternate route: `/dev/characters/{character_id}/clones/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_clones",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Clone information for the given character",
"examples": {
"application/json": {
"home_location": {
"location_id": 1021348135816,
"location_type": "structure"
},
"jump_clones": [
{
"implants": [
22118
],
"location_id": 60003463,
"location_type": "station"
},
{
"implants": [],
"location_id": 1021348135816,
"location_type": "structure"
}
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"home_location": {
"description": "home_location object",
"properties": {
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_characters_character_id_clones_location_id",
"type": "integer"
},
"location_type": {
"description": "location_type string",
"enum": [
"station",
"structure"
],
"title": "get_characters_character_id_clones_location_type",
"type": "string"
}
},
"title": "get_characters_character_id_clones_home_location",
"type": "object"
},
"jump_clones": {
"description": "jump_clones array",
"items": {
"description": "jump_clone object",
"properties": {
"implants": {
"description": "implants array",
"items": {
"description": "implant integer",
"format": "int32",
"title": "get_characters_character_id_clones_implant",
"type": "integer"
},
"title": "get_characters_character_id_clones_implants",
"type": "array"
},
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_characters_character_id_clones_location_id",
"type": "integer"
},
"location_type": {
"description": "location_type string",
"enum": [
"station",
"structure"
],
"title": "get_characters_character_id_clones_location_type",
"type": "string"
}
},
"title": "get_characters_character_id_clones_jump_clone",
"type": "object"
},
"title": "get_characters_character_id_clones_jump_clones",
"type": "array"
},
"last_jump_date": {
"description": "last_jump_date string",
"format": "date-time",
"title": "get_characters_character_id_clones_last_jump_date",
"type": "string"
}
},
"required": [
"jump_clones"
],
"title": "get_characters_character_id_clones_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-clones.read_clones.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_clones_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_clones_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_clones_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_clones_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-clones.read_clones.v1"
]
}
],
"summary": "Get clones",
"tags": [
"Clones"
]
}
},
"/characters/{character_id}/contacts/": {
"delete": {
"description": "Bulk delete contacts\n\n---\n\nAlternate route: `/v1/characters/{character_id}/contacts/`\n\nAlternate route: `/legacy/characters/{character_id}/contacts/`\n\nAlternate route: `/dev/characters/{character_id}/contacts/`\n",
"operationId": "delete_characters_character_id_contacts",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"description": "A list of contacts to edit",
"in": "body",
"name": "contact_ids",
"required": true,
"schema": {
"description": "contact_ids array",
"items": {
"description": "ID of the contact to edit",
"format": "int32",
"title": "delete_characters_character_id_contacts_contact_id",
"type": "integer"
},
"maxItems": 20,
"minItems": 1,
"title": "delete_characters_character_id_contacts_contact_ids",
"type": "array"
}
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Contacts deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.write_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_characters_character_id_contacts_403_forbidden",
"type": "string"
}
},
"title": "delete_characters_character_id_contacts_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_characters_character_id_contacts_500_internal_server_error",
"type": "string"
}
},
"title": "delete_characters_character_id_contacts_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.write_contacts.v1"
]
}
],
"summary": "Delete contacts",
"tags": [
"Contacts"
]
},
"get": {
"description": "Return contacts of a character\n\n---\n\nAlternate route: `/v1/characters/{character_id}/contacts/`\n\nAlternate route: `/legacy/characters/{character_id}/contacts/`\n\nAlternate route: `/dev/characters/{character_id}/contacts/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_characters_character_id_contacts",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 1,
"description": "page integer",
"format": "int32",
"in": "query",
"minimum": 1,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of contacts",
"examples": {
"application/json": [
{
"contact_id": 123,
"contact_type": "character",
"is_blocked": false,
"is_watched": true,
"standing": 10
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"contact_id": {
"description": "contact_id integer",
"format": "int32",
"title": "get_characters_character_id_contacts_contact_id",
"type": "integer"
},
"contact_type": {
"description": "contact_type string",
"enum": [
"character",
"corporation",
"alliance",
"faction"
],
"title": "get_characters_character_id_contacts_contact_type",
"type": "string"
},
"is_blocked": {
"description": "Whether this contact is in the blocked list. Note a missing value denotes unknown, not true or false",
"title": "get_characters_character_id_contacts_is_blocked",
"type": "boolean"
},
"is_watched": {
"description": "Whether this contact is being watched",
"title": "get_characters_character_id_contacts_is_watched",
"type": "boolean"
},
"label_id": {
"description": "Custom label of the contact",
"format": "int64",
"title": "get_characters_character_id_contacts_label_id",
"type": "integer"
},
"standing": {
"description": "Standing of the contact",
"format": "float",
"title": "get_characters_character_id_contacts_standing",
"type": "number"
}
},
"required": [
"standing",
"contact_type",
"contact_id"
],
"title": "get_characters_character_id_contacts_200_ok",
"type": "object"
},
"title": "get_characters_character_id_contacts_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.read_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_contacts_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_contacts_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_contacts_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_contacts_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.read_contacts.v1"
]
}
],
"summary": "Get contacts",
"tags": [
"Contacts"
]
},
"post": {
"description": "Bulk add contacts with same settings\n\n---\n\nAlternate route: `/v1/characters/{character_id}/contacts/`\n\nAlternate route: `/legacy/characters/{character_id}/contacts/`\n\nAlternate route: `/dev/characters/{character_id}/contacts/`\n",
"operationId": "post_characters_character_id_contacts",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"description": "A list of contacts to add",
"in": "body",
"name": "contact_ids",
"required": true,
"schema": {
"description": "contact_ids array",
"items": {
"description": "ID of the contact to add",
"format": "int32",
"title": "post_characters_character_id_contacts_contact_id",
"type": "integer"
},
"maxItems": 100,
"minItems": 1,
"title": "post_characters_character_id_contacts_contact_ids",
"type": "array"
}
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 0,
"description": "Add a custom label to the new contact",
"format": "int64",
"in": "query",
"name": "label_id",
"required": false,
"type": "integer"
},
{
"description": "Standing for the new contact",
"format": "float",
"in": "query",
"maximum": 10,
"minimum": -10,
"name": "standing",
"required": true,
"type": "number"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"default": false,
"description": "Whether the new contact should be watched, note this is only effective on characters",
"in": "query",
"name": "watched",
"required": false,
"type": "boolean"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "A list of contact ids that successfully created",
"examples": {
"application/json": [
123,
456
]
},
"schema": {
"description": "201 created array",
"items": {
"description": "201 created integer",
"format": "int32",
"title": "post_characters_character_id_contacts_201_created",
"type": "integer"
},
"title": "post_characters_character_id_contacts_created",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.write_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_characters_character_id_contacts_403_forbidden",
"type": "string"
}
},
"title": "post_characters_character_id_contacts_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_characters_character_id_contacts_500_internal_server_error",
"type": "string"
}
},
"title": "post_characters_character_id_contacts_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.write_contacts.v1"
]
}
],
"summary": "Add contacts",
"tags": [
"Contacts"
]
},
"put": {
"description": "Bulk edit contacts with same settings\n\n---\n\nAlternate route: `/v1/characters/{character_id}/contacts/`\n\nAlternate route: `/legacy/characters/{character_id}/contacts/`\n\nAlternate route: `/dev/characters/{character_id}/contacts/`\n",
"operationId": "put_characters_character_id_contacts",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"description": "A list of contacts to edit",
"in": "body",
"name": "contact_ids",
"required": true,
"schema": {
"description": "contact_ids array",
"items": {
"description": "ID of the contact to edit",
"format": "int32",
"title": "put_characters_character_id_contacts_contact_id",
"type": "integer"
},
"maxItems": 100,
"minItems": 1,
"title": "put_characters_character_id_contacts_contact_ids",
"type": "array"
}
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 0,
"description": "Add a custom label to the contact, use 0 for clearing label",
"format": "int64",
"in": "query",
"name": "label_id",
"required": false,
"type": "integer"
},
{
"description": "Standing for the contact",
"format": "float",
"in": "query",
"maximum": 10,
"minimum": -10,
"name": "standing",
"required": true,
"type": "number"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"default": false,
"description": "Whether the contact should be watched, note this is only effective on characters",
"in": "query",
"name": "watched",
"required": false,
"type": "boolean"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Contacts updated"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.write_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_characters_character_id_contacts_403_forbidden",
"type": "string"
}
},
"title": "put_characters_character_id_contacts_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_characters_character_id_contacts_500_internal_server_error",
"type": "string"
}
},
"title": "put_characters_character_id_contacts_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.write_contacts.v1"
]
}
],
"summary": "Edit contacts",
"tags": [
"Contacts"
]
}
},
"/characters/{character_id}/contacts/labels/": {
"get": {
"description": "Return custom labels for contacts the character defined\n\n---\n\nAlternate route: `/v1/characters/{character_id}/contacts/labels/`\n\nAlternate route: `/legacy/characters/{character_id}/contacts/labels/`\n\nAlternate route: `/dev/characters/{character_id}/contacts/labels/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_characters_character_id_contacts_labels",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of contact labels",
"examples": {
"application/json": [
{
"label_id": 123,
"label_name": "Friends"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"label_id": {
"description": "label_id integer",
"format": "int64",
"title": "get_characters_character_id_contacts_labels_label_id",
"type": "integer"
},
"label_name": {
"description": "label_name string",
"title": "get_characters_character_id_contacts_labels_label_name",
"type": "string"
}
},
"required": [
"label_id",
"label_name"
],
"title": "get_characters_character_id_contacts_labels_200_ok",
"type": "object"
},
"title": "get_characters_character_id_contacts_labels_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.read_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_contacts_labels_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_contacts_labels_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_contacts_labels_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_contacts_labels_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.read_contacts.v1"
]
}
],
"summary": "Get contact labels",
"tags": [
"Contacts"
]
}
},
"/characters/{character_id}/corporationhistory/": {
"get": {
"description": "Get a list of all the corporations a character has been a member of\n\n---\n\nAlternate route: `/v1/characters/{character_id}/corporationhistory/`\n\nAlternate route: `/legacy/characters/{character_id}/corporationhistory/`\n\nAlternate route: `/dev/characters/{character_id}/corporationhistory/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_corporationhistory",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Corporation history for the given character",
"examples": {
"application/json": [
{
"corporation_id": 90000001,
"is_deleted": false,
"record_id": 500,
"start_date": "2016-06-26T20:00:00Z"
},
{
"corporation_id": 90000002,
"is_deleted": false,
"record_id": 501,
"start_date": "2016-07-26T20:00:00Z"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_characters_character_id_corporationhistory_corporation_id",
"type": "integer"
},
"is_deleted": {
"description": "True if the corporation has been deleted",
"title": "get_characters_character_id_corporationhistory_is_deleted",
"type": "boolean"
},
"record_id": {
"description": "An incrementing ID that can be used to canonically establish order of records in cases where dates may be ambiguous",
"format": "int32",
"title": "get_characters_character_id_corporationhistory_record_id",
"type": "integer"
},
"start_date": {
"description": "start_date string",
"format": "date-time",
"title": "get_characters_character_id_corporationhistory_start_date",
"type": "string"
}
},
"title": "get_characters_character_id_corporationhistory_200_ok",
"type": "object"
},
"title": "get_characters_character_id_corporationhistory_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_corporationhistory_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_corporationhistory_internal_server_error",
"type": "object"
}
}
},
"summary": "Get corporation history",
"tags": [
"Character"
]
}
},
"/characters/{character_id}/cspa/": {
"post": {
"description": "Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost\n\n---\n\nAlternate route: `/v3/characters/{character_id}/cspa/`\n\nAlternate route: `/legacy/characters/{character_id}/cspa/`\n\nAlternate route: `/dev/characters/{character_id}/cspa/`\n",
"operationId": "post_characters_character_id_cspa",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"description": "The target characters to calculate the charge for",
"in": "body",
"name": "characters",
"required": true,
"schema": {
"description": "characters schema",
"properties": {
"characters": {
"description": "characters array",
"items": {
"description": "character integer",
"format": "int32",
"title": "post_characters_character_id_cspa_character",
"type": "integer"
},
"minItems": 1,
"title": "post_characters_character_id_cspa_characters",
"type": "array",
"uniqueItems": true
}
},
"required": [
"characters"
],
"title": "post_characters_character_id_cspa_characters"
}
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "Aggregate cost of sending a mail from the source character to the target characters, in ISK hundredths",
"examples": {
"application/json": {
"cost": 295000
}
},
"schema": {
"description": "201 created object",
"properties": {
"cost": {
"description": "cost integer",
"format": "int64",
"title": "post_characters_character_id_cspa_cost",
"type": "integer"
}
},
"title": "post_characters_character_id_cspa_created",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-characters.read_contacts.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_characters_character_id_cspa_403_forbidden",
"type": "string"
}
},
"title": "post_characters_character_id_cspa_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_characters_character_id_cspa_500_internal_server_error",
"type": "string"
}
},
"title": "post_characters_character_id_cspa_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-characters.read_contacts.v1"
]
}
],
"summary": "Calculate a CSPA charge cost",
"tags": [
"Character"
]
}
},
"/characters/{character_id}/fittings/": {
"get": {
"description": "Return fittings of a character\n\n---\n\nAlternate route: `/v1/characters/{character_id}/fittings/`\n\nAlternate route: `/legacy/characters/{character_id}/fittings/`\n\nAlternate route: `/dev/characters/{character_id}/fittings/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_characters_character_id_fittings",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of fittings",
"examples": {
"application/json": [
{
"description": "Awesome Vindi fitting",
"fitting_id": 1,
"items": [
{
"flag": 12,
"quantity": 1,
"type_id": 1234
}
],
"name": "Best Vindicator",
"ship_type_id": 123
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"description": {
"description": "description string",
"title": "get_characters_character_id_fittings_description",
"type": "string"
},
"fitting_id": {
"description": "fitting_id integer",
"format": "int32",
"title": "get_characters_character_id_fittings_fitting_id",
"type": "integer"
},
"items": {
"description": "items array",
"items": {
"description": "item object",
"properties": {
"flag": {
"description": "flag integer",
"format": "int32",
"title": "get_characters_character_id_fittings_flag",
"type": "integer"
},
"quantity": {
"description": "quantity integer",
"format": "int32",
"title": "get_characters_character_id_fittings_quantity",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_characters_character_id_fittings_type_id",
"type": "integer"
}
},
"required": [
"type_id",
"flag",
"quantity"
],
"title": "get_characters_character_id_fittings_item",
"type": "object"
},
"title": "get_characters_character_id_fittings_items",
"type": "array"
},
"name": {
"description": "name string",
"title": "get_characters_character_id_fittings_name",
"type": "string"
},
"ship_type_id": {
"description": "ship_type_id integer",
"format": "int32",
"title": "get_characters_character_id_fittings_ship_type_id",
"type": "integer"
}
},
"required": [
"fitting_id",
"name",
"description",
"ship_type_id",
"items"
],
"title": "get_characters_character_id_fittings_200_ok",
"type": "object"
},
"title": "get_characters_character_id_fittings_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fittings.read_fittings.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_fittings_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_fittings_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_fittings_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_fittings_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fittings.read_fittings.v1"
]
}
],
"summary": "Get fittings",
"tags": [
"Fittings"
]
},
"post": {
"description": "Save a new fitting for a character\n\n---\n\nAlternate route: `/v1/characters/{character_id}/fittings/`\n\nAlternate route: `/legacy/characters/{character_id}/fittings/`\n\nAlternate route: `/dev/characters/{character_id}/fittings/`\n",
"operationId": "post_characters_character_id_fittings",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Details about the new fitting",
"in": "body",
"name": "fitting",
"schema": {
"description": "fitting object",
"properties": {
"description": {
"description": "description string",
"maxLength": 500,
"minLength": 1,
"title": "post_characters_character_id_fittings_description",
"type": "string"
},
"items": {
"description": "items array",
"items": {
"description": "item object",
"properties": {
"flag": {
"description": "flag integer",
"format": "int32",
"title": "post_characters_character_id_fittings_flag",
"type": "integer"
},
"quantity": {
"description": "quantity integer",
"format": "int32",
"title": "post_characters_character_id_fittings_quantity",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "post_characters_character_id_fittings_type_id",
"type": "integer"
}
},
"required": [
"type_id",
"flag",
"quantity"
],
"title": "post_characters_character_id_fittings_item",
"type": "object"
},
"maxItems": 255,
"minItems": 1,
"title": "post_characters_character_id_fittings_items",
"type": "array"
},
"name": {
"description": "name string",
"maxLength": 50,
"minLength": 1,
"title": "post_characters_character_id_fittings_name",
"type": "string"
},
"ship_type_id": {
"description": "ship_type_id integer",
"format": "int32",
"title": "post_characters_character_id_fittings_ship_type_id",
"type": "integer"
}
},
"required": [
"name",
"description",
"ship_type_id",
"items"
],
"title": "post_characters_character_id_fittings_fitting",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "A list of fittings",
"examples": {
"application/json": {
"fitting_id": 2
}
},
"schema": {
"description": "201 created object",
"properties": {
"fitting_id": {
"description": "fitting_id integer",
"format": "int32",
"title": "post_characters_character_id_fittings_fitting_id",
"type": "integer"
}
},
"required": [
"fitting_id"
],
"title": "post_characters_character_id_fittings_created",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fittings.write_fittings.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_characters_character_id_fittings_403_forbidden",
"type": "string"
}
},
"title": "post_characters_character_id_fittings_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_characters_character_id_fittings_500_internal_server_error",
"type": "string"
}
},
"title": "post_characters_character_id_fittings_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fittings.write_fittings.v1"
]
}
],
"summary": "Create fitting",
"tags": [
"Fittings"
]
}
},
"/characters/{character_id}/fittings/{fitting_id}/": {
"delete": {
"description": "Delete a fitting from a character\n\n---\n\nAlternate route: `/v1/characters/{character_id}/fittings/{fitting_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/fittings/{fitting_id}/`\n\nAlternate route: `/dev/characters/{character_id}/fittings/{fitting_id}/`\n",
"operationId": "delete_characters_character_id_fittings_fitting_id",
"parameters": [
{
"description": "ID for a character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fitting of this character",
"format": "int32",
"in": "path",
"name": "fitting_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Fitting deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fittings.write_fittings.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_characters_character_id_fittings_fitting_id_403_forbidden",
"type": "string"
}
},
"title": "delete_characters_character_id_fittings_fitting_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_characters_character_id_fittings_fitting_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_characters_character_id_fittings_fitting_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fittings.write_fittings.v1"
]
}
],
"summary": "Delete fitting",
"tags": [
"Fittings"
]
}
},
"/characters/{character_id}/killmails/recent/": {
"get": {
"description": "Return a list of character's recent kills and losses\n\n---\n\nAlternate route: `/v1/characters/{character_id}/killmails/recent/`\n\nAlternate route: `/legacy/characters/{character_id}/killmails/recent/`\n\nAlternate route: `/dev/characters/{character_id}/killmails/recent/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_killmails_recent",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 50,
"description": "How many killmails to return at maximum",
"format": "int32",
"in": "query",
"maximum": 5000,
"name": "max_count",
"required": false,
"type": "integer"
},
{
"description": "Only return killmails with ID smaller than this.\n",
"format": "int32",
"in": "query",
"name": "max_kill_id",
"required": false,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of killmail IDs and hashes",
"examples": {
"application/json": [
{
"killmail_hash": "8eef5e8fb6b88fe3407c489df33822b2e3b57a5e",
"killmail_id": 2
},
{
"killmail_hash": "b41ccb498ece33d64019f64c0db392aa3aa701fb",
"killmail_id": 1
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"killmail_hash": {
"description": "A hash of this killmail",
"title": "get_characters_character_id_killmails_recent_killmail_hash",
"type": "string"
},
"killmail_id": {
"description": "ID of this killmail",
"format": "int32",
"title": "get_characters_character_id_killmails_recent_killmail_id",
"type": "integer"
}
},
"required": [
"killmail_id",
"killmail_hash"
],
"title": "get_characters_character_id_killmails_recent_200_ok",
"type": "object"
},
"title": "get_characters_character_id_killmails_recent_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-killmails.read_killmails.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_killmails_recent_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_killmails_recent_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_killmails_recent_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_killmails_recent_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-killmails.read_killmails.v1"
]
}
],
"summary": "List kills and losses",
"tags": [
"Killmails"
]
}
},
"/characters/{character_id}/location/": {
"get": {
"description": "Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable.\n\n---\n\nAlternate route: `/v1/characters/{character_id}/location/`\n\nAlternate route: `/legacy/characters/{character_id}/location/`\n\nAlternate route: `/dev/characters/{character_id}/location/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_characters_character_id_location",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable.",
"examples": {
"application/json": {
"solar_system_id": 30002505,
"structure_id": 1000000016989
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"solar_system_id": {
"description": "solar_system_id integer",
"format": "int32",
"title": "get_characters_character_id_location_solar_system_id",
"type": "integer"
},
"station_id": {
"description": "station_id integer",
"format": "int32",
"title": "get_characters_character_id_location_station_id",
"type": "integer"
},
"structure_id": {
"description": "structure_id integer",
"format": "int64",
"title": "get_characters_character_id_location_structure_id",
"type": "integer"
}
},
"required": [
"solar_system_id"
],
"title": "get_characters_character_id_location_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-location.read_location.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_location_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_location_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_location_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_location_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-location.read_location.v1"
]
}
],
"summary": "Get character location",
"tags": [
"Location"
]
}
},
"/characters/{character_id}/mail/": {
"get": {
"description": "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.\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/`\n\nAlternate route: `/dev/characters/{character_id}/mail/`\n\n\n---\n\nThis route is cached for up to 30 seconds",
"operationId": "get_characters_character_id_mail",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Fetch only mails that match one or more of the given labels",
"in": "query",
"items": {
"format": "int64",
"minimum": 0,
"type": "integer"
},
"minItems": 1,
"name": "labels",
"required": false,
"type": "array",
"uniqueItems": true
},
{
"description": "List only mail with an ID lower than the given ID, if present",
"format": "int32",
"in": "query",
"name": "last_mail_id",
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested mail",
"examples": {
"application/json": [
{
"from": 90000001,
"is_read": true,
"labels": [
3
],
"mail_id": 7,
"recipients": [
{
"recipient_id": 90000002,
"recipient_type": "character"
}
],
"subject": "Title for EVE Mail",
"timestamp": "2015-09-30T16:07:00Z"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"from": {
"description": "From whom the mail was sent",
"format": "int32",
"title": "get_characters_character_id_mail_from",
"type": "integer"
},
"is_read": {
"description": "is_read boolean",
"title": "get_characters_character_id_mail_is_read",
"type": "boolean"
},
"labels": {
"description": "labels array",
"items": {
"description": "label integer",
"format": "int64",
"title": "get_characters_character_id_mail_label",
"type": "integer"
},
"maxItems": 25,
"minimum": 0,
"title": "get_characters_character_id_mail_labels",
"type": "array",
"uniqueItems": true
},
"mail_id": {
"description": "mail_id integer",
"format": "int64",
"title": "get_characters_character_id_mail_mail_id",
"type": "integer"
},
"recipients": {
"description": "Recipients of the mail",
"items": {
"description": "recipient object",
"properties": {
"recipient_id": {
"description": "recipient_id integer",
"format": "int32",
"title": "get_characters_character_id_mail_recipient_id",
"type": "integer"
},
"recipient_type": {
"description": "recipient_type string",
"enum": [
"alliance",
"character",
"corporation",
"mailing_list"
],
"title": "get_characters_character_id_mail_recipient_type",
"type": "string"
}
},
"required": [
"recipient_type",
"recipient_id"
],
"title": "get_characters_character_id_mail_recipient",
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"title": "get_characters_character_id_mail_recipients",
"type": "array",
"uniqueItems": true
},
"subject": {
"description": "Mail subject",
"title": "get_characters_character_id_mail_subject",
"type": "string"
},
"timestamp": {
"description": "When the mail was sent",
"format": "date-time",
"title": "get_characters_character_id_mail_timestamp",
"type": "string"
}
},
"title": "get_characters_character_id_mail_200_ok",
"type": "object"
},
"title": "get_characters_character_id_mail_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.read_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_mail_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_mail_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_mail_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_mail_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.read_mail.v1"
]
}
],
"summary": "Return mail headers",
"tags": [
"Mail"
]
},
"post": {
"description": "Create and send a new mail\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/`\n\nAlternate route: `/dev/characters/{character_id}/mail/`\n",
"operationId": "post_characters_character_id_mail",
"parameters": [
{
"description": "The sender's character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The mail to send",
"in": "body",
"name": "mail",
"required": true,
"schema": {
"description": "mail schema",
"properties": {
"approved_cost": {
"default": 0,
"description": "approved_cost integer",
"format": "int64",
"title": "post_characters_character_id_mail_approved_cost",
"type": "integer"
},
"body": {
"description": "body string",
"maxLength": 10000,
"title": "post_characters_character_id_mail_body",
"type": "string"
},
"recipients": {
"description": "recipients array",
"items": {
"description": "recipient object",
"properties": {
"recipient_id": {
"description": "recipient_id integer",
"format": "int32",
"title": "post_characters_character_id_mail_recipient_id",
"type": "integer"
},
"recipient_type": {
"description": "recipient_type string",
"enum": [
"alliance",
"character",
"corporation",
"mailing_list"
],
"title": "post_characters_character_id_mail_recipient_type",
"type": "string"
}
},
"required": [
"recipient_type",
"recipient_id"
],
"title": "post_characters_character_id_mail_recipient",
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"title": "post_characters_character_id_mail_recipients",
"type": "array"
},
"subject": {
"description": "subject string",
"maxLength": 1000,
"title": "post_characters_character_id_mail_subject",
"type": "string"
}
},
"required": [
"recipients",
"subject",
"body"
],
"title": "post_characters_character_id_mail_mail"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "Mail created",
"examples": {
"application/json": 13
},
"schema": {
"description": "Mail ID",
"format": "int32",
"title": "post_characters_character_id_mail_created",
"type": "integer"
}
},
"400": {
"description": "Only one corporation, alliance, or mailing list can be the\nrecipient of a mail\n",
"examples": {
"application/json": {
"error": "Bad request message"
}
},
"schema": {
"description": "Bad request",
"properties": {
"error": {
"description": "Bad request message",
"title": "post_characters_character_id_mail_400_bad_request",
"type": "string"
}
},
"title": "post_characters_character_id_mail_bad_request",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.send_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_characters_character_id_mail_403_forbidden",
"type": "string"
}
},
"title": "post_characters_character_id_mail_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_characters_character_id_mail_500_internal_server_error",
"type": "string"
}
},
"title": "post_characters_character_id_mail_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.send_mail.v1"
]
}
],
"summary": "Send a new mail",
"tags": [
"Mail"
]
}
},
"/characters/{character_id}/mail/labels/": {
"get": {
"description": "Return a list of the users mail labels, unread counts for each label and a total unread count.\n\n---\n\nAlternate route: `/v3/characters/{character_id}/mail/labels/`\n\nAlternate route: `/dev/characters/{character_id}/mail/labels/`\n\n\n---\n\nThis route is cached for up to 30 seconds",
"operationId": "get_characters_character_id_mail_labels",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of mail labels and unread counts",
"examples": {
"application/json": {
"labels": [
{
"color_hex": "#660066",
"label_id": 16,
"name": "PINK",
"unread_count": 4
},
{
"color_hex": "#ffffff",
"label_id": 17,
"name": "WHITE",
"unread_count": 1
}
],
"total_unread_count": 5
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"labels": {
"description": "labels array",
"items": {
"description": "label object",
"properties": {
"color": {
"default": "#ffffff",
"description": "color string",
"enum": [
"#ffffff",
"#ffff01",
"#ff6600",
"#fe0000",
"#9a0000",
"#660066",
"#0000fe",
"#0099ff",
"#01ffff",
"#00ff33",
"#349800",
"#006634",
"#666666",
"#999999",
"#e6e6e6",
"#ffffcd",
"#99ffff",
"#ccff9a"
],
"title": "get_characters_character_id_mail_labels_color",
"type": "string"
},
"label_id": {
"description": "label_id integer",
"format": "int32",
"minimum": 0,
"title": "get_characters_character_id_mail_labels_label_id",
"type": "integer"
},
"name": {
"description": "name string",
"maxLength": 40,
"title": "get_characters_character_id_mail_labels_name",
"type": "string"
},
"unread_count": {
"description": "unread_count integer",
"format": "int32",
"minimum": 0,
"title": "get_characters_character_id_mail_labels_unread_count",
"type": "integer"
}
},
"title": "get_characters_character_id_mail_labels_label",
"type": "object"
},
"title": "get_characters_character_id_mail_labels_labels",
"type": "array"
},
"total_unread_count": {
"description": "total_unread_count integer",
"format": "int32",
"minimum": 0,
"title": "get_characters_character_id_mail_labels_total_unread_count",
"type": "integer"
}
},
"title": "get_characters_character_id_mail_labels_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.read_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_mail_labels_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_mail_labels_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_mail_labels_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_mail_labels_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.read_mail.v1"
]
}
],
"summary": "Get mail labels and unread counts",
"tags": [
"Mail"
]
},
"post": {
"description": "Create a mail label\n\n---\n\nAlternate route: `/v2/characters/{character_id}/mail/labels/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/labels/`\n\nAlternate route: `/dev/characters/{character_id}/mail/labels/`\n",
"operationId": "post_characters_character_id_mail_labels",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Label to create",
"in": "body",
"name": "label",
"schema": {
"description": "label object",
"properties": {
"color": {
"default": "#ffffff",
"description": "Hexadecimal string representing label color,\nin RGB format\n",
"enum": [
"#ffffff",
"#ffff01",
"#ff6600",
"#fe0000",
"#9a0000",
"#660066",
"#0000fe",
"#0099ff",
"#01ffff",
"#00ff33",
"#349800",
"#006634",
"#666666",
"#999999",
"#e6e6e6",
"#ffffcd",
"#99ffff",
"#ccff9a"
],
"title": "post_characters_character_id_mail_labels_color",
"type": "string"
},
"name": {
"description": "name string",
"maxLength": 40,
"minLength": 1,
"title": "post_characters_character_id_mail_labels_name",
"type": "string"
}
},
"required": [
"name"
],
"title": "post_characters_character_id_mail_labels_label",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "Label created",
"examples": {
"application/json": 128
},
"schema": {
"description": "Label ID",
"format": "int64",
"title": "post_characters_character_id_mail_labels_created",
"type": "integer"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.organize_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_characters_character_id_mail_labels_403_forbidden",
"type": "string"
}
},
"title": "post_characters_character_id_mail_labels_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_characters_character_id_mail_labels_500_internal_server_error",
"type": "string"
}
},
"title": "post_characters_character_id_mail_labels_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.organize_mail.v1"
]
}
],
"summary": "Create a mail label",
"tags": [
"Mail"
]
}
},
"/characters/{character_id}/mail/labels/{label_id}/": {
"delete": {
"description": "Delete a mail label\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/`\n\nAlternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/`\n",
"operationId": "delete_characters_character_id_mail_labels_label_id",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An EVE label id",
"format": "int32",
"in": "path",
"name": "label_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Label deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.organize_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_characters_character_id_mail_labels_label_id_403_forbidden",
"type": "string"
}
},
"title": "delete_characters_character_id_mail_labels_label_id_forbidden",
"type": "object"
}
},
"422": {
"description": "Default labels cannot be deleted",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "delete_characters_character_id_mail_labels_label_id_422_unprocessable_entity",
"type": "string"
}
},
"title": "delete_characters_character_id_mail_labels_label_id_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_characters_character_id_mail_labels_label_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_characters_character_id_mail_labels_label_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.organize_mail.v1"
]
}
],
"summary": "Delete a mail label",
"tags": [
"Mail"
]
}
},
"/characters/{character_id}/mail/lists/": {
"get": {
"description": "Return all mailing lists that the character is subscribed to\n\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/lists/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/lists/`\n\nAlternate route: `/dev/characters/{character_id}/mail/lists/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_mail_lists",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Mailing lists",
"examples": {
"application/json": [
{
"mailing_list_id": 1,
"name": "test_mailing_list"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"mailing_list_id": {
"description": "Mailing list ID",
"format": "int32",
"title": "get_characters_character_id_mail_lists_mailing_list_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_characters_character_id_mail_lists_name",
"type": "string"
}
},
"required": [
"mailing_list_id",
"name"
],
"title": "get_characters_character_id_mail_lists_200_ok",
"type": "object"
},
"title": "get_characters_character_id_mail_lists_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.read_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_mail_lists_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_mail_lists_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_mail_lists_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_mail_lists_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.read_mail.v1"
]
}
],
"summary": "Return mailing list subscriptions",
"tags": [
"Mail"
]
}
},
"/characters/{character_id}/mail/{mail_id}/": {
"delete": {
"description": "Delete a mail\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/dev/characters/{character_id}/mail/{mail_id}/`\n",
"operationId": "delete_characters_character_id_mail_mail_id",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An EVE mail ID",
"format": "int32",
"in": "path",
"name": "mail_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Mail deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.organize_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_characters_character_id_mail_mail_id_403_forbidden",
"type": "string"
}
},
"title": "delete_characters_character_id_mail_mail_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_characters_character_id_mail_mail_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_characters_character_id_mail_mail_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.organize_mail.v1"
]
}
],
"summary": "Delete a mail",
"tags": [
"Mail"
]
},
"get": {
"description": "Return the contents of an EVE mail\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/dev/characters/{character_id}/mail/{mail_id}/`\n\n\n---\n\nThis route is cached for up to 30 seconds",
"operationId": "get_characters_character_id_mail_mail_id",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An EVE mail ID",
"format": "int32",
"in": "path",
"name": "mail_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Contents of a mail",
"examples": {
"application/json": {
"body": "blah blah blah",
"from": 90000001,
"labels": [
2,
32
],
"read": false,
"subject": "test",
"timestamp": "2015-09-30T16:07:00Z"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"body": {
"description": "Mail's body",
"title": "get_characters_character_id_mail_mail_id_body",
"type": "string"
},
"from": {
"description": "From whom the mail was sent",
"format": "int32",
"title": "get_characters_character_id_mail_mail_id_from",
"type": "integer"
},
"labels": {
"description": "Labels attached to the mail",
"items": {
"description": "label integer",
"format": "int64",
"minimum": 0,
"title": "get_characters_character_id_mail_mail_id_label",
"type": "integer",
"uniqueItems": true
},
"title": "get_characters_character_id_mail_mail_id_labels",
"type": "array"
},
"read": {
"description": "Whether the mail is flagged as read",
"title": "get_characters_character_id_mail_mail_id_read",
"type": "boolean"
},
"recipients": {
"description": "Recipients of the mail",
"items": {
"description": "recipient object",
"properties": {
"recipient_id": {
"description": "recipient_id integer",
"format": "int32",
"title": "get_characters_character_id_mail_mail_id_recipient_id",
"type": "integer"
},
"recipient_type": {
"description": "recipient_type string",
"enum": [
"alliance",
"character",
"corporation",
"mailing_list"
],
"title": "get_characters_character_id_mail_mail_id_recipient_type",
"type": "string"
}
},
"required": [
"recipient_type",
"recipient_id"
],
"title": "get_characters_character_id_mail_mail_id_recipient",
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"title": "get_characters_character_id_mail_mail_id_recipients",
"type": "array",
"uniqueItems": true
},
"subject": {
"description": "Mail subject",
"title": "get_characters_character_id_mail_mail_id_subject",
"type": "string"
},
"timestamp": {
"description": "When the mail was sent",
"format": "date-time",
"title": "get_characters_character_id_mail_mail_id_timestamp",
"type": "string"
}
},
"title": "get_characters_character_id_mail_mail_id_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.read_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_mail_mail_id_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_mail_mail_id_forbidden",
"type": "object"
}
},
"404": {
"description": "Mail not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_characters_character_id_mail_mail_id_404_not_found",
"type": "string"
}
},
"title": "get_characters_character_id_mail_mail_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_mail_mail_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_mail_mail_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.read_mail.v1"
]
}
],
"summary": "Return a mail",
"tags": [
"Mail"
]
},
"put": {
"description": "Update metadata about a mail\n\n---\n\nAlternate route: `/v1/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`\n\nAlternate route: `/dev/characters/{character_id}/mail/{mail_id}/`\n",
"operationId": "put_characters_character_id_mail_mail_id",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"description": "Data used to update the mail",
"in": "body",
"name": "contents",
"required": true,
"schema": {
"description": "contents object",
"properties": {
"labels": {
"description": "Labels to assign to the mail. Pre-existing labels are unassigned.",
"items": {
"description": "label integer",
"format": "int64",
"minimum": 0,
"title": "put_characters_character_id_mail_mail_id_label",
"type": "integer",
"uniqueItems": true
},
"title": "put_characters_character_id_mail_mail_id_labels",
"type": "array"
},
"read": {
"description": "Whether the mail is flagged as read",
"title": "put_characters_character_id_mail_mail_id_read",
"type": "boolean"
}
},
"title": "put_characters_character_id_mail_mail_id_contents",
"type": "object"
}
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An EVE mail ID",
"format": "int32",
"in": "path",
"name": "mail_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Mail updated"
},
"400": {
"description": "Invalid label ID; or No parameters in body -- nothing to do",
"examples": {
"application/json": {
"error": "Bad request message"
}
},
"schema": {
"description": "Bad request",
"properties": {
"error": {
"description": "Bad request message",
"title": "put_characters_character_id_mail_mail_id_400_bad_request",
"type": "string"
}
},
"title": "put_characters_character_id_mail_mail_id_bad_request",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-mail.organize_mail.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_characters_character_id_mail_mail_id_403_forbidden",
"type": "string"
}
},
"title": "put_characters_character_id_mail_mail_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_characters_character_id_mail_mail_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_characters_character_id_mail_mail_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-mail.organize_mail.v1"
]
}
],
"summary": "Update metadata about a mail",
"tags": [
"Mail"
]
}
},
"/characters/{character_id}/planets/": {
"get": {
"description": "Returns a list of all planetary colonies owned by a character.\n\n---\n\nAlternate route: `/v1/characters/{character_id}/planets/`\n\nAlternate route: `/legacy/characters/{character_id}/planets/`\n\nAlternate route: `/dev/characters/{character_id}/planets/`\n\n\n---\n\nThis route is cached for up to 600 seconds",
"operationId": "get_characters_character_id_planets",
"parameters": [
{
"description": "Character id of the target character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of colonies",
"examples": {
"application/json": [
{
"last_update": "2016-11-28T16:42:51Z",
"num_pins": 1,
"owner_id": 90000001,
"planet_id": 40023691,
"planet_type": "plasma",
"solar_system_id": 30000379,
"upgrade_level": 0
},
{
"last_update": "2016-11-28T16:41:54Z",
"num_pins": 1,
"owner_id": 90000001,
"planet_id": 40023697,
"planet_type": "barren",
"solar_system_id": 30000379,
"upgrade_level": 0
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"last_update": {
"description": "last_update string",
"format": "date-time",
"title": "get_characters_character_id_planets_last_update",
"type": "string"
},
"num_pins": {
"description": "num_pins integer",
"format": "int32",
"minimum": 1,
"title": "get_characters_character_id_planets_num_pins",
"type": "integer"
},
"owner_id": {
"description": "owner_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_owner_id",
"type": "integer"
},
"planet_id": {
"description": "planet_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id",
"type": "integer"
},
"planet_type": {
"description": "planet_type string",
"enum": [
"temperate",
"barren",
"oceanic",
"ice",
"gas",
"lava",
"storm",
"plasma"
],
"title": "get_characters_character_id_planets_planet_type",
"type": "string"
},
"solar_system_id": {
"description": "solar_system_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_solar_system_id",
"type": "integer"
},
"upgrade_level": {
"description": "upgrade_level integer",
"format": "int32",
"maximum": 5,
"minimum": 0,
"title": "get_characters_character_id_planets_upgrade_level",
"type": "integer"
}
},
"required": [
"solar_system_id",
"planet_id",
"planet_type",
"owner_id",
"last_update",
"upgrade_level",
"num_pins"
],
"title": "get_characters_character_id_planets_200_ok",
"type": "object"
},
"title": "get_characters_character_id_planets_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-planets.manage_planets.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_planets_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_planets_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_planets_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_planets_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-planets.manage_planets.v1"
]
}
],
"summary": "Get colonies",
"tags": [
"Planetary Interaction"
]
}
},
"/characters/{character_id}/planets/{planet_id}/": {
"get": {
"description": "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 on this endpoint will not update until this criteria is met.\n\n---\n\nAlternate route: `/v1/characters/{character_id}/planets/{planet_id}/`\n\nAlternate route: `/legacy/characters/{character_id}/planets/{planet_id}/`\n\n\n---\n\nThis route is cached for up to 600 seconds",
"operationId": "get_characters_character_id_planets_planet_id",
"parameters": [
{
"description": "Character id of the target character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Planet id of the target planet",
"format": "int32",
"in": "path",
"name": "planet_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Colony layout",
"examples": {
"application/json": {
"links": [
{
"destination_pin_id": 1000000017022,
"link_level": 0,
"source_pin_id": 1000000017021
}
],
"pins": [
{
"is_running": true,
"latitude": 1.55087844973,
"longitude": 0.717145933308,
"pin_id": 1000000017021,
"type_id": 2254
},
{
"is_running": true,
"latitude": 1.53360639935,
"longitude": 0.709775584394,
"pin_id": 1000000017022,
"type_id": 2256
}
],
"routes": [
{
"content_type_id": 2393,
"destination_pin_id": 1000000017030,
"quantity": 20,
"route_id": 4,
"source_pin_id": 1000000017029
}
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"links": {
"description": "links array",
"items": {
"description": "link object",
"properties": {
"destination_pin_id": {
"description": "destination_pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_destination_pin_id",
"type": "integer"
},
"link_level": {
"description": "link_level integer",
"format": "int32",
"maximum": 10,
"minimum": 0,
"title": "get_characters_character_id_planets_planet_id_link_level",
"type": "integer"
},
"source_pin_id": {
"description": "source_pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_source_pin_id",
"type": "integer"
}
},
"required": [
"source_pin_id",
"destination_pin_id",
"link_level"
],
"title": "get_characters_character_id_planets_planet_id_link",
"type": "object"
},
"title": "get_characters_character_id_planets_planet_id_links",
"type": "array"
},
"pins": {
"description": "pins array",
"items": {
"description": "pin object",
"properties": {
"expiry_time": {
"description": "expiry_time string",
"format": "date-time",
"title": "get_characters_character_id_planets_planet_id_expiry_time",
"type": "string"
},
"extractor_details": {
"description": "extractor_details object",
"properties": {
"cycle_time": {
"description": "in seconds",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_cycle_time",
"type": "integer"
},
"head_radius": {
"description": "head_radius number",
"format": "float",
"title": "get_characters_character_id_planets_planet_id_head_radius",
"type": "number"
},
"heads": {
"description": "heads array",
"items": {
"description": "head object",
"properties": {
"head_id": {
"description": "head_id integer",
"format": "int32",
"maximum": 9,
"minimum": 0,
"title": "get_characters_character_id_planets_planet_id_head_id",
"type": "integer"
},
"latitude": {
"description": "latitude number",
"format": "float",
"title": "get_characters_character_id_planets_planet_id_latitude",
"type": "number"
},
"longitude": {
"description": "longitude number",
"format": "float",
"title": "get_characters_character_id_planets_planet_id_longitude",
"type": "number"
}
},
"required": [
"head_id",
"latitude",
"longitude"
],
"title": "get_characters_character_id_planets_planet_id_head",
"type": "object"
},
"title": "get_characters_character_id_planets_planet_id_heads",
"type": "array"
},
"product_type_id": {
"description": "product_type_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_product_type_id",
"type": "integer"
},
"qty_per_cycle": {
"description": "qty_per_cycle integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_qty_per_cycle",
"type": "integer"
}
},
"required": [
"heads",
"product_type_id",
"cycle_time",
"head_radius",
"qty_per_cycle"
],
"title": "get_characters_character_id_planets_planet_id_extractor_details",
"type": "object"
},
"factory_details": {
"description": "factory_details object",
"properties": {
"schematic_id": {
"description": "schematic_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_schematic_id",
"type": "integer"
}
},
"required": [
"schematic_id"
],
"title": "get_characters_character_id_planets_planet_id_factory_details",
"type": "object"
},
"install_time": {
"description": "install_time string",
"format": "date-time",
"title": "get_characters_character_id_planets_planet_id_install_time",
"type": "string"
},
"last_cycle_start": {
"description": "last_cycle_start string",
"format": "date-time",
"title": "get_characters_character_id_planets_planet_id_last_cycle_start",
"type": "string"
},
"latitude": {
"description": "latitude number",
"format": "float",
"title": "get_characters_character_id_planets_planet_id_latitude",
"type": "number"
},
"longitude": {
"description": "longitude number",
"format": "float",
"title": "get_characters_character_id_planets_planet_id_longitude",
"type": "number"
},
"pin_id": {
"description": "pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_pin_id",
"type": "integer"
},
"schematic_id": {
"description": "schematic_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_schematic_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_type_id",
"type": "integer"
}
},
"required": [
"pin_id",
"type_id",
"latitude",
"longitude"
],
"title": "get_characters_character_id_planets_planet_id_pin",
"type": "object"
},
"title": "get_characters_character_id_planets_planet_id_pins",
"type": "array"
},
"routes": {
"description": "routes array",
"items": {
"description": "route object",
"properties": {
"content_type_id": {
"description": "content_type_id integer",
"format": "int32",
"title": "get_characters_character_id_planets_planet_id_content_type_id",
"type": "integer"
},
"destination_pin_id": {
"description": "destination_pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_destination_pin_id",
"type": "integer"
},
"quantity": {
"description": "quantity integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_quantity",
"type": "integer"
},
"route_id": {
"description": "route_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_route_id",
"type": "integer"
},
"source_pin_id": {
"description": "source_pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_source_pin_id",
"type": "integer"
},
"waypoints": {
"description": "waypoints array",
"items": {
"description": "waypoint object",
"properties": {
"order": {
"description": "order integer",
"format": "int32",
"maximum": 5,
"minimum": 1,
"title": "get_characters_character_id_planets_planet_id_order",
"type": "integer"
},
"pin_id": {
"description": "pin_id integer",
"format": "int64",
"title": "get_characters_character_id_planets_planet_id_pin_id",
"type": "integer"
}
},
"required": [
"pin_id",
"order"
],
"title": "get_characters_character_id_planets_planet_id_waypoint",
"type": "object"
},
"title": "get_characters_character_id_planets_planet_id_waypoints",
"type": "array"
}
},
"required": [
"route_id",
"source_pin_id",
"destination_pin_id",
"content_type_id",
"quantity"
],
"title": "get_characters_character_id_planets_planet_id_route",
"type": "object"
},
"title": "get_characters_character_id_planets_planet_id_routes",
"type": "array"
}
},
"required": [
"links",
"pins",
"routes"
],
"title": "get_characters_character_id_planets_planet_id_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-planets.manage_planets.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_planets_planet_id_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_planets_planet_id_forbidden",
"type": "object"
}
},
"404": {
"description": "Colony not found",
"examples": {
"application/json": {
"error": "Colony not found"
}
},
"schema": {
"description": "Colony not found",
"properties": {
"error": {
"description": "error message",
"title": "get_characters_character_id_planets_planet_id_error",
"type": "string"
}
},
"title": "get_characters_character_id_planets_planet_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_planets_planet_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_planets_planet_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-planets.manage_planets.v1"
]
}
],
"summary": "Get colony layout",
"tags": [
"Planetary Interaction"
]
}
},
"/characters/{character_id}/portrait/": {
"get": {
"description": "Get portrait urls for a character\n\n---\n\nAlternate route: `/v2/characters/{character_id}/portrait/`\n\nAlternate route: `/dev/characters/{character_id}/portrait/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_portrait",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Public data for the given character",
"examples": {
"application/json": {
"px128x128": "https://imageserver.eveonline.com/Character/95465499_128.jpg",
"px256x256": "https://imageserver.eveonline.com/Character/95465499_256.jpg",
"px512x512": "https://imageserver.eveonline.com/Character/95465499_512.jpg",
"px64x64": "https://imageserver.eveonline.com/Character/95465499_64.jpg"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"px128x128": {
"description": "px128x128 string",
"title": "get_characters_character_id_portrait_px128x128",
"type": "string"
},
"px256x256": {
"description": "px256x256 string",
"title": "get_characters_character_id_portrait_px256x256",
"type": "string"
},
"px512x512": {
"description": "px512x512 string",
"title": "get_characters_character_id_portrait_px512x512",
"type": "string"
},
"px64x64": {
"description": "px64x64 string",
"title": "get_characters_character_id_portrait_px64x64",
"type": "string"
}
},
"title": "get_characters_character_id_portrait_ok",
"type": "object"
}
},
"404": {
"description": "No image server for this datasource",
"examples": {
"application/json": {
"error": "No image server for this datasource"
}
},
"schema": {
"description": "No image server for this datasource",
"properties": {
"error": {
"description": "error message",
"title": "get_characters_character_id_portrait_error",
"type": "string"
}
},
"title": "get_characters_character_id_portrait_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_portrait_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_portrait_internal_server_error",
"type": "object"
}
}
},
"summary": "Get character portraits",
"tags": [
"Character"
]
}
},
"/characters/{character_id}/search/": {
"get": {
"description": "Search for entities that match a given sub-string.\n\n---\n\nAlternate route: `/v2/characters/{character_id}/search/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_characters_character_id_search",
"parameters": [
{
"description": "Type of entities to search for",
"in": "query",
"items": {
"enum": [
"agent",
"alliance",
"character",
"constellation",
"corporation",
"faction",
"inventorytype",
"region",
"solarsystem",
"station",
"structure",
"wormhole"
],
"type": "string"
},
"minItems": 1,
"name": "categories",
"required": true,
"type": "array",
"uniqueItems": true
},
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Search locale",
"enum": [
"en-us",
"de",
"fr",
"ru",
"ja",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "The string to search on",
"in": "query",
"minLength": 3,
"name": "search",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Whether the search should be a strict match",
"in": "query",
"name": "strict",
"type": "boolean"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of search results",
"examples": {
"application/json": {
"solarsystem": [
30002510
],
"station": [
60004588,
60004594,
60005725,
60009106,
60012721,
60012724,
60012727
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"agent": {
"description": "agent array",
"items": {
"description": "agent integer",
"format": "int32",
"title": "get_characters_character_id_search_agent",
"type": "integer"
},
"title": "get_characters_character_id_search_agent",
"type": "array"
},
"alliance": {
"description": "alliance array",
"items": {
"description": "alliance integer",
"format": "int32",
"title": "get_characters_character_id_search_alliance",
"type": "integer"
},
"title": "get_characters_character_id_search_alliance",
"type": "array"
},
"character": {
"description": "character array",
"items": {
"description": "character integer",
"format": "int32",
"title": "get_characters_character_id_search_character",
"type": "integer"
},
"title": "get_characters_character_id_search_character",
"type": "array"
},
"constellation": {
"description": "constellation array",
"items": {
"description": "constellation integer",
"format": "int32",
"title": "get_characters_character_id_search_constellation",
"type": "integer"
},
"title": "get_characters_character_id_search_constellation",
"type": "array"
},
"corporation": {
"description": "corporation array",
"items": {
"description": "corporation integer",
"format": "int32",
"title": "get_characters_character_id_search_corporation",
"type": "integer"
},
"title": "get_characters_character_id_search_corporation",
"type": "array"
},
"faction": {
"description": "faction array",
"items": {
"description": "faction integer",
"format": "int32",
"title": "get_characters_character_id_search_faction",
"type": "integer"
},
"title": "get_characters_character_id_search_faction",
"type": "array"
},
"inventorytype": {
"description": "inventorytype array",
"items": {
"description": "inventorytype integer",
"format": "int32",
"title": "get_characters_character_id_search_inventorytype",
"type": "integer"
},
"title": "get_characters_character_id_search_inventorytype",
"type": "array"
},
"region": {
"description": "region array",
"items": {
"description": "region integer",
"format": "int32",
"title": "get_characters_character_id_search_region",
"type": "integer"
},
"title": "get_characters_character_id_search_region",
"type": "array"
},
"solarsystem": {
"description": "solarsystem array",
"items": {
"description": "solarsystem integer",
"format": "int32",
"title": "get_characters_character_id_search_solarsystem",
"type": "integer"
},
"title": "get_characters_character_id_search_solarsystem",
"type": "array"
},
"station": {
"description": "station array",
"items": {
"description": "station integer",
"format": "int32",
"title": "get_characters_character_id_search_station",
"type": "integer"
},
"title": "get_characters_character_id_search_station",
"type": "array"
},
"structure": {
"description": "structure array",
"items": {
"description": "structure integer",
"format": "int64",
"title": "get_characters_character_id_search_structure",
"type": "integer"
},
"title": "get_characters_character_id_search_structure",
"type": "array"
},
"wormhole": {
"description": "wormhole array",
"items": {
"description": "wormhole integer",
"format": "int32",
"title": "get_characters_character_id_search_wormhole",
"type": "integer"
},
"title": "get_characters_character_id_search_wormhole",
"type": "array"
}
},
"title": "get_characters_character_id_search_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-search.search_structures.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_search_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_search_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_search_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_search_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-search.search_structures.v1"
]
}
],
"summary": "Search on a string",
"tags": [
"Search"
]
}
},
"/characters/{character_id}/ship/": {
"get": {
"description": "Get the current ship type, name and id\n\n---\n\nAlternate route: `/v1/characters/{character_id}/ship/`\n\nAlternate route: `/legacy/characters/{character_id}/ship/`\n\nAlternate route: `/dev/characters/{character_id}/ship/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_characters_character_id_ship",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Get the current ship type, name and id",
"examples": {
"application/json": {
"ship_item_id": 1000000016991,
"ship_name": "SPACESHIPS!!!",
"ship_type_id": 1233
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"ship_item_id": {
"description": "Item id's are unique to a ship and persist until it is repackaged. This value can be used to track repeated uses of a ship, or detect when a pilot changes into a different instance of the same ship type.",
"format": "int64",
"title": "get_characters_character_id_ship_ship_item_id",
"type": "integer"
},
"ship_name": {
"description": "ship_name string",
"title": "get_characters_character_id_ship_ship_name",
"type": "string"
},
"ship_type_id": {
"description": "ship_type_id integer",
"format": "int32",
"title": "get_characters_character_id_ship_ship_type_id",
"type": "integer"
}
},
"required": [
"ship_type_id",
"ship_item_id",
"ship_name"
],
"title": "get_characters_character_id_ship_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-location.read_ship_type.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_ship_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_ship_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_ship_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_ship_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-location.read_ship_type.v1"
]
}
],
"summary": "Get current ship",
"tags": [
"Location"
]
}
},
"/characters/{character_id}/skillqueue/": {
"get": {
"description": "List the configured skill queue for the given character\n\n---\n\nAlternate route: `/v2/characters/{character_id}/skillqueue/`\n\nAlternate route: `/legacy/characters/{character_id}/skillqueue/`\n\nAlternate route: `/dev/characters/{character_id}/skillqueue/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_skillqueue",
"parameters": [
{
"description": "Character id of the target character",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "The current skill queue, sorted ascending by finishing time",
"examples": {
"application/json": [
{
"finish_date": "2016-06-29T10:47:00Z",
"finished_level": 3,
"queue_position": 0,
"skill_id": 1,
"start_date": "2016-06-29T10:46:00Z"
},
{
"finish_date": "2016-07-15T10:47:00Z",
"finished_level": 4,
"queue_position": 1,
"skill_id": 1,
"start_date": "2016-06-29T10:47:00Z"
},
{
"finish_date": "2016-08-30T10:47:00Z",
"finished_level": 2,
"queue_position": 2,
"skill_id": 2,
"start_date": "2016-07-15T10:47:00Z"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"finish_date": {
"description": "finish_date string",
"format": "date-time",
"title": "get_characters_character_id_skillqueue_finish_date",
"type": "string"
},
"finished_level": {
"description": "finished_level integer",
"format": "int32",
"maximum": 5,
"minimum": 0,
"title": "get_characters_character_id_skillqueue_finished_level",
"type": "integer"
},
"level_end_sp": {
"description": "level_end_sp integer",
"format": "int32",
"title": "get_characters_character_id_skillqueue_level_end_sp",
"type": "integer"
},
"level_start_sp": {
"description": "Amount of SP that was in the skill when it started training it's current level. Used to calculate % of current level complete.",
"format": "int32",
"title": "get_characters_character_id_skillqueue_level_start_sp",
"type": "integer"
},
"queue_position": {
"description": "queue_position integer",
"format": "int32",
"title": "get_characters_character_id_skillqueue_queue_position",
"type": "integer"
},
"skill_id": {
"description": "skill_id integer",
"format": "int32",
"title": "get_characters_character_id_skillqueue_skill_id",
"type": "integer"
},
"start_date": {
"description": "start_date string",
"format": "date-time",
"title": "get_characters_character_id_skillqueue_start_date",
"type": "string"
},
"training_start_sp": {
"description": "training_start_sp integer",
"format": "int32",
"title": "get_characters_character_id_skillqueue_training_start_sp",
"type": "integer"
}
},
"required": [
"skill_id",
"finished_level",
"queue_position"
],
"title": "get_characters_character_id_skillqueue_200_ok",
"type": "object"
},
"title": "get_characters_character_id_skillqueue_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-skills.read_skillqueue.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_skillqueue_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_skillqueue_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_skillqueue_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_skillqueue_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-skills.read_skillqueue.v1"
]
}
],
"summary": "Get character's skill queue",
"tags": [
"Skills"
]
}
},
"/characters/{character_id}/skills/": {
"get": {
"description": "List all trained skills for the given character\n\n---\n\nAlternate route: `/v3/characters/{character_id}/skills/`\n\nAlternate route: `/dev/characters/{character_id}/skills/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_skills",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Known skills for the character",
"examples": {
"application/json": {
"skills": [
{
"current_skill_level": 1,
"skill_id": 1,
"skillpoints_in_skill": 10000
},
{
"current_skill_level": 1,
"skill_id": 2,
"skillpoints_in_skill": 10000
}
],
"total_sp": 20000
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"skills": {
"description": "skills array",
"items": {
"description": "skill object",
"properties": {
"current_skill_level": {
"description": "current_skill_level integer",
"format": "int32",
"title": "get_characters_character_id_skills_current_skill_level",
"type": "integer"
},
"skill_id": {
"description": "skill_id integer",
"format": "int32",
"title": "get_characters_character_id_skills_skill_id",
"type": "integer"
},
"skillpoints_in_skill": {
"description": "skillpoints_in_skill integer",
"format": "int64",
"title": "get_characters_character_id_skills_skillpoints_in_skill",
"type": "integer"
}
},
"title": "get_characters_character_id_skills_skill",
"type": "object"
},
"title": "get_characters_character_id_skills_skills",
"type": "array"
},
"total_sp": {
"description": "total_sp integer",
"format": "int64",
"title": "get_characters_character_id_skills_total_sp",
"type": "integer"
}
},
"title": "get_characters_character_id_skills_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-skills.read_skills.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_skills_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_skills_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_skills_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_skills_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-skills.read_skills.v1"
]
}
],
"summary": "Get character skills",
"tags": [
"Skills"
]
}
},
"/characters/{character_id}/wallets/": {
"get": {
"description": "List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet.\n\n---\n\nAlternate route: `/v1/characters/{character_id}/wallets/`\n\nAlternate route: `/legacy/characters/{character_id}/wallets/`\n\nAlternate route: `/dev/characters/{character_id}/wallets/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_characters_character_id_wallets",
"parameters": [
{
"description": "An EVE character ID",
"format": "int32",
"in": "path",
"name": "character_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Wallet data for selected user",
"examples": {
"application/json": [
{
"balance": 295000,
"wallet_id": 1000
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"balance": {
"description": "Wallet's balance in ISK hundredths.",
"format": "int64",
"title": "get_characters_character_id_wallets_balance",
"type": "integer"
},
"wallet_id": {
"description": "wallet_id integer",
"format": "int32",
"title": "get_characters_character_id_wallets_wallet_id",
"type": "integer"
}
},
"title": "get_characters_character_id_wallets_200_ok",
"type": "object"
},
"title": "get_characters_character_id_wallets_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-wallet.read_character_wallet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_characters_character_id_wallets_403_forbidden",
"type": "string"
}
},
"title": "get_characters_character_id_wallets_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_characters_character_id_wallets_500_internal_server_error",
"type": "string"
}
},
"title": "get_characters_character_id_wallets_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-wallet.read_character_wallet.v1"
]
}
],
"summary": "List wallets and balances",
"tags": [
"Wallet"
]
}
},
"/corporations/names/": {
"get": {
"description": "Resolve a set of corporation IDs to corporation names\n\n---\n\nAlternate route: `/v1/corporations/names/`\n\nAlternate route: `/legacy/corporations/names/`\n\nAlternate route: `/dev/corporations/names/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_names",
"parameters": [
{
"description": "A comma separated list of corporation IDs",
"in": "query",
"items": {
"format": "int64",
"type": "integer"
},
"minItems": 1,
"name": "corporation_ids",
"required": true,
"type": "array"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of id/name associations",
"examples": {
"application/json": [
{
"corporation_id": 1000171,
"corporation_name": "Republic University"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_corporations_names_corporation_id",
"type": "integer"
},
"corporation_name": {
"description": "corporation_name string",
"title": "get_corporations_names_corporation_name",
"type": "string"
}
},
"required": [
"corporation_id",
"corporation_name"
],
"title": "get_corporations_names_200_ok",
"type": "object"
},
"title": "get_corporations_names_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_names_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_names_internal_server_error",
"type": "object"
}
}
},
"summary": "Get corporation names",
"tags": [
"Corporation"
]
}
},
"/corporations/npccorps/": {
"get": {
"description": "Get a list of npc corporations\n\n---\n\nAlternate route: `/v1/corporations/npccorps/`\n\nAlternate route: `/legacy/corporations/npccorps/`\n\nAlternate route: `/dev/corporations/npccorps/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_npccorps",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of npc corporation ids",
"examples": {
"application/json": [
1000001,
1000002,
1000003
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_corporations_npccorps_200_ok",
"type": "integer"
},
"title": "get_corporations_npccorps_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_npccorps_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_npccorps_internal_server_error",
"type": "object"
}
}
},
"summary": "Get npc corporations",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/": {
"get": {
"description": "Public information about a corporation\n\n---\n\nAlternate route: `/v2/corporations/{corporation_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id",
"parameters": [
{
"description": "An Eve corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Public data about a corporation",
"examples": {
"application/json": {
"alliance_id": 434243723,
"ceo_id": 180548812,
"corporation_name": "C C P",
"member_count": 656,
"ticker": "-CCP-"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"alliance_id": {
"description": "id of alliance that corporation is a member of, if any",
"format": "int32",
"title": "get_corporations_corporation_id_alliance_id",
"type": "integer"
},
"ceo_id": {
"description": "ceo_id integer",
"format": "int32",
"title": "get_corporations_corporation_id_ceo_id",
"type": "integer"
},
"corporation_name": {
"description": "the full name of the corporation",
"title": "get_corporations_corporation_id_corporation_name",
"type": "string"
},
"member_count": {
"description": "member_count integer",
"format": "int32",
"title": "get_corporations_corporation_id_member_count",
"type": "integer"
},
"ticker": {
"description": "the short name of the corporation",
"title": "get_corporations_corporation_id_ticker",
"type": "string"
}
},
"required": [
"corporation_name",
"ticker",
"member_count",
"ceo_id"
],
"title": "get_corporations_corporation_id_ok",
"type": "object"
}
},
"404": {
"description": "Corporation not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_corporations_corporation_id_404_not_found",
"type": "string"
}
},
"title": "get_corporations_corporation_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get corporation information",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/alliancehistory/": {
"get": {
"description": "Get a list of all the alliances a corporation has been a member of\n\n---\n\nAlternate route: `/v1/corporations/{corporation_id}/alliancehistory/`\n\nAlternate route: `/legacy/corporations/{corporation_id}/alliancehistory/`\n\nAlternate route: `/dev/corporations/{corporation_id}/alliancehistory/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id_alliancehistory",
"parameters": [
{
"description": "An EVE corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Alliance history for the given corporation",
"examples": {
"application/json": [
{
"alliance": {
"alliance_id": 99000006,
"is_deleted": false
},
"record_id": 23,
"start_date": "2016-10-25T14:46:00Z"
},
{
"record_id": 1,
"start_date": "2015-07-06T20:56:00Z"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"alliance": {
"description": "alliance object",
"properties": {
"alliance_id": {
"description": "alliance_id integer",
"format": "int32",
"title": "get_corporations_corporation_id_alliancehistory_alliance_id",
"type": "integer"
},
"is_deleted": {
"description": "True if the alliance has been deleted",
"title": "get_corporations_corporation_id_alliancehistory_is_deleted",
"type": "boolean"
}
},
"required": [
"alliance_id",
"is_deleted"
],
"title": "get_corporations_corporation_id_alliancehistory_alliance",
"type": "object"
},
"record_id": {
"description": "An incrementing ID that can be used to canonically establish order of records in cases where dates may be ambiguous",
"format": "int32",
"title": "get_corporations_corporation_id_alliancehistory_record_id",
"type": "integer"
},
"start_date": {
"description": "start_date string",
"format": "date-time",
"title": "get_corporations_corporation_id_alliancehistory_start_date",
"type": "string"
}
},
"required": [
"start_date",
"record_id"
],
"title": "get_corporations_corporation_id_alliancehistory_200_ok",
"type": "object"
},
"title": "get_corporations_corporation_id_alliancehistory_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_alliancehistory_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_alliancehistory_internal_server_error",
"type": "object"
}
}
},
"summary": "Get alliance history",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/icons/": {
"get": {
"description": "Get the icon urls for a corporation\n\n---\n\nAlternate route: `/v1/corporations/{corporation_id}/icons/`\n\nAlternate route: `/legacy/corporations/{corporation_id}/icons/`\n\nAlternate route: `/dev/corporations/{corporation_id}/icons/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id_icons",
"parameters": [
{
"description": "An EVE corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Urls for icons for the given corporation id and server",
"examples": {
"application/json": {
"px128x128": "https://imageserver.eveonline.com/Corporation/1000010_128.png",
"px256x256": "https://imageserver.eveonline.com/Corporation/1000010_256.png",
"px64x64": "https://imageserver.eveonline.com/Corporation/1000010_64.png"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"px128x128": {
"description": "px128x128 string",
"title": "get_corporations_corporation_id_icons_px128x128",
"type": "string"
},
"px256x256": {
"description": "px256x256 string",
"title": "get_corporations_corporation_id_icons_px256x256",
"type": "string"
},
"px64x64": {
"description": "px64x64 string",
"title": "get_corporations_corporation_id_icons_px64x64",
"type": "string"
}
},
"title": "get_corporations_corporation_id_icons_ok",
"type": "object"
}
},
"404": {
"description": "No image server for this datasource",
"examples": {
"application/json": {
"error": "No image server for this datasource"
}
},
"schema": {
"description": "No image server for this datasource",
"properties": {
"error": {
"description": "error message",
"title": "get_corporations_corporation_id_icons_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_icons_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_icons_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_icons_internal_server_error",
"type": "object"
}
}
},
"summary": "Get corporation icon",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/members/": {
"get": {
"description": "Read the current list of members if the calling character is a member.\n\n---\n\nAlternate route: `/v2/corporations/{corporation_id}/members/`\n\nAlternate route: `/legacy/corporations/{corporation_id}/members/`\n\nAlternate route: `/dev/corporations/{corporation_id}/members/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id_members",
"parameters": [
{
"description": "A corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of member character IDs",
"examples": {
"application/json": [
{
"character_id": 90000001
},
{
"character_id": 90000002
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"character_id": {
"description": "character_id integer",
"format": "int32",
"title": "get_corporations_corporation_id_members_character_id",
"type": "integer"
}
},
"required": [
"character_id"
],
"title": "get_corporations_corporation_id_members_200_ok",
"type": "object"
},
"title": "get_corporations_corporation_id_members_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-corporations.read_corporation_membership.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_corporations_corporation_id_members_403_forbidden",
"type": "string"
}
},
"title": "get_corporations_corporation_id_members_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_members_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_members_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-corporations.read_corporation_membership.v1"
]
}
],
"summary": "Get corporation members",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/roles/": {
"get": {
"description": "Return the roles of all members if the character has the personnel manager role or any grantable role.\n\n---\n\nAlternate route: `/v1/corporations/{corporation_id}/roles/`\n\nAlternate route: `/legacy/corporations/{corporation_id}/roles/`\n\nAlternate route: `/dev/corporations/{corporation_id}/roles/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id_roles",
"parameters": [
{
"description": "A corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of member character ID's and roles",
"examples": {
"application/json": [
{
"character_id": 1000171,
"roles": [
"Director",
"Station_Manager"
]
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"character_id": {
"description": "character_id integer",
"format": "int32",
"title": "get_corporations_corporation_id_roles_character_id",
"type": "integer"
},
"grantable_roles": {
"description": "grantable_roles array",
"items": {
"description": "grantable_role string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_grantable_role",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_grantable_roles",
"type": "array"
},
"grantable_roles_at_base": {
"description": "grantable_roles_at_base array",
"items": {
"description": "grantable_roles_at_base string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_grantable_roles_at_base",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_grantable_roles_at_base",
"type": "array"
},
"grantable_roles_at_hq": {
"description": "grantable_roles_at_hq array",
"items": {
"description": "grantable_roles_at_hq string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_grantable_roles_at_hq",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_grantable_roles_at_hq",
"type": "array"
},
"grantable_roles_at_other": {
"description": "grantable_roles_at_other array",
"items": {
"description": "grantable_roles_at_other string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_grantable_roles_at_other",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_grantable_roles_at_other",
"type": "array"
},
"roles": {
"description": "roles array",
"items": {
"description": "role string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_role",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_roles",
"type": "array"
},
"roles_at_base": {
"description": "roles_at_base array",
"items": {
"description": "roles_at_base string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_roles_at_base",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_roles_at_base",
"type": "array"
},
"roles_at_hq": {
"description": "roles_at_hq array",
"items": {
"description": "roles_at_hq string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_roles_at_hq",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_roles_at_hq",
"type": "array"
},
"roles_at_other": {
"description": "roles_at_other array",
"items": {
"description": "roles_at_other string",
"enum": [
"Director",
"Personnel_Manager",
"Accountant",
"Security_Officer",
"Factory_Manager",
"Station_Manager",
"Auditor",
"Hangar_Take_1",
"Hangar_Take_2",
"Hangar_Take_3",
"Hangar_Take_4",
"Hangar_Take_5",
"Hangar_Take_6",
"Hangar_Take_7",
"Hangar_Query_1",
"Hangar_Query_2",
"Hangar_Query_3",
"Hangar_Query_4",
"Hangar_Query_5",
"Hangar_Query_6",
"Hangar_Query_7",
"Account_Take_1",
"Account_Take_2",
"Account_Take_3",
"Account_Take_4",
"Account_Take_5",
"Account_Take_6",
"Account_Take_7",
"Diplomat",
"Config_Equipment",
"Container_Take_1",
"Container_Take_2",
"Container_Take_3",
"Container_Take_4",
"Container_Take_5",
"Container_Take_6",
"Container_Take_7",
"Rent_Office",
"Rent_Factory_Facility",
"Rent_Research_Facility",
"Junior_Accountant",
"Config_Starbase_Equipment",
"Trader",
"Communications_Officer",
"Contract_Manager",
"Starbase_Defense_Operator",
"Starbase_Fuel_Technician",
"Fitting_Manager",
"Terrestrial_Combat_Officer",
"Terrestrial_Logistics_Officer"
],
"title": "get_corporations_corporation_id_roles_roles_at_other",
"type": "string",
"uniqueItems": true
},
"title": "get_corporations_corporation_id_roles_roles_at_other",
"type": "array"
}
},
"required": [
"character_id"
],
"title": "get_corporations_corporation_id_roles_200_ok",
"type": "object"
},
"title": "get_corporations_corporation_id_roles_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-corporations.read_corporation_membership.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_corporations_corporation_id_roles_403_forbidden",
"type": "string"
}
},
"title": "get_corporations_corporation_id_roles_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_roles_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_roles_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-corporations.read_corporation_membership.v1"
]
}
],
"summary": "Get corporation member roles",
"tags": [
"Corporation"
]
}
},
"/corporations/{corporation_id}/structures/": {
"get": {
"description": "Get a list of corporation structures\n\n---\n\nAlternate route: `/v1/corporations/{corporation_id}/structures/`\n\nAlternate route: `/legacy/corporations/{corporation_id}/structures/`\n\nAlternate route: `/dev/corporations/{corporation_id}/structures/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_corporations_corporation_id_structures",
"parameters": [
{
"description": "A corporation ID",
"format": "int32",
"in": "path",
"name": "corporation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Which page to query, 250 structures per page",
"format": "int32",
"in": "query",
"minimum": 1,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of corporation structures' information",
"examples": {
"application/json": [
{
"corporation_id": 667531913,
"current_vul": "{1,2}",
"next_vul": "{3,4}",
"profile_id": 11237,
"structure_id": 1021975535893,
"system_id": 30004763,
"type_id": 35833
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"corporation_id": {
"description": "ID of the corporation that owns the structure",
"format": "int32",
"title": "get_corporations_corporation_id_structures_corporation_id",
"type": "integer"
},
"current_vul": {
"description": "Set of {Day, Hour} for this week's vulnerability windows, Monday is day 0",
"title": "get_corporations_corporation_id_structures_current_vul",
"type": "string"
},
"fuel_expires": {
"description": "Date on which the structure will run out of fuel",
"format": "date",
"title": "get_corporations_corporation_id_structures_fuel_expires",
"type": "string"
},
"next_vul": {
"description": "Set of {Day, Hour} for next week's vulnerability windows, Monday is day 0",
"title": "get_corporations_corporation_id_structures_next_vul",
"type": "string"
},
"profile_id": {
"description": "The id of the ACL profile for this citadel",
"format": "int32",
"title": "get_corporations_corporation_id_structures_profile_id",
"type": "integer"
},
"services": {
"description": "Contains a list of service upgrades, and their state",
"title": "get_corporations_corporation_id_structures_services",
"type": "string"
},
"state_timer_end": {
"description": "Date at which the structure will move to it's next state",
"format": "date",
"title": "get_corporations_corporation_id_structures_state_timer_end",
"type": "string"
},
"state_timer_start": {
"description": "Date at which the structure entered it's current state",
"format": "date",
"title": "get_corporations_corporation_id_structures_state_timer_start",
"type": "string"
},
"structure_id": {
"description": "The Item ID of the structure",
"format": "int64",
"title": "get_corporations_corporation_id_structures_structure_id",
"type": "integer"
},
"system_id": {
"description": "The solar system the structure is in",
"format": "int32",
"title": "get_corporations_corporation_id_structures_system_id",
"type": "integer"
},
"type_id": {
"description": "The type id of the structure",
"format": "int32",
"title": "get_corporations_corporation_id_structures_type_id",
"type": "integer"
},
"unanchors_at": {
"description": "Date at which the structure will unanchor",
"format": "date",
"title": "get_corporations_corporation_id_structures_unanchors_at",
"type": "string"
}
},
"required": [
"structure_id",
"type_id",
"corporation_id",
"system_id",
"profile_id",
"current_vul",
"next_vul"
],
"title": "get_corporations_corporation_id_structures_200_ok",
"type": "object"
},
"title": "get_corporations_corporation_id_structures_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-corporations.read_structures.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_corporations_corporation_id_structures_403_forbidden",
"type": "string"
}
},
"title": "get_corporations_corporation_id_structures_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_corporations_corporation_id_structures_500_internal_server_error",
"type": "string"
}
},
"title": "get_corporations_corporation_id_structures_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-corporations.read_structures.v1"
]
}
],
"summary": "Get corporation structures",
"tags": [
"Corporation"
]
}
},
"/fleets/{fleet_id}/": {
"get": {
"description": "Return details about a fleet\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_fleets_fleet_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Details about a fleet",
"examples": {
"application/json": {
"is_free_move": false,
"is_registered": false,
"is_voice_enabled": false,
"motd": "This is an <b>awesome</b> fleet!"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"is_free_move": {
"description": "Is free-move enabled",
"title": "get_fleets_fleet_id_is_free_move",
"type": "boolean"
},
"is_registered": {
"description": "Does the fleet have an active fleet advertisement",
"title": "get_fleets_fleet_id_is_registered",
"type": "boolean"
},
"is_voice_enabled": {
"description": "Is EVE Voice enabled",
"title": "get_fleets_fleet_id_is_voice_enabled",
"type": "boolean"
},
"motd": {
"description": "Fleet MOTD in CCP flavoured HTML",
"title": "get_fleets_fleet_id_motd",
"type": "string"
}
},
"required": [
"motd",
"is_free_move",
"is_registered",
"is_voice_enabled"
],
"title": "get_fleets_fleet_id_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.read_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_fleets_fleet_id_403_forbidden",
"type": "string"
}
},
"title": "get_fleets_fleet_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_fleets_fleet_id_404_not_found",
"type": "string"
}
},
"title": "get_fleets_fleet_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_fleets_fleet_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_fleets_fleet_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.read_fleet.v1"
]
}
],
"summary": "Get fleet information",
"tags": [
"Fleets"
]
},
"put": {
"description": "Update settings about a fleet\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/`\n",
"operationId": "put_fleets_fleet_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "What to update for this fleet",
"in": "body",
"name": "new_settings",
"required": true,
"schema": {
"description": "new_settings object",
"properties": {
"is_free_move": {
"description": "Should free-move be enabled in the fleet",
"title": "put_fleets_fleet_id_is_free_move",
"type": "boolean"
},
"motd": {
"description": "New fleet MOTD in CCP flavoured HTML",
"title": "put_fleets_fleet_id_motd",
"type": "string"
}
},
"title": "put_fleets_fleet_id_new_settings",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Fleet updated"
},
"400": {
"description": "Invalid request body",
"examples": {
"application/json": {
"error": "Bad request message"
}
},
"schema": {
"description": "Bad request",
"properties": {
"error": {
"description": "Bad request message",
"title": "put_fleets_fleet_id_400_bad_request",
"type": "string"
}
},
"title": "put_fleets_fleet_id_bad_request",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_fleets_fleet_id_403_forbidden",
"type": "string"
}
},
"title": "put_fleets_fleet_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "put_fleets_fleet_id_404_not_found",
"type": "string"
}
},
"title": "put_fleets_fleet_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_fleets_fleet_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_fleets_fleet_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Update fleet",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/members/": {
"get": {
"description": "Return information about fleet members\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/members/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/members/`\n\nAlternate route: `/dev/fleets/{fleet_id}/members/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_fleets_fleet_id_members",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of fleet members",
"examples": {
"application/json": [
{
"character_id": 93265215,
"join_time": "2016-04-29T12:34:56Z",
"role": "squad_commander",
"role_name": "Squad Commander (Boss)",
"ship_type_id": 33328,
"solar_system_id": 30003729,
"squad_id": 3129411261968,
"station_id": 61000180,
"takes_fleet_warp": true,
"wing_id": 2073711261968
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"character_id": {
"description": "character_id integer",
"format": "int32",
"title": "get_fleets_fleet_id_members_character_id",
"type": "integer"
},
"join_time": {
"description": "join_time string",
"format": "date-time",
"title": "get_fleets_fleet_id_members_join_time",
"type": "string"
},
"role": {
"description": "Member’s role in fleet",
"enum": [
"fleet_commander",
"wing_commander",
"squad_commander",
"squad_member"
],
"title": "get_fleets_fleet_id_members_role",
"type": "string"
},
"role_name": {
"description": "Localized role names",
"title": "get_fleets_fleet_id_members_role_name",
"type": "string"
},
"ship_type_id": {
"description": "ship_type_id integer",
"format": "int32",
"title": "get_fleets_fleet_id_members_ship_type_id",
"type": "integer"
},
"solar_system_id": {
"description": "Solar system the member is located in",
"format": "int32",
"title": "get_fleets_fleet_id_members_solar_system_id",
"type": "integer"
},
"squad_id": {
"description": "ID of the squad the member is in. If not applicable, will be set to -1",
"format": "int64",
"title": "get_fleets_fleet_id_members_squad_id",
"type": "integer"
},
"station_id": {
"description": "Station in which the member is docked in, if applicable",
"format": "int64",
"title": "get_fleets_fleet_id_members_station_id",
"type": "integer"
},
"takes_fleet_warp": {
"description": "Whether the member take fleet warps",
"title": "get_fleets_fleet_id_members_takes_fleet_warp",
"type": "boolean"
},
"wing_id": {
"description": "ID of the wing the member is in. If not applicable, will be set to -1",
"format": "int64",
"title": "get_fleets_fleet_id_members_wing_id",
"type": "integer"
}
},
"required": [
"character_id",
"ship_type_id",
"wing_id",
"squad_id",
"role",
"role_name",
"join_time",
"takes_fleet_warp",
"solar_system_id"
],
"title": "get_fleets_fleet_id_members_200_ok",
"type": "object"
},
"title": "get_fleets_fleet_id_members_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.read_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_fleets_fleet_id_members_403_forbidden",
"type": "string"
}
},
"title": "get_fleets_fleet_id_members_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_fleets_fleet_id_members_404_not_found",
"type": "string"
}
},
"title": "get_fleets_fleet_id_members_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_fleets_fleet_id_members_500_internal_server_error",
"type": "string"
}
},
"title": "get_fleets_fleet_id_members_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.read_fleet.v1"
]
}
],
"summary": "Get fleet members",
"tags": [
"Fleets"
]
},
"post": {
"description": "Invite a character into the fleet, if a character has a CSPA charge set, it is not possible to invite them to the fleet using ESI\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/members/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/members/`\n\nAlternate route: `/dev/fleets/{fleet_id}/members/`\n",
"operationId": "post_fleets_fleet_id_members",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "Details of the invitation",
"in": "body",
"name": "invitation",
"required": true,
"schema": {
"description": "invitation object",
"properties": {
"character_id": {
"description": "The character you want to invite",
"format": "int32",
"title": "post_fleets_fleet_id_members_character_id",
"type": "integer"
},
"role": {
"description": "- If a character is invited with the `fleet_commander` role, neither `wing_id` or `squad_id` should be specified - If a character is invited with the `wing_commander` role, only `wing_id` should be specified - If a character is invited with the `squad_commander` role, both `wing_id` and `squad_id` should be specified - If a character is invited with the `squad_member` role, `wing_id` and `squad_id` should either both be specified or not specified at all. If they aren’t specified, the invited character will join any squad with available positions\n",
"enum": [
"fleet_commander",
"wing_commander",
"squad_commander",
"squad_member"
],
"title": "post_fleets_fleet_id_members_role",
"type": "string"
},
"squad_id": {
"description": "squad_id integer",
"format": "int64",
"minimum": 0,
"title": "post_fleets_fleet_id_members_squad_id",
"type": "integer"
},
"wing_id": {
"description": "wing_id integer",
"format": "int64",
"minimum": 0,
"title": "post_fleets_fleet_id_members_wing_id",
"type": "integer"
}
},
"required": [
"character_id",
"role"
],
"title": "post_fleets_fleet_id_members_invitation",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Fleet invitation sent"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_fleets_fleet_id_members_403_forbidden",
"type": "string"
}
},
"title": "post_fleets_fleet_id_members_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "post_fleets_fleet_id_members_404_not_found",
"type": "string"
}
},
"title": "post_fleets_fleet_id_members_not_found",
"type": "object"
}
},
"422": {
"description": "Errors in invitation",
"examples": {
"application/json": {
"error": "missing wing_id"
}
},
"schema": {
"description": "422 unprocessable entity object",
"properties": {
"error": {
"description": "error message",
"title": "post_fleets_fleet_id_members_error",
"type": "string"
}
},
"title": "post_fleets_fleet_id_members_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_fleets_fleet_id_members_500_internal_server_error",
"type": "string"
}
},
"title": "post_fleets_fleet_id_members_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Create fleet invitation",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/members/{member_id}/": {
"delete": {
"description": "Kick a fleet member\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`\n",
"operationId": "delete_fleets_fleet_id_members_member_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "The character ID of a member in this fleet",
"format": "int32",
"in": "path",
"name": "member_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Fleet member kicked"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_fleets_fleet_id_members_member_id_403_forbidden",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_members_member_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "delete_fleets_fleet_id_members_member_id_404_not_found",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_members_member_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_fleets_fleet_id_members_member_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_members_member_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Kick fleet member",
"tags": [
"Fleets"
]
},
"put": {
"description": "Move a fleet member around\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`\n",
"operationId": "put_fleets_fleet_id_members_member_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "The character ID of a member in this fleet",
"format": "int32",
"in": "path",
"name": "member_id",
"required": true,
"type": "integer"
},
{
"description": "Details of the invitation",
"in": "body",
"name": "movement",
"required": true,
"schema": {
"description": "movement object",
"properties": {
"role": {
"description": "- If a character is moved to the `fleet_commander` role, neither `wing_id` or `squad_id` should be specified - If a character is moved to the `wing_commander` role, only `wing_id` should be specified - If a character is moved to the `squad_commander` role, both `wing_id` and `squad_id` should be specified - If a character is moved to the `squad_member` role, both `wing_id` and `squad_id` should be specified\n",
"enum": [
"fleet_commander",
"wing_commander",
"squad_commander",
"squad_member"
],
"title": "put_fleets_fleet_id_members_member_id_role",
"type": "string"
},
"squad_id": {
"description": "squad_id integer",
"format": "int64",
"minimum": 0,
"title": "put_fleets_fleet_id_members_member_id_squad_id",
"type": "integer"
},
"wing_id": {
"description": "wing_id integer",
"format": "int64",
"minimum": 0,
"title": "put_fleets_fleet_id_members_member_id_wing_id",
"type": "integer"
}
},
"required": [
"role"
],
"title": "put_fleets_fleet_id_members_member_id_movement",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Fleet invitation sent"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_fleets_fleet_id_members_member_id_403_forbidden",
"type": "string"
}
},
"title": "put_fleets_fleet_id_members_member_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "put_fleets_fleet_id_members_member_id_404_not_found",
"type": "string"
}
},
"title": "put_fleets_fleet_id_members_member_id_not_found",
"type": "object"
}
},
"422": {
"description": "Errors in invitation",
"examples": {
"application/json": {
"error": "missing wing_id"
}
},
"schema": {
"description": "422 unprocessable entity object",
"properties": {
"error": {
"description": "error message",
"title": "put_fleets_fleet_id_members_member_id_error",
"type": "string"
}
},
"title": "put_fleets_fleet_id_members_member_id_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_fleets_fleet_id_members_member_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_fleets_fleet_id_members_member_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Move fleet member",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/squads/{squad_id}/": {
"delete": {
"description": "Delete a fleet squad, only empty squads can be deleted\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`\n",
"operationId": "delete_fleets_fleet_id_squads_squad_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "The squad to delete",
"format": "int64",
"in": "path",
"name": "squad_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Squad deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_fleets_fleet_id_squads_squad_id_403_forbidden",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_squads_squad_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "delete_fleets_fleet_id_squads_squad_id_404_not_found",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_squads_squad_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_fleets_fleet_id_squads_squad_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_squads_squad_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Delete fleet squad",
"tags": [
"Fleets"
]
},
"put": {
"description": "Rename a fleet squad\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`\n",
"operationId": "put_fleets_fleet_id_squads_squad_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "New name of the squad",
"in": "body",
"name": "naming",
"required": true,
"schema": {
"description": "naming object",
"properties": {
"name": {
"description": "name string",
"maxLength": 10,
"title": "put_fleets_fleet_id_squads_squad_id_name",
"type": "string"
}
},
"required": [
"name"
],
"title": "put_fleets_fleet_id_squads_squad_id_naming",
"type": "object"
}
},
{
"description": "The squad to rename",
"format": "int64",
"in": "path",
"name": "squad_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Squad renamed"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_fleets_fleet_id_squads_squad_id_403_forbidden",
"type": "string"
}
},
"title": "put_fleets_fleet_id_squads_squad_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "put_fleets_fleet_id_squads_squad_id_404_not_found",
"type": "string"
}
},
"title": "put_fleets_fleet_id_squads_squad_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_fleets_fleet_id_squads_squad_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_fleets_fleet_id_squads_squad_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Rename fleet squad",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/wings/": {
"get": {
"description": "Return information about wings in a fleet\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/wings/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/wings/`\n\nAlternate route: `/dev/fleets/{fleet_id}/wings/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_fleets_fleet_id_wings",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of fleet wings",
"examples": {
"application/json": [
{
"id": 2073711261968,
"name": "Wing 1",
"squads": [
{
"id": 3129411261968,
"name": "Squad 1"
}
]
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"id": {
"description": "id integer",
"format": "int64",
"title": "get_fleets_fleet_id_wings_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_fleets_fleet_id_wings_name",
"type": "string"
},
"squads": {
"description": "squads array",
"items": {
"description": "squad object",
"properties": {
"id": {
"description": "id integer",
"format": "int64",
"title": "get_fleets_fleet_id_wings_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_fleets_fleet_id_wings_name",
"type": "string"
}
},
"required": [
"name",
"id"
],
"title": "get_fleets_fleet_id_wings_squad",
"type": "object"
},
"title": "get_fleets_fleet_id_wings_squads",
"type": "array"
}
},
"required": [
"name",
"id",
"squads"
],
"title": "get_fleets_fleet_id_wings_200_ok",
"type": "object"
},
"title": "get_fleets_fleet_id_wings_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.read_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_fleets_fleet_id_wings_403_forbidden",
"type": "string"
}
},
"title": "get_fleets_fleet_id_wings_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_fleets_fleet_id_wings_404_not_found",
"type": "string"
}
},
"title": "get_fleets_fleet_id_wings_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_fleets_fleet_id_wings_500_internal_server_error",
"type": "string"
}
},
"title": "get_fleets_fleet_id_wings_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.read_fleet.v1"
]
}
],
"summary": "Get fleet wings",
"tags": [
"Fleets"
]
},
"post": {
"description": "Create a new wing in a fleet\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/wings/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/wings/`\n\nAlternate route: `/dev/fleets/{fleet_id}/wings/`\n",
"operationId": "post_fleets_fleet_id_wings",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "Wing created",
"examples": {
"application/json": {
"wing_id": 123
}
},
"schema": {
"description": "201 created object",
"properties": {
"wing_id": {
"description": "The wing_id of the newly created wing",
"format": "int64",
"title": "post_fleets_fleet_id_wings_wing_id",
"type": "integer"
}
},
"required": [
"wing_id"
],
"title": "post_fleets_fleet_id_wings_created",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_fleets_fleet_id_wings_403_forbidden",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "post_fleets_fleet_id_wings_404_not_found",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_fleets_fleet_id_wings_500_internal_server_error",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Create fleet wing",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/wings/{wing_id}/": {
"delete": {
"description": "Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`\n",
"operationId": "delete_fleets_fleet_id_wings_wing_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "The wing to delete",
"format": "int64",
"in": "path",
"name": "wing_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Wing deleted"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "delete_fleets_fleet_id_wings_wing_id_403_forbidden",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_wings_wing_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "delete_fleets_fleet_id_wings_wing_id_404_not_found",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_wings_wing_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "delete_fleets_fleet_id_wings_wing_id_500_internal_server_error",
"type": "string"
}
},
"title": "delete_fleets_fleet_id_wings_wing_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Delete fleet wing",
"tags": [
"Fleets"
]
},
"put": {
"description": "Rename a fleet wing\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`\n\nAlternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`\n",
"operationId": "put_fleets_fleet_id_wings_wing_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "New name of the wing",
"in": "body",
"name": "naming",
"required": true,
"schema": {
"description": "naming object",
"properties": {
"name": {
"description": "name string",
"maxLength": 10,
"title": "put_fleets_fleet_id_wings_wing_id_name",
"type": "string"
}
},
"required": [
"name"
],
"title": "put_fleets_fleet_id_wings_wing_id_naming",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "The wing to rename",
"format": "int64",
"in": "path",
"name": "wing_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Wing renamed"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "put_fleets_fleet_id_wings_wing_id_403_forbidden",
"type": "string"
}
},
"title": "put_fleets_fleet_id_wings_wing_id_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "put_fleets_fleet_id_wings_wing_id_404_not_found",
"type": "string"
}
},
"title": "put_fleets_fleet_id_wings_wing_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "put_fleets_fleet_id_wings_wing_id_500_internal_server_error",
"type": "string"
}
},
"title": "put_fleets_fleet_id_wings_wing_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Rename fleet wing",
"tags": [
"Fleets"
]
}
},
"/fleets/{fleet_id}/wings/{wing_id}/squads/": {
"post": {
"description": "Create a new squad in a fleet\n\n---\n\nAlternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/squads/`\n\nAlternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/squads/`\n\nAlternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/squads/`\n",
"operationId": "post_fleets_fleet_id_wings_wing_id_squads",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "ID for a fleet",
"format": "int64",
"in": "path",
"name": "fleet_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "The wing_id to create squad in",
"format": "int64",
"in": "path",
"name": "wing_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"201": {
"description": "Squad created",
"examples": {
"application/json": {
"squad_id": 123
}
},
"schema": {
"description": "201 created object",
"properties": {
"squad_id": {
"description": "The squad_id of the newly created squad",
"format": "int64",
"title": "post_fleets_fleet_id_wings_wing_id_squads_squad_id",
"type": "integer"
}
},
"required": [
"squad_id"
],
"title": "post_fleets_fleet_id_wings_wing_id_squads_created",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-fleets.write_fleet.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_fleets_fleet_id_wings_wing_id_squads_403_forbidden",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_wing_id_squads_forbidden",
"type": "object"
}
},
"404": {
"description": "The fleet does not exist or you don't have access to it",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "post_fleets_fleet_id_wings_wing_id_squads_404_not_found",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_wing_id_squads_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_fleets_fleet_id_wings_wing_id_squads_500_internal_server_error",
"type": "string"
}
},
"title": "post_fleets_fleet_id_wings_wing_id_squads_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-fleets.write_fleet.v1"
]
}
],
"summary": "Create fleet squad",
"tags": [
"Fleets"
]
}
},
"/incursions/": {
"get": {
"description": "Return a list of current incursions\n\n---\n\nAlternate route: `/v1/incursions/`\n\nAlternate route: `/legacy/incursions/`\n\nAlternate route: `/dev/incursions/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_incursions",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of incursions",
"examples": {
"application/json": [
{
"constellation_id": 20000607,
"faction_id": 500019,
"has_boss": true,
"infested_solar_systems": [
30004148,
30004149,
30004150,
30004151,
30004152,
30004153,
30004154
],
"influence": 1,
"staging_solar_system_id": 30004154,
"state": "mobilizing",
"type": "Incursion"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"constellation_id": {
"description": "The constellation id in which this incursion takes place",
"format": "int32",
"title": "get_incursions_constellation_id",
"type": "integer"
},
"faction_id": {
"description": "The attacking faction's id",
"format": "int32",
"title": "get_incursions_faction_id",
"type": "integer"
},
"has_boss": {
"description": "Whether the final encounter has boss or not",
"title": "get_incursions_has_boss",
"type": "boolean"
},
"infested_solar_systems": {
"description": "A list of infested solar system ids that are a part of this incursion",
"items": {
"description": "infested_solar_system integer",
"format": "int32",
"title": "get_incursions_infested_solar_system",
"type": "integer"
},
"title": "get_incursions_infested_solar_systems",
"type": "array"
},
"influence": {
"description": "Influence of this incursion as a float from 0 to 1",
"format": "float",
"title": "get_incursions_influence",
"type": "number"
},
"staging_solar_system_id": {
"description": "Staging solar system for this incursion",
"format": "int32",
"title": "get_incursions_staging_solar_system_id",
"type": "integer"
},
"state": {
"description": "The state of this incursion",
"enum": [
"withdrawing",
"mobilizing",
"established"
],
"title": "get_incursions_state",
"type": "string"
},
"type": {
"description": "The type of this incursion",
"title": "get_incursions_type",
"type": "string"
}
},
"required": [
"type",
"state",
"influence",
"has_boss",
"faction_id",
"constellation_id",
"staging_solar_system_id",
"infested_solar_systems"
],
"title": "get_incursions_200_ok",
"type": "object"
},
"title": "get_incursions_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_incursions_500_internal_server_error",
"type": "string"
}
},
"title": "get_incursions_internal_server_error",
"type": "object"
}
}
},
"summary": "List incursions",
"tags": [
"Incursions"
]
}
},
"/industry/facilities/": {
"get": {
"description": "Return a list of industry facilities\n\n---\n\nAlternate route: `/v1/industry/facilities/`\n\nAlternate route: `/legacy/industry/facilities/`\n\nAlternate route: `/dev/industry/facilities/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_industry_facilities",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of prices",
"examples": {
"application/json": [
{
"facility_id": 60012544,
"owner_id": 1000126,
"region_id": 10000001,
"solar_system_id": 30000032,
"tax": 0.1,
"type_id": 2502
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"facility_id": {
"description": "ID of the facility",
"format": "int64",
"title": "get_industry_facilities_facility_id",
"type": "integer"
},
"owner_id": {
"description": "Owner of the facility",
"format": "int32",
"title": "get_industry_facilities_owner_id",
"type": "integer"
},
"region_id": {
"description": "Region ID where the facility is",
"format": "int32",
"title": "get_industry_facilities_region_id",
"type": "integer"
},
"solar_system_id": {
"description": "Solar system ID where the facility is",
"format": "int32",
"title": "get_industry_facilities_solar_system_id",
"type": "integer"
},
"tax": {
"description": "Tax imposed by the facility",
"format": "float",
"title": "get_industry_facilities_tax",
"type": "number"
},
"type_id": {
"description": "Type ID of the facility",
"format": "int32",
"title": "get_industry_facilities_type_id",
"type": "integer"
}
},
"required": [
"facility_id",
"owner_id",
"type_id",
"solar_system_id",
"region_id"
],
"title": "get_industry_facilities_200_ok",
"type": "object"
},
"title": "get_industry_facilities_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_industry_facilities_500_internal_server_error",
"type": "string"
}
},
"title": "get_industry_facilities_internal_server_error",
"type": "object"
}
}
},
"summary": "List industry facilities",
"tags": [
"Industry"
]
}
},
"/industry/systems/": {
"get": {
"description": "Return cost indices for solar systems\n\n---\n\nAlternate route: `/v1/industry/systems/`\n\nAlternate route: `/legacy/industry/systems/`\n\nAlternate route: `/dev/industry/systems/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_industry_systems",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of cost indicies",
"examples": {
"application/json": [
{
"cost_indices": [
{
"activity": "invention",
"cost_index": 0.00480411064973412
}
],
"solar_system_id": 30011392
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"cost_indices": {
"description": "cost_indices array",
"items": {
"description": "cost_indice object",
"properties": {
"activity": {
"description": "activity string",
"enum": [
"none",
"manufacturing",
"researching_technology",
"researching_time_efficiency",
"researching_material_efficiency",
"copying",
"duplicating",
"invention",
"reverse_engineering"
],
"title": "get_industry_systems_activity",
"type": "string"
},
"cost_index": {
"description": "cost_index number",
"format": "float",
"title": "get_industry_systems_cost_index",
"type": "number"
}
},
"required": [
"activity",
"cost_index"
],
"title": "get_industry_systems_cost_indice",
"type": "object"
},
"title": "get_industry_systems_cost_indices",
"type": "array"
},
"solar_system_id": {
"description": "solar_system_id integer",
"format": "int32",
"title": "get_industry_systems_solar_system_id",
"type": "integer"
}
},
"required": [
"solar_system_id",
"cost_indices"
],
"title": "get_industry_systems_200_ok",
"type": "object"
},
"title": "get_industry_systems_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_industry_systems_500_internal_server_error",
"type": "string"
}
},
"title": "get_industry_systems_internal_server_error",
"type": "object"
}
}
},
"summary": "List solar system cost indices",
"tags": [
"Industry"
]
}
},
"/insurance/prices/": {
"get": {
"description": "Return available insurance levels for all ship types\n\n---\n\nAlternate route: `/v1/insurance/prices/`\n\nAlternate route: `/legacy/insurance/prices/`\n\nAlternate route: `/dev/insurance/prices/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_insurance_prices",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of insurance levels for all ship types",
"examples": {
"application/json": [
{
"levels": [
{
"cost": 10,
"name": "Basic",
"payout": 20
}
],
"type_id": 1
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"levels": {
"description": "A list of a available insurance levels for this ship type",
"items": {
"description": "level object",
"properties": {
"cost": {
"description": "cost number",
"format": "float",
"title": "get_insurance_prices_cost",
"type": "number"
},
"name": {
"description": "Localized insurance level",
"title": "get_insurance_prices_name",
"type": "string"
},
"payout": {
"description": "payout number",
"format": "float",
"title": "get_insurance_prices_payout",
"type": "number"
}
},
"required": [
"cost",
"payout",
"name"
],
"title": "get_insurance_prices_level",
"type": "object"
},
"title": "get_insurance_prices_levels",
"type": "array"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_insurance_prices_type_id",
"type": "integer"
}
},
"required": [
"type_id",
"levels"
],
"title": "get_insurance_prices_200_ok",
"type": "object"
},
"title": "get_insurance_prices_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_insurance_prices_500_internal_server_error",
"type": "string"
}
},
"title": "get_insurance_prices_internal_server_error",
"type": "object"
}
}
},
"summary": "List insurance levels",
"tags": [
"Insurance"
]
}
},
"/killmails/{killmail_id}/{killmail_hash}/": {
"get": {
"description": "Return a single killmail from its ID and hash\n\n---\n\nAlternate route: `/v1/killmails/{killmail_id}/{killmail_hash}/`\n\nAlternate route: `/legacy/killmails/{killmail_id}/{killmail_hash}/`\n\nAlternate route: `/dev/killmails/{killmail_id}/{killmail_hash}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_killmails_killmail_id_killmail_hash",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The killmail hash for verification",
"in": "path",
"name": "killmail_hash",
"required": true,
"type": "string"
},
{
"description": "The killmail ID to be queried",
"format": "int32",
"in": "path",
"name": "killmail_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A killmail",
"examples": {
"application/json": {
"attackers": [
{
"character_id": 95810944,
"corporation_id": 1000179,
"damage_done": 5745,
"faction_id": 500003,
"final_blow": true,
"security_status": -0.3,
"ship_type_id": 17841,
"weapon_type_id": 3074
}
],
"killmail_id": 56733821,
"killmail_time": "2016-10-22T17:13:36Z",
"solar_system_id": 30002976,
"victim": {
"alliance_id": 621338554,
"character_id": 92796241,
"corporation_id": 841363671,
"damage_taken": 5745,
"items": [
{
"flag": 20,
"item_type_id": 5973,
"quantity_dropped": 1,
"singleton": 0
}
],
"position": {
"x": 452186600569.4748,
"y": 146704961490.90222,
"z": 109514596532.54477
},
"ship_type_id": 17812
}
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"attackers": {
"description": "attackers array",
"items": {
"description": "attacker object",
"properties": {
"alliance_id": {
"description": "alliance_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_alliance_id",
"type": "integer"
},
"character_id": {
"description": "character_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_character_id",
"type": "integer"
},
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_corporation_id",
"type": "integer"
},
"damage_done": {
"description": "damage_done integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_damage_done",
"type": "integer"
},
"faction_id": {
"description": "faction_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_faction_id",
"type": "integer"
},
"final_blow": {
"description": "Was the attacker the one to achieve the final blow\n",
"title": "get_killmails_killmail_id_killmail_hash_final_blow",
"type": "boolean"
},
"security_status": {
"description": "Security status for the attacker\n",
"format": "float",
"title": "get_killmails_killmail_id_killmail_hash_security_status",
"type": "number"
},
"ship_type_id": {
"description": "What ship was the attacker flying\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_ship_type_id",
"type": "integer"
},
"weapon_type_id": {
"description": "What weapon was used by the attacker for the kill\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_weapon_type_id",
"type": "integer"
}
},
"required": [
"security_status",
"final_blow",
"damage_done"
],
"title": "get_killmails_killmail_id_killmail_hash_attacker",
"type": "object"
},
"title": "get_killmails_killmail_id_killmail_hash_attackers",
"type": "array"
},
"killmail_id": {
"description": "ID of the killmail",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_killmail_id",
"type": "integer"
},
"killmail_time": {
"description": "Time that the victim was killed and the killmail generated\n",
"format": "date-time",
"title": "get_killmails_killmail_id_killmail_hash_killmail_time",
"type": "string"
},
"moon_id": {
"description": "Moon if the kill took place at one",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_moon_id",
"type": "integer"
},
"solar_system_id": {
"description": "Solar system that the kill took place in\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_solar_system_id",
"type": "integer"
},
"victim": {
"description": "victim object",
"properties": {
"alliance_id": {
"description": "alliance_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_alliance_id",
"type": "integer"
},
"character_id": {
"description": "character_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_character_id",
"type": "integer"
},
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_corporation_id",
"type": "integer"
},
"damage_taken": {
"description": "How much total damage was taken by the victim\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_damage_taken",
"type": "integer"
},
"faction_id": {
"description": "faction_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_faction_id",
"type": "integer"
},
"items": {
"description": "items array",
"items": {
"description": "item object",
"properties": {
"flag": {
"description": "Flag for the location of the item\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_flag",
"type": "integer"
},
"item_type_id": {
"description": "item_type_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_item_type_id",
"type": "integer"
},
"items": {
"description": "items array",
"items": {
"description": "item object",
"properties": {
"flag": {
"description": "flag integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_flag",
"type": "integer"
},
"item_type_id": {
"description": "item_type_id integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_item_type_id",
"type": "integer"
},
"quantity_destroyed": {
"description": "quantity_destroyed integer",
"format": "int64",
"title": "get_killmails_killmail_id_killmail_hash_quantity_destroyed",
"type": "integer"
},
"quantity_dropped": {
"description": "quantity_dropped integer",
"format": "int64",
"title": "get_killmails_killmail_id_killmail_hash_quantity_dropped",
"type": "integer"
},
"singleton": {
"description": "singleton integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_singleton",
"type": "integer"
}
},
"required": [
"item_type_id",
"singleton",
"flag"
],
"title": "get_killmails_killmail_id_killmail_hash_item",
"type": "object"
},
"title": "get_killmails_killmail_id_killmail_hash_items",
"type": "array"
},
"quantity_destroyed": {
"description": "How many of the item were destroyed if any\n",
"format": "int64",
"title": "get_killmails_killmail_id_killmail_hash_quantity_destroyed",
"type": "integer"
},
"quantity_dropped": {
"description": "How many of the item were dropped if any\n",
"format": "int64",
"title": "get_killmails_killmail_id_killmail_hash_quantity_dropped",
"type": "integer"
},
"singleton": {
"description": "singleton integer",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_singleton",
"type": "integer"
}
},
"required": [
"item_type_id",
"singleton",
"flag"
],
"title": "get_killmails_killmail_id_killmail_hash_item",
"type": "object"
},
"title": "get_killmails_killmail_id_killmail_hash_items",
"type": "array"
},
"position": {
"description": "Coordinates of the victim in Cartesian space relative to the Sun\n",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_killmails_killmail_id_killmail_hash_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_killmails_killmail_id_killmail_hash_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_killmails_killmail_id_killmail_hash_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_killmails_killmail_id_killmail_hash_position",
"type": "object"
},
"ship_type_id": {
"description": "The ship that the victim was piloting and was destroyed\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_ship_type_id",
"type": "integer"
}
},
"required": [
"damage_taken",
"ship_type_id"
],
"title": "get_killmails_killmail_id_killmail_hash_victim",
"type": "object"
},
"war_id": {
"description": "War if the killmail is generated in relation to an official war\n",
"format": "int32",
"title": "get_killmails_killmail_id_killmail_hash_war_id",
"type": "integer"
}
},
"required": [
"killmail_id",
"killmail_time",
"victim",
"attackers",
"solar_system_id"
],
"title": "get_killmails_killmail_id_killmail_hash_ok",
"type": "object"
}
},
"422": {
"description": "Invalid killmail_id and/or killmail_hash",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "get_killmails_killmail_id_killmail_hash_422_unprocessable_entity",
"type": "string"
}
},
"title": "get_killmails_killmail_id_killmail_hash_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_killmails_killmail_id_killmail_hash_500_internal_server_error",
"type": "string"
}
},
"title": "get_killmails_killmail_id_killmail_hash_internal_server_error",
"type": "object"
}
}
},
"summary": "Get a single killmail",
"tags": [
"Killmails"
]
}
},
"/markets/prices/": {
"get": {
"description": "Return a list of prices\n\n---\n\nAlternate route: `/v1/markets/prices/`\n\nAlternate route: `/legacy/markets/prices/`\n\nAlternate route: `/dev/markets/prices/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_markets_prices",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of prices",
"examples": {
"application/json": [
{
"adjusted_price": 306988.09,
"average_price": 306292.67,
"type_id": 32772
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"adjusted_price": {
"description": "adjusted_price number",
"format": "float",
"title": "get_markets_prices_adjusted_price",
"type": "number"
},
"average_price": {
"description": "average_price number",
"format": "float",
"title": "get_markets_prices_average_price",
"type": "number"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_markets_prices_type_id",
"type": "integer"
}
},
"required": [
"type_id"
],
"title": "get_markets_prices_200_ok",
"type": "object"
},
"title": "get_markets_prices_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_markets_prices_500_internal_server_error",
"type": "string"
}
},
"title": "get_markets_prices_internal_server_error",
"type": "object"
}
}
},
"summary": "List market prices",
"tags": [
"Market"
]
}
},
"/markets/structures/{structure_id}/": {
"get": {
"description": "Return all orders in a structure\n\n---\n\nAlternate route: `/v1/markets/structures/{structure_id}/`\n\nAlternate route: `/legacy/markets/structures/{structure_id}/`\n\nAlternate route: `/dev/markets/structures/{structure_id}/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_markets_structures_structure_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 1,
"description": "Which page to query, starting at 1",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Return orders in this structure",
"format": "int64",
"in": "path",
"name": "structure_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of orders",
"examples": {
"application/json": [
{
"duration": 90,
"is_buy_order": false,
"issued": "2016-09-03T05:12:25Z",
"location_id": 60005599,
"min_volume": 1,
"order_id": 4623824223,
"price": 9.9,
"range": "region",
"type_id": 34,
"volume_remain": 1296000,
"volume_total": 2000000
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"duration": {
"description": "duration integer",
"format": "int32",
"title": "get_markets_structures_structure_id_duration",
"type": "integer"
},
"is_buy_order": {
"description": "is_buy_order boolean",
"title": "get_markets_structures_structure_id_is_buy_order",
"type": "boolean"
},
"issued": {
"description": "issued string",
"format": "date-time",
"title": "get_markets_structures_structure_id_issued",
"type": "string"
},
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_markets_structures_structure_id_location_id",
"type": "integer"
},
"min_volume": {
"description": "min_volume integer",
"format": "int32",
"title": "get_markets_structures_structure_id_min_volume",
"type": "integer"
},
"order_id": {
"description": "order_id integer",
"format": "int64",
"title": "get_markets_structures_structure_id_order_id",
"type": "integer"
},
"price": {
"description": "price number",
"format": "float",
"title": "get_markets_structures_structure_id_price",
"type": "number"
},
"range": {
"description": "range string",
"enum": [
"station",
"region",
"solarsystem",
"1",
"2",
"3",
"4",
"5",
"10",
"20",
"30",
"40"
],
"title": "get_markets_structures_structure_id_range",
"type": "string"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_markets_structures_structure_id_type_id",
"type": "integer"
},
"volume_remain": {
"description": "volume_remain integer",
"format": "int32",
"title": "get_markets_structures_structure_id_volume_remain",
"type": "integer"
},
"volume_total": {
"description": "volume_total integer",
"format": "int32",
"title": "get_markets_structures_structure_id_volume_total",
"type": "integer"
}
},
"required": [
"order_id",
"type_id",
"location_id",
"volume_total",
"volume_remain",
"min_volume",
"price",
"is_buy_order",
"duration",
"issued",
"range"
],
"title": "get_markets_structures_structure_id_200_ok",
"type": "object"
},
"title": "get_markets_structures_structure_id_ok",
"type": "array"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-markets.structure_markets.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_markets_structures_structure_id_403_forbidden",
"type": "string"
}
},
"title": "get_markets_structures_structure_id_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_markets_structures_structure_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_markets_structures_structure_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-markets.structure_markets.v1"
]
}
],
"summary": "List orders in a structure",
"tags": [
"Market"
]
}
},
"/markets/{region_id}/history/": {
"get": {
"description": "Return a list of historical market statistics for the specified type in a region\n\n---\n\nAlternate route: `/v1/markets/{region_id}/history/`\n\nAlternate route: `/legacy/markets/{region_id}/history/`\n\nAlternate route: `/dev/markets/{region_id}/history/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_markets_region_id_history",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Return statistics in this region",
"format": "int32",
"in": "path",
"name": "region_id",
"required": true,
"type": "integer"
},
{
"description": "Return statistics for this type",
"format": "int32",
"in": "query",
"name": "type_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of historical market statistics",
"examples": {
"application/json": [
{
"average": 5.25,
"date": "2015-05-01",
"highest": 5.27,
"lowest": 5.11,
"order_count": 2267,
"volume": 16276782035
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"average": {
"description": "average number",
"format": "float",
"title": "get_markets_region_id_history_average",
"type": "number"
},
"date": {
"description": "The date of this historical statistic entry",
"format": "date",
"title": "get_markets_region_id_history_date",
"type": "string"
},
"highest": {
"description": "highest number",
"format": "float",
"title": "get_markets_region_id_history_highest",
"type": "number"
},
"lowest": {
"description": "lowest number",
"format": "float",
"title": "get_markets_region_id_history_lowest",
"type": "number"
},
"order_count": {
"description": "Total number of orders happened that day",
"format": "int64",
"title": "get_markets_region_id_history_order_count",
"type": "integer"
},
"volume": {
"description": "Total",
"format": "int64",
"title": "get_markets_region_id_history_volume",
"type": "integer"
}
},
"required": [
"date",
"order_count",
"volume",
"highest",
"average",
"lowest"
],
"title": "get_markets_region_id_history_200_ok",
"type": "object"
},
"title": "get_markets_region_id_history_ok",
"type": "array"
}
},
"422": {
"description": "Not found",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "get_markets_region_id_history_422_unprocessable_entity",
"type": "string"
}
},
"title": "get_markets_region_id_history_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_markets_region_id_history_500_internal_server_error",
"type": "string"
}
},
"title": "get_markets_region_id_history_internal_server_error",
"type": "object"
}
}
},
"summary": "List historical market statistics in a region",
"tags": [
"Market"
]
}
},
"/markets/{region_id}/orders/": {
"get": {
"description": "Return a list of orders in a region\n\n---\n\nAlternate route: `/v1/markets/{region_id}/orders/`\n\nAlternate route: `/legacy/markets/{region_id}/orders/`\n\nAlternate route: `/dev/markets/{region_id}/orders/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_markets_region_id_orders",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "all",
"description": "Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders.\n",
"enum": [
"buy",
"sell",
"all"
],
"in": "query",
"name": "order_type",
"required": true,
"type": "string"
},
{
"default": 1,
"description": "Which page to query, only used for querying without type_id. Starting at 1\n",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Return orders in this region",
"format": "int32",
"in": "path",
"name": "region_id",
"required": true,
"type": "integer"
},
{
"description": "Return orders only for this type",
"format": "int32",
"in": "query",
"name": "type_id",
"required": false,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of orders",
"examples": {
"application/json": [
{
"duration": 90,
"is_buy_order": false,
"issued": "2016-09-03T05:12:25Z",
"location_id": 60005599,
"min_volume": 1,
"order_id": 4623824223,
"price": 9.9,
"range": "region",
"type_id": 34,
"volume_remain": 1296000,
"volume_total": 2000000
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"duration": {
"description": "duration integer",
"format": "int32",
"title": "get_markets_region_id_orders_duration",
"type": "integer"
},
"is_buy_order": {
"description": "is_buy_order boolean",
"title": "get_markets_region_id_orders_is_buy_order",
"type": "boolean"
},
"issued": {
"description": "issued string",
"format": "date-time",
"title": "get_markets_region_id_orders_issued",
"type": "string"
},
"location_id": {
"description": "location_id integer",
"format": "int64",
"title": "get_markets_region_id_orders_location_id",
"type": "integer"
},
"min_volume": {
"description": "min_volume integer",
"format": "int32",
"title": "get_markets_region_id_orders_min_volume",
"type": "integer"
},
"order_id": {
"description": "order_id integer",
"format": "int64",
"title": "get_markets_region_id_orders_order_id",
"type": "integer"
},
"price": {
"description": "price number",
"format": "float",
"title": "get_markets_region_id_orders_price",
"type": "number"
},
"range": {
"description": "range string",
"enum": [
"station",
"region",
"solarsystem",
"1",
"2",
"3",
"4",
"5",
"10",
"20",
"30",
"40"
],
"title": "get_markets_region_id_orders_range",
"type": "string"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_markets_region_id_orders_type_id",
"type": "integer"
},
"volume_remain": {
"description": "volume_remain integer",
"format": "int32",
"title": "get_markets_region_id_orders_volume_remain",
"type": "integer"
},
"volume_total": {
"description": "volume_total integer",
"format": "int32",
"title": "get_markets_region_id_orders_volume_total",
"type": "integer"
}
},
"required": [
"order_id",
"type_id",
"location_id",
"volume_total",
"volume_remain",
"min_volume",
"price",
"is_buy_order",
"duration",
"issued",
"range"
],
"title": "get_markets_region_id_orders_200_ok",
"type": "object"
},
"title": "get_markets_region_id_orders_ok",
"type": "array"
}
},
"422": {
"description": "Not found",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "get_markets_region_id_orders_422_unprocessable_entity",
"type": "string"
}
},
"title": "get_markets_region_id_orders_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_markets_region_id_orders_500_internal_server_error",
"type": "string"
}
},
"title": "get_markets_region_id_orders_internal_server_error",
"type": "object"
}
}
},
"summary": "List orders in a region",
"tags": [
"Market"
]
}
},
"/search/": {
"get": {
"description": "Search for entities that match a given sub-string.\n\n---\n\nAlternate route: `/v1/search/`\n\nAlternate route: `/legacy/search/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_search",
"parameters": [
{
"description": "Type of entities to search for",
"in": "query",
"items": {
"enum": [
"agent",
"alliance",
"character",
"constellation",
"corporation",
"faction",
"inventorytype",
"region",
"solarsystem",
"station",
"wormhole"
],
"type": "string"
},
"minItems": 1,
"name": "categories",
"required": true,
"type": "array",
"uniqueItems": true
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Search locale",
"enum": [
"en-us",
"de",
"fr",
"ru",
"ja",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "The string to search on",
"in": "query",
"minLength": 3,
"name": "search",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Whether the search should be a strict match",
"in": "query",
"name": "strict",
"type": "boolean"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of search results",
"examples": {
"application/json": {
"solarsystem": [
30002510
],
"station": [
60004588,
60004594,
60005725,
60009106,
60012721,
60012724,
60012727
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"agent": {
"description": "agent array",
"items": {
"description": "agent integer",
"format": "int32",
"title": "get_search_agent",
"type": "integer"
},
"title": "get_search_agent",
"type": "array"
},
"alliance": {
"description": "alliance array",
"items": {
"description": "alliance integer",
"format": "int32",
"title": "get_search_alliance",
"type": "integer"
},
"title": "get_search_alliance",
"type": "array"
},
"character": {
"description": "character array",
"items": {
"description": "character integer",
"format": "int32",
"title": "get_search_character",
"type": "integer"
},
"title": "get_search_character",
"type": "array"
},
"constellation": {
"description": "constellation array",
"items": {
"description": "constellation integer",
"format": "int32",
"title": "get_search_constellation",
"type": "integer"
},
"title": "get_search_constellation",
"type": "array"
},
"corporation": {
"description": "corporation array",
"items": {
"description": "corporation integer",
"format": "int32",
"title": "get_search_corporation",
"type": "integer"
},
"title": "get_search_corporation",
"type": "array"
},
"faction": {
"description": "faction array",
"items": {
"description": "faction integer",
"format": "int32",
"title": "get_search_faction",
"type": "integer"
},
"title": "get_search_faction",
"type": "array"
},
"inventorytype": {
"description": "inventorytype array",
"items": {
"description": "inventorytype integer",
"format": "int32",
"title": "get_search_inventorytype",
"type": "integer"
},
"title": "get_search_inventorytype",
"type": "array"
},
"region": {
"description": "region array",
"items": {
"description": "region integer",
"format": "int32",
"title": "get_search_region",
"type": "integer"
},
"title": "get_search_region",
"type": "array"
},
"solarsystem": {
"description": "solarsystem array",
"items": {
"description": "solarsystem integer",
"format": "int32",
"title": "get_search_solarsystem",
"type": "integer"
},
"title": "get_search_solarsystem",
"type": "array"
},
"station": {
"description": "station array",
"items": {
"description": "station integer",
"format": "int32",
"title": "get_search_station",
"type": "integer"
},
"title": "get_search_station",
"type": "array"
},
"wormhole": {
"description": "wormhole array",
"items": {
"description": "wormhole integer",
"format": "int32",
"title": "get_search_wormhole",
"type": "integer"
},
"title": "get_search_wormhole",
"type": "array"
}
},
"title": "get_search_ok",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_search_500_internal_server_error",
"type": "string"
}
},
"title": "get_search_internal_server_error",
"type": "object"
}
}
},
"summary": "Search on a string",
"tags": [
"Search"
]
}
},
"/sovereignty/campaigns/": {
"get": {
"description": "Shows sovereignty data for campaigns.\n\n---\n\nAlternate route: `/v1/sovereignty/campaigns/`\n\nAlternate route: `/legacy/sovereignty/campaigns/`\n\nAlternate route: `/dev/sovereignty/campaigns/`\n\n\n---\n\nThis route is cached for up to 5 seconds",
"operationId": "get_sovereignty_campaigns",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of sovereignty campaigns",
"examples": {
"application/json": [
{
"attackers_score": 0.4,
"campaign_id": 32833,
"constellation_id": 20000125,
"defender_id": 1695357456,
"defender_score": 0.6,
"event_type": "station_defense",
"solar_system_id": 30000856,
"start_time": "2016-10-29T14:34:40Z",
"structure_id": 61001096
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"attackers_score": {
"description": "Score for all attacking parties, only present in Defense Events.\n",
"format": "float",
"title": "get_sovereignty_campaigns_attackers_score",
"type": "number"
},
"campaign_id": {
"description": "Unique ID for this campaign.",
"format": "int32",
"title": "get_sovereignty_campaigns_campaign_id",
"type": "integer"
},
"constellation_id": {
"description": "The constellation in which the campaign will take place.\n",
"format": "int32",
"title": "get_sovereignty_campaigns_constellation_id",
"type": "integer"
},
"defender_id": {
"description": "Defending alliance, only present in Defense Events\n",
"format": "int32",
"title": "get_sovereignty_campaigns_defender_id",
"type": "integer"
},
"defender_score": {
"description": "Score for the defending alliance, only present in Defense Events.\n",
"format": "float",
"title": "get_sovereignty_campaigns_defender_score",
"type": "number"
},
"event_type": {
"description": "Type of event this campaign is for. tcu_defense, ihub_defense and station_defense are referred to as \"Defense Events\", station_freeport as \"Freeport Events\".\n",
"enum": [
"tcu_defense",
"ihub_defense",
"station_defense",
"station_freeport"
],
"title": "get_sovereignty_campaigns_event_type",
"type": "string"
},
"participants": {
"description": "Alliance participating and their respective scores, only present in Freeport Events.\n",
"items": {
"description": "participant object",
"properties": {
"alliance_id": {
"description": "alliance_id integer",
"format": "int32",
"title": "get_sovereignty_campaigns_alliance_id",
"type": "integer"
},
"score": {
"description": "score number",
"format": "float",
"title": "get_sovereignty_campaigns_score",
"type": "number"
}
},
"required": [
"alliance_id",
"score"
],
"title": "get_sovereignty_campaigns_participant",
"type": "object"
},
"title": "get_sovereignty_campaigns_participants",
"type": "array"
},
"solar_system_id": {
"description": "The solar system the structure is located in.\n",
"format": "int32",
"title": "get_sovereignty_campaigns_solar_system_id",
"type": "integer"
},
"start_time": {
"description": "Time the event is scheduled to start.\n",
"format": "date-time",
"title": "get_sovereignty_campaigns_start_time",
"type": "string"
},
"structure_id": {
"description": "The structure item ID that is related to this campaign.\n",
"format": "int64",
"title": "get_sovereignty_campaigns_structure_id",
"type": "integer"
}
},
"required": [
"campaign_id",
"structure_id",
"solar_system_id",
"constellation_id",
"event_type",
"start_time"
],
"title": "get_sovereignty_campaigns_200_ok",
"type": "object"
},
"title": "get_sovereignty_campaigns_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_sovereignty_campaigns_500_internal_server_error",
"type": "string"
}
},
"title": "get_sovereignty_campaigns_internal_server_error",
"type": "object"
}
}
},
"summary": "List sovereignty campaigns",
"tags": [
"Sovereignty"
]
}
},
"/sovereignty/structures/": {
"get": {
"description": "Shows sovereignty data for structures.\n\n---\n\nAlternate route: `/v1/sovereignty/structures/`\n\nAlternate route: `/legacy/sovereignty/structures/`\n\nAlternate route: `/dev/sovereignty/structures/`\n\n\n---\n\nThis route is cached for up to 120 seconds",
"operationId": "get_sovereignty_structures",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of sovereignty structures",
"examples": {
"application/json": [
{
"alliance_id": 498125261,
"solar_system_id": 30000570,
"structure_id": 1018253388776,
"structure_type_id": 32226,
"vulnerability_occupancy_level": 2,
"vulnerable_end_time": "2016-10-29T05:30:00Z",
"vulnerable_start_time": "2016-10-28T20:30:00Z"
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"alliance_id": {
"description": "The alliance that owns the structure.\n",
"format": "int32",
"title": "get_sovereignty_structures_alliance_id",
"type": "integer"
},
"solar_system_id": {
"description": "Solar system in which the structure is located.\n",
"format": "int32",
"title": "get_sovereignty_structures_solar_system_id",
"type": "integer"
},
"structure_id": {
"description": "Unique item ID for this structure.",
"format": "int64",
"title": "get_sovereignty_structures_structure_id",
"type": "integer"
},
"structure_type_id": {
"description": "A reference to the type of structure this is.\n",
"format": "int32",
"title": "get_sovereignty_structures_structure_type_id",
"type": "integer"
},
"vulnerability_occupancy_level": {
"description": "The occupancy level for the next or current vulnerability window. This takes into account all development indexes and capital system bonuses. Also known as Activity Defense Multiplier from in the client. It increases the time that attackers must spend using their entosis links on the structure.\n",
"format": "float",
"title": "get_sovereignty_structures_vulnerability_occupancy_level",
"type": "number"
},
"vulnerable_end_time": {
"description": "The time at which the next or current vulnerability window ends. At the end of a vulnerability window the next window is recalculated and locked in along with the vulnerabilityOccupancyLevel. If the structure is not in 100% entosis control of the defender, it will go in to 'overtime' and stay vulnerable for as long as that situation persists. Only once the defenders have 100% entosis control and has the vulnerableEndTime passed does the vulnerability interval expire and a new one is calculated.\n",
"format": "date-time",
"title": "get_sovereignty_structures_vulnerable_end_time",
"type": "string"
},
"vulnerable_start_time": {
"description": "The next time at which the structure will become vulnerable. Or the start time of the current window if current time is between this and vulnerableEndTime.\n",
"format": "date-time",
"title": "get_sovereignty_structures_vulnerable_start_time",
"type": "string"
}
},
"required": [
"alliance_id",
"solar_system_id",
"structure_id",
"structure_type_id"
],
"title": "get_sovereignty_structures_200_ok",
"type": "object"
},
"title": "get_sovereignty_structures_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_sovereignty_structures_500_internal_server_error",
"type": "string"
}
},
"title": "get_sovereignty_structures_internal_server_error",
"type": "object"
}
}
},
"summary": "List sovereignty structures",
"tags": [
"Sovereignty"
]
}
},
"/ui/autopilot/waypoint/": {
"post": {
"description": "Set a solar system as autopilot waypoint\n\n---\n\nAlternate route: `/v2/ui/autopilot/waypoint/`\n\nAlternate route: `/dev/ui/autopilot/waypoint/`\n",
"operationId": "post_ui_autopilot_waypoint",
"parameters": [
{
"default": false,
"description": "Whether this solar system should be added to the beginning of all waypoints",
"in": "query",
"name": "add_to_beginning",
"required": true,
"type": "boolean"
},
{
"default": false,
"description": "Whether clean other waypoints beforing adding this one",
"in": "query",
"name": "clear_other_waypoints",
"required": true,
"type": "boolean"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The destination to travel to, can be solar system, station or structure's id",
"format": "int64",
"in": "query",
"name": "destination_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Open window request received"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-ui.write_waypoint.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_ui_autopilot_waypoint_403_forbidden",
"type": "string"
}
},
"title": "post_ui_autopilot_waypoint_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_ui_autopilot_waypoint_500_internal_server_error",
"type": "string"
}
},
"title": "post_ui_autopilot_waypoint_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-ui.write_waypoint.v1"
]
}
],
"summary": "Set Autopilot Waypoint",
"tags": [
"User Interface"
]
}
},
"/ui/openwindow/contract/": {
"post": {
"description": "Open the contract window inside the client\n\n---\n\nAlternate route: `/v1/ui/openwindow/contract/`\n\nAlternate route: `/legacy/ui/openwindow/contract/`\n\nAlternate route: `/dev/ui/openwindow/contract/`\n",
"operationId": "post_ui_openwindow_contract",
"parameters": [
{
"description": "The contract to open",
"format": "int32",
"in": "query",
"name": "contract_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Open window request received"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-ui.open_window.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_ui_openwindow_contract_403_forbidden",
"type": "string"
}
},
"title": "post_ui_openwindow_contract_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_ui_openwindow_contract_500_internal_server_error",
"type": "string"
}
},
"title": "post_ui_openwindow_contract_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-ui.open_window.v1"
]
}
],
"summary": "Open Contract Window",
"tags": [
"User Interface"
]
}
},
"/ui/openwindow/information/": {
"post": {
"description": "Open the information window for a character, corporation or alliance inside the client\n\n---\n\nAlternate route: `/v1/ui/openwindow/information/`\n\nAlternate route: `/legacy/ui/openwindow/information/`\n\nAlternate route: `/dev/ui/openwindow/information/`\n",
"operationId": "post_ui_openwindow_information",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The target to open",
"format": "int32",
"in": "query",
"name": "target_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Open window request received"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-ui.open_window.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_ui_openwindow_information_403_forbidden",
"type": "string"
}
},
"title": "post_ui_openwindow_information_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_ui_openwindow_information_500_internal_server_error",
"type": "string"
}
},
"title": "post_ui_openwindow_information_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-ui.open_window.v1"
]
}
],
"summary": "Open Information Window",
"tags": [
"User Interface"
]
}
},
"/ui/openwindow/marketdetails/": {
"post": {
"description": "Open the market details window for a specific typeID inside the client\n\n---\n\nAlternate route: `/v1/ui/openwindow/marketdetails/`\n\nAlternate route: `/legacy/ui/openwindow/marketdetails/`\n\nAlternate route: `/dev/ui/openwindow/marketdetails/`\n",
"operationId": "post_ui_openwindow_marketdetails",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "The item type to open in market window",
"format": "int32",
"in": "query",
"name": "type_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Open window request received"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-ui.open_window.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_ui_openwindow_marketdetails_403_forbidden",
"type": "string"
}
},
"title": "post_ui_openwindow_marketdetails_forbidden",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_ui_openwindow_marketdetails_500_internal_server_error",
"type": "string"
}
},
"title": "post_ui_openwindow_marketdetails_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-ui.open_window.v1"
]
}
],
"summary": "Open Market Details",
"tags": [
"User Interface"
]
}
},
"/ui/openwindow/newmail/": {
"post": {
"description": "Open the New Mail window, according to settings from the request if applicable\n\n---\n\nAlternate route: `/v1/ui/openwindow/newmail/`\n\nAlternate route: `/legacy/ui/openwindow/newmail/`\n\nAlternate route: `/dev/ui/openwindow/newmail/`\n",
"operationId": "post_ui_openwindow_newmail",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The details of mail to create",
"in": "body",
"name": "new_mail",
"required": true,
"schema": {
"description": "new_mail object",
"properties": {
"body": {
"description": "body string",
"maxLength": 10000,
"title": "post_ui_openwindow_newmail_body",
"type": "string"
},
"recipients": {
"description": "recipients array",
"items": {
"description": "recipient integer",
"format": "int32",
"title": "post_ui_openwindow_newmail_recipient",
"type": "integer"
},
"maxItems": 50,
"minItems": 1,
"title": "post_ui_openwindow_newmail_recipients",
"type": "array"
},
"subject": {
"description": "subject string",
"maxLength": 1000,
"title": "post_ui_openwindow_newmail_subject",
"type": "string"
},
"to_corp_or_alliance_id": {
"description": "to_corp_or_alliance_id integer",
"format": "int32",
"title": "post_ui_openwindow_newmail_to_corp_or_alliance_id",
"type": "integer"
},
"to_mailing_list_id": {
"description": "Corporations, alliances and mailing lists are all types of mailing groups. You may only send to one mailing group, at a time, so you may fill out either this field or the to_corp_or_alliance_ids field",
"format": "int32",
"title": "post_ui_openwindow_newmail_to_mailing_list_id",
"type": "integer"
}
},
"required": [
"subject",
"body",
"recipients"
],
"title": "post_ui_openwindow_newmail_new_mail",
"type": "object"
}
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"204": {
"description": "Open window request received"
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-ui.open_window.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "post_ui_openwindow_newmail_403_forbidden",
"type": "string"
}
},
"title": "post_ui_openwindow_newmail_forbidden",
"type": "object"
}
},
"422": {
"description": "Invalid request",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "post_ui_openwindow_newmail_422_unprocessable_entity",
"type": "string"
}
},
"title": "post_ui_openwindow_newmail_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_ui_openwindow_newmail_500_internal_server_error",
"type": "string"
}
},
"title": "post_ui_openwindow_newmail_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-ui.open_window.v1"
]
}
],
"summary": "Open New Mail Window",
"tags": [
"User Interface"
]
}
},
"/universe/bloodlines/": {
"get": {
"description": "Get a list of bloodlines\n\n---\n\nAlternate route: `/v1/universe/bloodlines/`\n\nAlternate route: `/legacy/universe/bloodlines/`\n\nAlternate route: `/dev/universe/bloodlines/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_bloodlines",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of bloodlines",
"examples": {
"application/json": [
{
"bloodline_id": 1,
"charisma": 6,
"corporation_id": 1000006,
"description": "The Deteis are regarded as ...",
"intelligence": 7,
"memory": 7,
"name": "Deteis",
"perception": 5,
"race_id": 1,
"ship_type_id": 601,
"willpower": 5
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"bloodline_id": {
"description": "bloodline_id integer",
"format": "int32",
"title": "get_universe_bloodlines_bloodline_id",
"type": "integer"
},
"charisma": {
"description": "charisma integer",
"format": "int32",
"title": "get_universe_bloodlines_charisma",
"type": "integer"
},
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_universe_bloodlines_corporation_id",
"type": "integer"
},
"description": {
"description": "description string",
"title": "get_universe_bloodlines_description",
"type": "string"
},
"intelligence": {
"description": "intelligence integer",
"format": "int32",
"title": "get_universe_bloodlines_intelligence",
"type": "integer"
},
"memory": {
"description": "memory integer",
"format": "int32",
"title": "get_universe_bloodlines_memory",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_bloodlines_name",
"type": "string"
},
"perception": {
"description": "perception integer",
"format": "int32",
"title": "get_universe_bloodlines_perception",
"type": "integer"
},
"race_id": {
"description": "race_id integer",
"format": "int32",
"title": "get_universe_bloodlines_race_id",
"type": "integer"
},
"ship_type_id": {
"description": "ship_type_id integer",
"format": "int32",
"title": "get_universe_bloodlines_ship_type_id",
"type": "integer"
},
"willpower": {
"description": "willpower integer",
"format": "int32",
"title": "get_universe_bloodlines_willpower",
"type": "integer"
}
},
"required": [
"bloodline_id",
"name",
"description",
"race_id",
"ship_type_id",
"corporation_id",
"perception",
"willpower",
"charisma",
"memory",
"intelligence"
],
"title": "get_universe_bloodlines_200_ok",
"type": "object"
},
"title": "get_universe_bloodlines_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_bloodlines_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_bloodlines_internal_server_error",
"type": "object"
}
}
},
"summary": "Get bloodlines",
"tags": [
"Universe"
]
}
},
"/universe/categories/": {
"get": {
"description": "Get a list of item categories\n\n---\n\nAlternate route: `/v1/universe/categories/`\n\nAlternate route: `/legacy/universe/categories/`\n\nAlternate route: `/dev/universe/categories/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_categories",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of item category ids",
"examples": {
"application/json": [
1,
2,
3
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_categories_200_ok",
"type": "integer"
},
"title": "get_universe_categories_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_categories_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_categories_internal_server_error",
"type": "object"
}
}
},
"summary": "Get item categories",
"tags": [
"Universe"
]
}
},
"/universe/categories/{category_id}/": {
"get": {
"description": "Get information of an item category\n\n---\n\nAlternate route: `/v1/universe/categories/{category_id}/`\n\nAlternate route: `/legacy/universe/categories/{category_id}/`\n\nAlternate route: `/dev/universe/categories/{category_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_categories_category_id",
"parameters": [
{
"description": "An Eve item category ID",
"format": "int32",
"in": "path",
"name": "category_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about an item category",
"examples": {
"application/json": {
"category_id": 6,
"groups": [
25,
26,
27
],
"name": "Ship",
"published": true
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"category_id": {
"description": "category_id integer",
"format": "int32",
"title": "get_universe_categories_category_id_category_id",
"type": "integer"
},
"groups": {
"description": "groups array",
"items": {
"description": "group integer",
"format": "int32",
"title": "get_universe_categories_category_id_group",
"type": "integer"
},
"title": "get_universe_categories_category_id_groups",
"type": "array"
},
"name": {
"description": "name string",
"title": "get_universe_categories_category_id_name",
"type": "string"
},
"published": {
"description": "published boolean",
"title": "get_universe_categories_category_id_published",
"type": "boolean"
}
},
"required": [
"category_id",
"name",
"published",
"groups"
],
"title": "get_universe_categories_category_id_ok",
"type": "object"
}
},
"404": {
"description": "Category not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_categories_category_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_categories_category_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_categories_category_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_categories_category_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get item category information",
"tags": [
"Universe"
]
}
},
"/universe/constellations/": {
"get": {
"description": "Get a list of constellations\n\n---\n\nAlternate route: `/v1/universe/constellations/`\n\nAlternate route: `/legacy/universe/constellations/`\n\nAlternate route: `/dev/universe/constellations/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_constellations",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of constellation ids",
"examples": {
"application/json": [
20000001,
20000002
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_constellations_200_ok",
"type": "integer"
},
"title": "get_universe_constellations_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_constellations_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_constellations_internal_server_error",
"type": "object"
}
}
},
"summary": "Get constellations",
"tags": [
"Universe"
]
}
},
"/universe/constellations/{constellation_id}/": {
"get": {
"description": "Get information on a constellation\n\n---\n\nAlternate route: `/v1/universe/constellations/{constellation_id}/`\n\nAlternate route: `/legacy/universe/constellations/{constellation_id}/`\n\nAlternate route: `/dev/universe/constellations/{constellation_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_constellations_constellation_id",
"parameters": [
{
"description": "constellation_id integer",
"format": "int32",
"in": "path",
"name": "constellation_id",
"required": true,
"type": "integer"
},
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a constellation",
"examples": {
"application/json": {
"constellation_id": 20000009,
"name": "Mekashtad",
"position": {
"x": 67796138757472320,
"y": -70591121348560960,
"z": -59587016159270070
},
"region_id": 10000001,
"systems": [
20000302,
20000303
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"constellation_id": {
"description": "constellation_id integer",
"format": "int32",
"title": "get_universe_constellations_constellation_id_constellation_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_constellations_constellation_id_name",
"type": "string"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_constellations_constellation_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_constellations_constellation_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_constellations_constellation_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_constellations_constellation_id_position",
"type": "object"
},
"region_id": {
"description": "The region this constellation is in",
"format": "int32",
"title": "get_universe_constellations_constellation_id_region_id",
"type": "integer"
},
"systems": {
"description": "systems array",
"items": {
"description": "system integer",
"format": "int32",
"title": "get_universe_constellations_constellation_id_system",
"type": "integer"
},
"title": "get_universe_constellations_constellation_id_systems",
"type": "array"
}
},
"required": [
"constellation_id",
"name",
"position",
"region_id",
"systems"
],
"title": "get_universe_constellations_constellation_id_ok",
"type": "object"
}
},
"404": {
"description": "Constellation not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_constellations_constellation_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_constellations_constellation_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_constellations_constellation_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_constellations_constellation_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get constellation information",
"tags": [
"Universe"
]
}
},
"/universe/factions/": {
"get": {
"description": "Get a list of factions\n\n---\n\nAlternate route: `/v1/universe/factions/`\n\nAlternate route: `/legacy/universe/factions/`\n\nAlternate route: `/dev/universe/factions/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_factions",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of factions",
"examples": {
"application/json": [
{
"corporation_id": 456,
"description": "blah blah",
"faction_id": 1,
"is_unique": true,
"name": "Faction",
"size_factor": 1,
"solar_system_id": 123,
"station_count": 1000,
"station_system_count": 100
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"corporation_id": {
"description": "corporation_id integer",
"format": "int32",
"title": "get_universe_factions_corporation_id",
"type": "integer"
},
"description": {
"description": "description string",
"title": "get_universe_factions_description",
"type": "string"
},
"faction_id": {
"description": "faction_id integer",
"format": "int32",
"title": "get_universe_factions_faction_id",
"type": "integer"
},
"is_unique": {
"description": "is_unique boolean",
"title": "get_universe_factions_is_unique",
"type": "boolean"
},
"militia_corporation_id": {
"description": "militia_corporation_id integer",
"format": "int32",
"title": "get_universe_factions_militia_corporation_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_factions_name",
"type": "string"
},
"size_factor": {
"description": "size_factor number",
"format": "float",
"title": "get_universe_factions_size_factor",
"type": "number"
},
"solar_system_id": {
"description": "solar_system_id integer",
"format": "int32",
"title": "get_universe_factions_solar_system_id",
"type": "integer"
},
"station_count": {
"description": "station_count integer",
"format": "int32",
"title": "get_universe_factions_station_count",
"type": "integer"
},
"station_system_count": {
"description": "station_system_count integer",
"format": "int32",
"title": "get_universe_factions_station_system_count",
"type": "integer"
}
},
"required": [
"faction_id",
"name",
"description",
"solar_system_id",
"corporation_id",
"size_factor",
"station_count",
"station_system_count",
"is_unique"
],
"title": "get_universe_factions_200_ok",
"type": "object"
},
"title": "get_universe_factions_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_factions_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_factions_internal_server_error",
"type": "object"
}
}
},
"summary": "Get factions",
"tags": [
"Universe"
]
}
},
"/universe/groups/": {
"get": {
"description": "Get a list of item groups\n\n---\n\nAlternate route: `/v1/universe/groups/`\n\nAlternate route: `/legacy/universe/groups/`\n\nAlternate route: `/dev/universe/groups/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_groups",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Which page to query",
"format": "int32",
"in": "query",
"minimum": 1,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of item group ids",
"examples": {
"application/json": [
1,
2,
3
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_groups_200_ok",
"type": "integer"
},
"title": "get_universe_groups_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_groups_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_groups_internal_server_error",
"type": "object"
}
}
},
"summary": "Get item groups",
"tags": [
"Universe"
]
}
},
"/universe/groups/{group_id}/": {
"get": {
"description": "Get information on an item group\n\n---\n\nAlternate route: `/v1/universe/groups/{group_id}/`\n\nAlternate route: `/legacy/universe/groups/{group_id}/`\n\nAlternate route: `/dev/universe/groups/{group_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_groups_group_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An Eve item group ID",
"format": "int32",
"in": "path",
"name": "group_id",
"required": true,
"type": "integer"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about an item group",
"examples": {
"application/json": {
"category_id": 6,
"group_id": 25,
"name": "Frigate",
"published": true,
"types": [
587,
586,
585
]
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"category_id": {
"description": "category_id number",
"format": "float",
"title": "get_universe_groups_group_id_category_id",
"type": "number"
},
"group_id": {
"description": "group_id integer",
"format": "int32",
"title": "get_universe_groups_group_id_group_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_groups_group_id_name",
"type": "string"
},
"published": {
"description": "published boolean",
"title": "get_universe_groups_group_id_published",
"type": "boolean"
},
"types": {
"description": "types array",
"items": {
"description": "type integer",
"format": "int32",
"title": "get_universe_groups_group_id_type",
"type": "integer"
},
"title": "get_universe_groups_group_id_types",
"type": "array"
}
},
"required": [
"group_id",
"name",
"published",
"category_id",
"types"
],
"title": "get_universe_groups_group_id_ok",
"type": "object"
}
},
"404": {
"description": "Group not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_groups_group_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_groups_group_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_groups_group_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_groups_group_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get item group information",
"tags": [
"Universe"
]
}
},
"/universe/moons/{moon_id}/": {
"get": {
"description": "Get information on a moon\n\n---\n\nAlternate route: `/v1/universe/moons/{moon_id}/`\n\nAlternate route: `/legacy/universe/moons/{moon_id}/`\n\nAlternate route: `/dev/universe/moons/{moon_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_moons_moon_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "moon_id integer",
"format": "int32",
"in": "path",
"name": "moon_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a moon",
"examples": {
"application/json": {
"moon_id": 40000042,
"name": "Akpivem I - Moon 1",
"position": {
"x": 58605102008,
"y": -3066616285,
"z": -55193617920
},
"system_id": 30000003
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"moon_id": {
"description": "moon_id integer",
"format": "int32",
"title": "get_universe_moons_moon_id_moon_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_moons_moon_id_name",
"type": "string"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_moons_moon_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_moons_moon_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_moons_moon_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_moons_moon_id_position",
"type": "object"
},
"system_id": {
"description": "The solar system this moon is in",
"format": "int32",
"title": "get_universe_moons_moon_id_system_id",
"type": "integer"
}
},
"required": [
"moon_id",
"name",
"position",
"system_id"
],
"title": "get_universe_moons_moon_id_ok",
"type": "object"
}
},
"404": {
"description": "Moon not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_moons_moon_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_moons_moon_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_moons_moon_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_moons_moon_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get moon information",
"tags": [
"Universe"
]
}
},
"/universe/names/": {
"post": {
"description": "Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types.\n\n---\n\nAlternate route: `/v2/universe/names/`\n\nAlternate route: `/dev/universe/names/`\n",
"operationId": "post_universe_names",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "The ids to resolve",
"in": "body",
"name": "ids",
"required": true,
"schema": {
"description": "ids array",
"example": [
95465499,
30000142
],
"items": {
"description": "id integer",
"format": "int32",
"title": "post_universe_names_id",
"type": "integer"
},
"maxItems": 1000,
"minItems": 1,
"title": "post_universe_names_ids",
"type": "array",
"uniqueItems": true
}
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of id/name associations for a set of ID's. ID's that cannot be resolved are not returned.",
"examples": {
"application/json": [
{
"category": "character",
"id": 95465499,
"name": "CCP Bartender"
},
{
"category": "solar_system",
"id": 30000142,
"name": "Jita"
}
]
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"category": {
"description": "category string",
"enum": [
"alliance",
"character",
"constellation",
"corporation",
"inventory_type",
"region",
"solar_system",
"station"
],
"title": "post_universe_names_category",
"type": "string"
},
"id": {
"description": "id integer",
"format": "int32",
"title": "post_universe_names_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "post_universe_names_name",
"type": "string"
}
},
"required": [
"id",
"name",
"category"
],
"title": "post_universe_names_200_ok",
"type": "object"
},
"title": "post_universe_names_ok",
"type": "array"
}
},
"404": {
"description": "no valid IDs found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "post_universe_names_404_not_found",
"type": "string"
}
},
"title": "post_universe_names_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "post_universe_names_500_internal_server_error",
"type": "string"
}
},
"title": "post_universe_names_internal_server_error",
"type": "object"
}
}
},
"summary": "Get names and categories for a set of ID's",
"tags": [
"Universe"
]
}
},
"/universe/planets/{planet_id}/": {
"get": {
"description": "Get information on a planet\n\n---\n\nAlternate route: `/v1/universe/planets/{planet_id}/`\n\nAlternate route: `/legacy/universe/planets/{planet_id}/`\n\nAlternate route: `/dev/universe/planets/{planet_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_planets_planet_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "planet_id integer",
"format": "int32",
"in": "path",
"name": "planet_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a planet",
"examples": {
"application/json": {
"name": "Akpivem III",
"planet_id": 40000046,
"position": {
"x": -189226344497,
"y": 9901605317,
"z": -254852632979
},
"system_id": 30000003,
"type_id": 13
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"name": {
"description": "name string",
"title": "get_universe_planets_planet_id_name",
"type": "string"
},
"planet_id": {
"description": "planet_id integer",
"format": "int32",
"title": "get_universe_planets_planet_id_planet_id",
"type": "integer"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_planets_planet_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_planets_planet_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_planets_planet_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_planets_planet_id_position",
"type": "object"
},
"system_id": {
"description": "The solar system this planet is in",
"format": "int32",
"title": "get_universe_planets_planet_id_system_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_universe_planets_planet_id_type_id",
"type": "integer"
}
},
"required": [
"planet_id",
"name",
"type_id",
"position",
"system_id"
],
"title": "get_universe_planets_planet_id_ok",
"type": "object"
}
},
"404": {
"description": "Planet not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_planets_planet_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_planets_planet_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_planets_planet_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_planets_planet_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get planet information",
"tags": [
"Universe"
]
}
},
"/universe/races/": {
"get": {
"description": "Get a list of character races\n\n---\n\nAlternate route: `/v1/universe/races/`\n\nAlternate route: `/legacy/universe/races/`\n\nAlternate route: `/dev/universe/races/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_races",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of character races",
"examples": {
"application/json": [
{
"alliance_id": 500001,
"description": "Founded on the tenets of patriotism and hard work...",
"name": "Caldari",
"race_id": 1
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"alliance_id": {
"description": "The alliance generally associated with this race",
"format": "int32",
"title": "get_universe_races_alliance_id",
"type": "integer"
},
"description": {
"description": "description string",
"title": "get_universe_races_description",
"type": "string"
},
"name": {
"description": "name string",
"title": "get_universe_races_name",
"type": "string"
},
"race_id": {
"description": "race_id integer",
"format": "int32",
"title": "get_universe_races_race_id",
"type": "integer"
}
},
"required": [
"race_id",
"name",
"description",
"alliance_id"
],
"title": "get_universe_races_200_ok",
"type": "object"
},
"title": "get_universe_races_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_races_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_races_internal_server_error",
"type": "object"
}
}
},
"summary": "Get character races",
"tags": [
"Universe"
]
}
},
"/universe/regions/": {
"get": {
"description": "Get a list of regions\n\n---\n\nAlternate route: `/v1/universe/regions/`\n\nAlternate route: `/legacy/universe/regions/`\n\nAlternate route: `/dev/universe/regions/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_regions",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of region ids",
"examples": {
"application/json": [
11000001,
11000002
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_regions_200_ok",
"type": "integer"
},
"title": "get_universe_regions_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_regions_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_regions_internal_server_error",
"type": "object"
}
}
},
"summary": "Get regions",
"tags": [
"Universe"
]
}
},
"/universe/regions/{region_id}/": {
"get": {
"description": "Get information on a region\n\n---\n\nAlternate route: `/v1/universe/regions/{region_id}/`\n\nAlternate route: `/legacy/universe/regions/{region_id}/`\n\nAlternate route: `/dev/universe/regions/{region_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_regions_region_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "region_id integer",
"format": "int32",
"in": "path",
"name": "region_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a region",
"examples": {
"application/json": {
"constellations": [
20000302,
20000303
],
"description": "It has long been an established fact of civilization...",
"name": "Metropolis",
"region_id": 10000042
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"constellations": {
"description": "constellations array",
"items": {
"description": "constellation integer",
"format": "int32",
"title": "get_universe_regions_region_id_constellation",
"type": "integer"
},
"title": "get_universe_regions_region_id_constellations",
"type": "array"
},
"description": {
"description": "description string",
"title": "get_universe_regions_region_id_description",
"type": "string"
},
"name": {
"description": "name string",
"title": "get_universe_regions_region_id_name",
"type": "string"
},
"region_id": {
"description": "region_id integer",
"format": "int32",
"title": "get_universe_regions_region_id_region_id",
"type": "integer"
}
},
"required": [
"region_id",
"name",
"constellations"
],
"title": "get_universe_regions_region_id_ok",
"type": "object"
}
},
"404": {
"description": "Region not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_regions_region_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_regions_region_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_regions_region_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_regions_region_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get region information",
"tags": [
"Universe"
]
}
},
"/universe/schematics/{schematic_id}/": {
"get": {
"description": "Get information on a planetary factory schematic\n\n---\n\nAlternate route: `/v1/universe/schematics/{schematic_id}/`\n\nAlternate route: `/legacy/universe/schematics/{schematic_id}/`\n\nAlternate route: `/dev/universe/schematics/{schematic_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_schematics_schematic_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "A PI schematic ID",
"format": "int32",
"in": "path",
"name": "schematic_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Public data about a schematic",
"examples": {
"application/json": {
"cycle_time": 1800,
"schematic_name": "Bacteria"
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"cycle_time": {
"description": "Time in seconds to process a run",
"format": "int32",
"title": "get_universe_schematics_schematic_id_cycle_time",
"type": "integer"
},
"schematic_name": {
"description": "schematic_name string",
"title": "get_universe_schematics_schematic_id_schematic_name",
"type": "string"
}
},
"required": [
"schematic_name",
"cycle_time"
],
"title": "get_universe_schematics_schematic_id_ok",
"type": "object"
}
},
"404": {
"description": "Schematic not found",
"examples": {
"application/json": {
"error": "Schematic not found"
}
},
"schema": {
"description": "Schematic not found",
"properties": {
"error": {
"description": "error message",
"title": "get_universe_schematics_schematic_id_error",
"type": "string"
}
},
"title": "get_universe_schematics_schematic_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_schematics_schematic_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_schematics_schematic_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get schematic information",
"tags": [
"Planetary Interaction"
]
}
},
"/universe/stargates/{stargate_id}/": {
"get": {
"description": "Get information on a stargate\n\n---\n\nAlternate route: `/v1/universe/stargates/{stargate_id}/`\n\nAlternate route: `/legacy/universe/stargates/{stargate_id}/`\n\nAlternate route: `/dev/universe/stargates/{stargate_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_stargates_stargate_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "stargate_id integer",
"format": "int32",
"in": "path",
"name": "stargate_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a stargate",
"examples": {
"application/json": {
"destination": {
"stargate_id": 50000056,
"system_id": 30000001
},
"name": "Stargate (Tanoo)",
"position": {
"x": -101092761600,
"y": 5279539200,
"z": 1550503403520
},
"stargate_id": 50000342,
"system_id": 30000003,
"type_id": 29624
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"destination": {
"description": "destination object",
"properties": {
"stargate_id": {
"description": "The stargate this stargate connects to",
"format": "int32",
"title": "get_universe_stargates_stargate_id_stargate_id",
"type": "integer"
},
"system_id": {
"description": "The solar system this stargate connects to",
"format": "int32",
"title": "get_universe_stargates_stargate_id_system_id",
"type": "integer"
}
},
"required": [
"system_id",
"stargate_id"
],
"title": "get_universe_stargates_stargate_id_destination",
"type": "object"
},
"name": {
"description": "name string",
"title": "get_universe_stargates_stargate_id_name",
"type": "string"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_stargates_stargate_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_stargates_stargate_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_stargates_stargate_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_stargates_stargate_id_position",
"type": "object"
},
"stargate_id": {
"description": "stargate_id integer",
"format": "int32",
"title": "get_universe_stargates_stargate_id_stargate_id",
"type": "integer"
},
"system_id": {
"description": "The solar system this stargate is in",
"format": "int32",
"title": "get_universe_stargates_stargate_id_system_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_universe_stargates_stargate_id_type_id",
"type": "integer"
}
},
"required": [
"stargate_id",
"name",
"type_id",
"position",
"system_id",
"destination"
],
"title": "get_universe_stargates_stargate_id_ok",
"type": "object"
}
},
"404": {
"description": "Stargate not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_stargates_stargate_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_stargates_stargate_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_stargates_stargate_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_stargates_stargate_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get stargate information",
"tags": [
"Universe"
]
}
},
"/universe/stations/{station_id}/": {
"get": {
"description": "Get information on a station\n\n---\n\nAlternate route: `/v2/universe/stations/{station_id}/`\n\nAlternate route: `/dev/universe/stations/{station_id}/`\n\n\n---\n\nThis route is cached for up to 300 seconds",
"operationId": "get_universe_stations_station_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "station_id integer",
"format": "int32",
"in": "path",
"name": "station_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a station",
"examples": {
"application/json": {
"max_dockable_ship_volume": 50000000,
"name": "Jakanerva III - Moon 15 - Prompt Delivery Storage",
"office_rental_cost": 10000,
"owner": 1000003,
"position": {
"x": 165632286720,
"y": 2771804160,
"z": -2455331266560
},
"race_id": 1,
"reprocessing_efficiency": 0.5,
"reprocessing_stations_take": 0.05,
"services": [
"courier-missions",
"reprocessing-plant",
"market",
"repair-facilities",
"fitting",
"news",
"storage",
"insurance",
"docking",
"office-rental",
"loyalty-point-store",
"navy-offices"
],
"station_id": 60000277,
"system_id": 30000148,
"type_id": 1531
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"max_dockable_ship_volume": {
"description": "max_dockable_ship_volume number",
"format": "float",
"title": "get_universe_stations_station_id_max_dockable_ship_volume",
"type": "number"
},
"name": {
"description": "name string",
"title": "get_universe_stations_station_id_name",
"type": "string"
},
"office_rental_cost": {
"description": "office_rental_cost number",
"format": "float",
"title": "get_universe_stations_station_id_office_rental_cost",
"type": "number"
},
"owner": {
"description": "ID of the corporation that controls this station",
"format": "int32",
"title": "get_universe_stations_station_id_owner",
"type": "integer"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_stations_station_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_stations_station_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_stations_station_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_stations_station_id_position",
"type": "object"
},
"race_id": {
"description": "race_id integer",
"format": "int32",
"title": "get_universe_stations_station_id_race_id",
"type": "integer"
},
"reprocessing_efficiency": {
"description": "reprocessing_efficiency number",
"format": "float",
"title": "get_universe_stations_station_id_reprocessing_efficiency",
"type": "number"
},
"reprocessing_stations_take": {
"description": "reprocessing_stations_take number",
"format": "float",
"title": "get_universe_stations_station_id_reprocessing_stations_take",
"type": "number"
},
"services": {
"description": "services array",
"items": {
"description": "service string",
"enum": [
"bounty-missions",
"assasination-missions",
"courier-missions",
"interbus",
"reprocessing-plant",
"refinery",
"market",
"black-market",
"stock-exchange",
"cloning",
"surgery",
"dna-therapy",
"repair-facilities",
"factory",
"labratory",
"gambling",
"fitting",
"paintshop",
"news",
"storage",
"insurance",
"docking",
"office-rental",
"jump-clone-facility",
"loyalty-point-store",
"navy-offices",
"security-offices"
],
"title": "get_universe_stations_station_id_service",
"type": "string"
},
"title": "get_universe_stations_station_id_services",
"type": "array"
},
"station_id": {
"description": "station_id integer",
"format": "int32",
"title": "get_universe_stations_station_id_station_id",
"type": "integer"
},
"system_id": {
"description": "The solar system this station is in",
"format": "int32",
"title": "get_universe_stations_station_id_system_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_universe_stations_station_id_type_id",
"type": "integer"
}
},
"required": [
"station_id",
"name",
"type_id",
"position",
"system_id",
"reprocessing_efficiency",
"reprocessing_stations_take",
"max_dockable_ship_volume",
"office_rental_cost",
"services"
],
"title": "get_universe_stations_station_id_ok",
"type": "object"
}
},
"404": {
"description": "Station not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_stations_station_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_stations_station_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_stations_station_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_stations_station_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get station information",
"tags": [
"Universe"
]
}
},
"/universe/structures/": {
"get": {
"description": "List all public structures\n\n---\n\nAlternate route: `/v1/universe/structures/`\n\nAlternate route: `/legacy/universe/structures/`\n\nAlternate route: `/dev/universe/structures/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_structures",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "List of public structure IDs",
"examples": {
"application/json": [
1000000017013,
1000000025062
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int64",
"minimum": 0,
"title": "get_universe_structures_200_ok",
"type": "integer",
"uniqueItems": true
},
"title": "get_universe_structures_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_structures_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_structures_internal_server_error",
"type": "object"
}
}
},
"summary": "List all public structures",
"tags": [
"Universe"
]
}
},
"/universe/structures/{structure_id}/": {
"get": {
"description": "Returns information on requested structure, if you are on the ACL. Otherwise, returns \"Forbidden\" for all inputs.\n\n---\n\nAlternate route: `/v1/universe/structures/{structure_id}/`\n\nAlternate route: `/legacy/universe/structures/{structure_id}/`\n\nAlternate route: `/dev/universe/structures/{structure_id}/`\n",
"operationId": "get_universe_structures_structure_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "An Eve structure ID",
"format": "int64",
"in": "path",
"name": "structure_id",
"required": true,
"type": "integer"
},
{
"description": "Access token to use, if preferred over a header",
"in": "query",
"name": "token",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Data about a structure",
"examples": {
"application/json": {
"name": "V-3YG7 VI - The Capital",
"solar_system_id": 30000142
}
},
"schema": {
"description": "200 ok object",
"properties": {
"name": {
"description": "The full name of the structure",
"title": "get_universe_structures_structure_id_name",
"type": "string"
},
"position": {
"description": "Coordinates of the structure in Cartesian space relative to the Sun, in metres.\n",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_structures_structure_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_structures_structure_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_structures_structure_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_structures_structure_id_position",
"type": "object"
},
"solar_system_id": {
"description": "solar_system_id integer",
"format": "int32",
"title": "get_universe_structures_structure_id_solar_system_id",
"type": "integer"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_universe_structures_structure_id_type_id",
"type": "integer"
}
},
"required": [
"name",
"solar_system_id"
],
"title": "get_universe_structures_structure_id_ok",
"type": "object"
}
},
"403": {
"description": "Forbidden",
"examples": {
"application/json": {
"error": "Token is not valid for scope(s): esi-universe.read_structures.v1"
}
},
"schema": {
"description": "Forbidden",
"properties": {
"error": {
"description": "Forbidden message",
"title": "get_universe_structures_structure_id_403_forbidden",
"type": "string"
}
},
"title": "get_universe_structures_structure_id_forbidden",
"type": "object"
}
},
"404": {
"description": "Structure not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_structures_structure_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_structures_structure_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_structures_structure_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_structures_structure_id_internal_server_error",
"type": "object"
}
}
},
"security": [
{
"evesso": [
"esi-universe.read_structures.v1"
]
}
],
"summary": "Get structure information",
"tags": [
"Universe"
]
}
},
"/universe/systems/": {
"get": {
"description": "Get a list of solar systems\n\n---\n\nAlternate route: `/v1/universe/systems/`\n\nAlternate route: `/legacy/universe/systems/`\n\nAlternate route: `/dev/universe/systems/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_systems",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of solar system ids",
"examples": {
"application/json": [
30000001,
30000002
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_systems_200_ok",
"type": "integer"
},
"title": "get_universe_systems_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_systems_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_systems_internal_server_error",
"type": "object"
}
}
},
"summary": "Get solar systems",
"tags": [
"Universe"
]
}
},
"/universe/systems/{system_id}/": {
"get": {
"description": "Get information on a solar system\n\n---\n\nAlternate route: `/v2/universe/systems/{system_id}/`\n\nAlternate route: `/dev/universe/systems/{system_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_systems_system_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "system_id integer",
"format": "int32",
"in": "path",
"name": "system_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a solar system",
"examples": {
"application/json": {
"constellation_id": 20000001,
"name": "Akpivem",
"planets": [
{
"moons": [
40000042
],
"planet_id": 40000041
},
{
"planet_id": 40000043
}
],
"position": {
"x": -91174141133075340,
"y": 43938227486247170,
"z": -56482824383339900
},
"security_class": "B",
"security_status": 0.8462923765182495,
"stargates": [
50000342
],
"system_id": 30000003
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"constellation_id": {
"description": "The constellation this solar system is in",
"format": "int32",
"title": "get_universe_systems_system_id_constellation_id",
"type": "integer"
},
"name": {
"description": "name string",
"title": "get_universe_systems_system_id_name",
"type": "string"
},
"planets": {
"description": "planets array",
"items": {
"description": "planet object",
"properties": {
"moons": {
"description": "moons array",
"items": {
"description": "moon integer",
"format": "int32",
"title": "get_universe_systems_system_id_moon",
"type": "integer"
},
"title": "get_universe_systems_system_id_moons",
"type": "array"
},
"planet_id": {
"description": "planet_id integer",
"format": "int32",
"title": "get_universe_systems_system_id_planet_id",
"type": "integer"
}
},
"required": [
"planet_id"
],
"title": "get_universe_systems_system_id_planet",
"type": "object"
},
"title": "get_universe_systems_system_id_planets",
"type": "array"
},
"position": {
"description": "position object",
"properties": {
"x": {
"description": "x number",
"format": "float",
"title": "get_universe_systems_system_id_x",
"type": "number"
},
"y": {
"description": "y number",
"format": "float",
"title": "get_universe_systems_system_id_y",
"type": "number"
},
"z": {
"description": "z number",
"format": "float",
"title": "get_universe_systems_system_id_z",
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "get_universe_systems_system_id_position",
"type": "object"
},
"security_class": {
"description": "security_class string",
"title": "get_universe_systems_system_id_security_class",
"type": "string"
},
"security_status": {
"description": "security_status number",
"format": "float",
"title": "get_universe_systems_system_id_security_status",
"type": "number"
},
"stargates": {
"description": "stargates array",
"items": {
"description": "stargate integer",
"format": "int32",
"title": "get_universe_systems_system_id_stargate",
"type": "integer"
},
"title": "get_universe_systems_system_id_stargates",
"type": "array"
},
"system_id": {
"description": "system_id integer",
"format": "int32",
"title": "get_universe_systems_system_id_system_id",
"type": "integer"
}
},
"required": [
"system_id",
"name",
"position",
"security_status",
"constellation_id",
"planets",
"stargates"
],
"title": "get_universe_systems_system_id_ok",
"type": "object"
}
},
"404": {
"description": "Solar system not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_systems_system_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_systems_system_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_systems_system_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_systems_system_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get solar system information",
"tags": [
"Universe"
]
}
},
"/universe/types/": {
"get": {
"description": "Get a list of type ids\n\n---\n\nAlternate route: `/v1/universe/types/`\n\nAlternate route: `/legacy/universe/types/`\n\nAlternate route: `/dev/universe/types/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_types",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Which page to query",
"format": "int32",
"in": "query",
"minimum": 1,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of type ids",
"examples": {
"application/json": [
1,
2,
3
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_universe_types_200_ok",
"type": "integer"
},
"title": "get_universe_types_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_types_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_types_internal_server_error",
"type": "object"
}
}
},
"summary": "Get types",
"tags": [
"Universe"
]
}
},
"/universe/types/{type_id}/": {
"get": {
"description": "Get information on a type\n\n---\n\nAlternate route: `/v2/universe/types/{type_id}/`\n\nAlternate route: `/dev/universe/types/{type_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_universe_types_type_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": "en-us",
"description": "Language to use in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"in": "query",
"name": "language",
"type": "string"
},
{
"description": "An Eve item type ID",
"format": "int32",
"in": "path",
"name": "type_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Information about a type",
"examples": {
"application/json": {
"description": "The Rifter is a...",
"group_id": 25,
"name": "Rifter",
"published": true,
"type_id": 587
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Content-Language": {
"description": "The language used in the response",
"enum": [
"de",
"en-us",
"fr",
"ja",
"ru",
"zh"
],
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"capacity": {
"description": "capacity number",
"format": "float",
"title": "get_universe_types_type_id_capacity",
"type": "number"
},
"description": {
"description": "description string",
"title": "get_universe_types_type_id_description",
"type": "string"
},
"dogma_attributes": {
"description": "dogma_attributes array",
"items": {
"description": "dogma_attribute object",
"properties": {
"attribute_id": {
"description": "attribute_id integer",
"format": "int32",
"title": "get_universe_types_type_id_attribute_id",
"type": "integer"
},
"value": {
"description": "value number",
"format": "float",
"title": "get_universe_types_type_id_value",
"type": "number"
}
},
"required": [
"attribute_id",
"value"
],
"title": "get_universe_types_type_id_dogma_attribute",
"type": "object"
},
"title": "get_universe_types_type_id_dogma_attributes",
"type": "array"
},
"dogma_effects": {
"description": "dogma_effects array",
"items": {
"description": "dogma_effect object",
"properties": {
"effect_id": {
"description": "effect_id integer",
"format": "int32",
"title": "get_universe_types_type_id_effect_id",
"type": "integer"
},
"is_default": {
"description": "is_default boolean",
"title": "get_universe_types_type_id_is_default",
"type": "boolean"
}
},
"required": [
"effect_id",
"is_default"
],
"title": "get_universe_types_type_id_dogma_effect",
"type": "object"
},
"title": "get_universe_types_type_id_dogma_effects",
"type": "array"
},
"graphic_id": {
"description": "graphic_id integer",
"format": "int32",
"title": "get_universe_types_type_id_graphic_id",
"type": "integer"
},
"group_id": {
"description": "group_id integer",
"format": "int32",
"title": "get_universe_types_type_id_group_id",
"type": "integer"
},
"icon_id": {
"description": "icon_id integer",
"format": "int32",
"title": "get_universe_types_type_id_icon_id",
"type": "integer"
},
"mass": {
"description": "mass number",
"format": "float",
"title": "get_universe_types_type_id_mass",
"type": "number"
},
"name": {
"description": "name string",
"title": "get_universe_types_type_id_name",
"type": "string"
},
"portion_size": {
"description": "portion_size integer",
"format": "int32",
"title": "get_universe_types_type_id_portion_size",
"type": "integer"
},
"published": {
"description": "published boolean",
"title": "get_universe_types_type_id_published",
"type": "boolean"
},
"radius": {
"description": "radius number",
"format": "float",
"title": "get_universe_types_type_id_radius",
"type": "number"
},
"type_id": {
"description": "type_id integer",
"format": "int32",
"title": "get_universe_types_type_id_type_id",
"type": "integer"
},
"volume": {
"description": "volume number",
"format": "float",
"title": "get_universe_types_type_id_volume",
"type": "number"
}
},
"required": [
"type_id",
"name",
"description",
"published",
"group_id"
],
"title": "get_universe_types_type_id_ok",
"type": "object"
}
},
"404": {
"description": "Type not found",
"examples": {
"application/json": {
"error": "Not found message"
}
},
"schema": {
"description": "Not found",
"properties": {
"error": {
"description": "Not found message",
"title": "get_universe_types_type_id_404_not_found",
"type": "string"
}
},
"title": "get_universe_types_type_id_not_found",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_universe_types_type_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_universe_types_type_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get type information",
"tags": [
"Universe"
]
}
},
"/wars/": {
"get": {
"description": "Return a list of wars\n\n---\n\nAlternate route: `/v1/wars/`\n\nAlternate route: `/legacy/wars/`\n\nAlternate route: `/dev/wars/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_wars",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Only return wars with ID smaller than this.",
"format": "int32",
"in": "query",
"name": "max_war_id",
"required": false,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of war IDs, 2000 at most, in decending order by war_id.",
"examples": {
"application/json": [
3,
2,
1
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok integer",
"format": "int32",
"title": "get_wars_200_ok",
"type": "integer"
},
"title": "get_wars_ok",
"type": "array"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_wars_500_internal_server_error",
"type": "string"
}
},
"title": "get_wars_internal_server_error",
"type": "object"
}
}
},
"summary": "List wars",
"tags": [
"Wars"
]
}
},
"/wars/{war_id}/": {
"get": {
"description": "Return details about a war\n\n---\n\nAlternate route: `/v1/wars/{war_id}/`\n\nAlternate route: `/legacy/wars/{war_id}/`\n\nAlternate route: `/dev/wars/{war_id}/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_wars_war_id",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "ID for a war",
"format": "int32",
"in": "path",
"name": "war_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "Details about a war",
"examples": {
"application/json": {
"aggressor": {
"corporation_id": 986665792,
"isk_destroyed": 0,
"ships_killed": 0
},
"declared": "2004-05-22T05:20:00Z",
"defender": {
"corporation_id": 1001562011,
"isk_destroyed": 0,
"ships_killed": 0
},
"id": 1941,
"mutual": false,
"open_for_allies": false
}
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok object",
"properties": {
"aggressor": {
"description": "The aggressor corporation or alliance that declared this war, only contains either corporation_id or alliance_id",
"properties": {
"alliance_id": {
"description": "Alliance ID if and only if the aggressor is an alliance",
"format": "int32",
"title": "get_wars_war_id_alliance_id",
"type": "integer"
},
"corporation_id": {
"description": "Corporation ID if and only if the aggressor is a corporation",
"format": "int32",
"title": "get_wars_war_id_corporation_id",
"type": "integer"
},
"isk_destroyed": {
"description": "ISK value of ships the aggressor has destroyed",
"format": "float",
"title": "get_wars_war_id_isk_destroyed",
"type": "number"
},
"ships_killed": {
"description": "The number of ships the aggressor has killed",
"format": "int32",
"title": "get_wars_war_id_ships_killed",
"type": "integer"
}
},
"required": [
"ships_killed",
"isk_destroyed"
],
"title": "get_wars_war_id_aggressor",
"type": "object"
},
"allies": {
"description": "allied corporations or alliances, each object contains either corporation_id or alliance_id",
"items": {
"description": "ally object",
"properties": {
"alliance_id": {
"description": "Alliance ID if and only if this ally is an alliance",
"format": "int32",
"title": "get_wars_war_id_alliance_id",
"type": "integer"
},
"corporation_id": {
"description": "Corporation ID if and only if this ally is a corporation",
"format": "int32",
"title": "get_wars_war_id_corporation_id",
"type": "integer"
}
},
"title": "get_wars_war_id_ally",
"type": "object"
},
"title": "get_wars_war_id_allies",
"type": "array"
},
"declared": {
"description": "Time that the war was declared",
"format": "date-time",
"title": "get_wars_war_id_declared",
"type": "string"
},
"defender": {
"description": "The defending corporation or alliance that declared this war, only contains either corporation_id or alliance_id",
"properties": {
"alliance_id": {
"description": "Alliance ID if and only if the defender is an alliance",
"format": "int32",
"title": "get_wars_war_id_alliance_id",
"type": "integer"
},
"corporation_id": {
"description": "Corporation ID if and only if the defender is a corporation",
"format": "int32",
"title": "get_wars_war_id_corporation_id",
"type": "integer"
},
"isk_destroyed": {
"description": "ISK value of ships the defender has killed",
"format": "float",
"title": "get_wars_war_id_isk_destroyed",
"type": "number"
},
"ships_killed": {
"description": "The number of ships the defender has killed",
"format": "int32",
"title": "get_wars_war_id_ships_killed",
"type": "integer"
}
},
"required": [
"ships_killed",
"isk_destroyed"
],
"title": "get_wars_war_id_defender",
"type": "object"
},
"finished": {
"description": "Time the war ended and shooting was no longer allowed",
"format": "date-time",
"title": "get_wars_war_id_finished",
"type": "string"
},
"id": {
"description": "ID of the specified war",
"format": "int32",
"title": "get_wars_war_id_id",
"type": "integer"
},
"mutual": {
"description": "Was the war declared mutual by both parties",
"title": "get_wars_war_id_mutual",
"type": "boolean"
},
"open_for_allies": {
"description": "Is the war currently open for allies or not",
"title": "get_wars_war_id_open_for_allies",
"type": "boolean"
},
"retracted": {
"description": "Time the war was retracted but both sides could still shoot each other",
"format": "date-time",
"title": "get_wars_war_id_retracted",
"type": "string"
},
"started": {
"description": "Time when the war started and both sides could shoot each other",
"format": "date-time",
"title": "get_wars_war_id_started",
"type": "string"
}
},
"required": [
"id",
"declared",
"mutual",
"open_for_allies",
"aggressor",
"defender"
],
"title": "get_wars_war_id_ok",
"type": "object"
}
},
"422": {
"description": "War not found",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "get_wars_war_id_422_unprocessable_entity",
"type": "string"
}
},
"title": "get_wars_war_id_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_wars_war_id_500_internal_server_error",
"type": "string"
}
},
"title": "get_wars_war_id_internal_server_error",
"type": "object"
}
}
},
"summary": "Get war information",
"tags": [
"Wars"
]
}
},
"/wars/{war_id}/killmails/": {
"get": {
"description": "Return a list of kills related to a war\n\n---\n\nAlternate route: `/v1/wars/{war_id}/killmails/`\n\nAlternate route: `/legacy/wars/{war_id}/killmails/`\n\nAlternate route: `/dev/wars/{war_id}/killmails/`\n\n\n---\n\nThis route is cached for up to 3600 seconds",
"operationId": "get_wars_war_id_killmails",
"parameters": [
{
"default": "tranquility",
"description": "The server name you would like data from",
"enum": [
"tranquility",
"singularity"
],
"in": "query",
"name": "datasource",
"type": "string"
},
{
"default": 1,
"description": "Which page to query, starting at 1, 2000 killmails per page.",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over headers",
"in": "query",
"name": "user_agent",
"type": "string"
},
{
"description": "A valid war ID",
"format": "int32",
"in": "path",
"name": "war_id",
"required": true,
"type": "integer"
},
{
"description": "Client identifier, takes precedence over User-Agent",
"in": "header",
"name": "X-User-Agent",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of killmail IDs and hashes",
"examples": {
"application/json": [
{
"killmail_hash": "8eef5e8fb6b88fe3407c489df33822b2e3b57a5e",
"killmail_id": 2
},
{
"killmail_hash": "b41ccb498ece33d64019f64c0db392aa3aa701fb",
"killmail_id": 1
}
]
},
"headers": {
"Cache-Control": {
"description": "The caching mechanism used",
"type": "string"
},
"Expires": {
"description": "RFC7231 formatted datetime string",
"type": "string"
},
"Last-Modified": {
"description": "RFC7231 formatted datetime string",
"type": "string"
}
},
"schema": {
"description": "200 ok array",
"items": {
"description": "200 ok object",
"properties": {
"killmail_hash": {
"description": "A hash of this killmail",
"title": "get_wars_war_id_killmails_killmail_hash",
"type": "string"
},
"killmail_id": {
"description": "ID of this killmail",
"format": "int32",
"title": "get_wars_war_id_killmails_killmail_id",
"type": "integer"
}
},
"required": [
"killmail_id",
"killmail_hash"
],
"title": "get_wars_war_id_killmails_200_ok",
"type": "object"
},
"title": "get_wars_war_id_killmails_ok",
"type": "array"
}
},
"422": {
"description": "War not found",
"examples": {
"application/json": {
"error": "Unprocessable entity message"
}
},
"schema": {
"description": "Unprocessable entity",
"properties": {
"error": {
"description": "Unprocessable entity message",
"title": "get_wars_war_id_killmails_422_unprocessable_entity",
"type": "string"
}
},
"title": "get_wars_war_id_killmails_unprocessable_entity",
"type": "object"
}
},
"500": {
"description": "Internal server error",
"examples": {
"application/json": {
"error": "uncaught exception: IOError('out of memory')"
}
},
"schema": {
"description": "Internal server error",
"properties": {
"error": {
"description": "Internal server error message",
"title": "get_wars_war_id_killmails_500_internal_server_error",
"type": "string"
}
},
"title": "get_wars_war_id_killmails_internal_server_error",
"type": "object"
}
}
},
"summary": "List kills for a war",
"tags": [
"Wars"
]
}
}
},
"produces": [
"application/json"
],
"schemes": [
"https"
],
"securityDefinitions": {
"evesso": {
"authorizationUrl": "https://login.eveonline.com/oauth/authorize",
"flow": "implicit",
"scopes": {
"esi-assets.read_assets.v1": "EVE SSO scope esi-assets.read_assets.v1",
"esi-bookmarks.read_character_bookmarks.v1": "EVE SSO scope esi-bookmarks.read_character_bookmarks.v1",
"esi-calendar.read_calendar_events.v1": "EVE SSO scope esi-calendar.read_calendar_events.v1",
"esi-calendar.respond_calendar_events.v1": "EVE SSO scope esi-calendar.respond_calendar_events.v1",
"esi-characters.read_contacts.v1": "EVE SSO scope esi-characters.read_contacts.v1",
"esi-characters.write_contacts.v1": "EVE SSO scope esi-characters.write_contacts.v1",
"esi-clones.read_clones.v1": "EVE SSO scope esi-clones.read_clones.v1",
"esi-corporations.read_corporation_membership.v1": "EVE SSO scope esi-corporations.read_corporation_membership.v1",
"esi-corporations.read_structures.v1": "EVE SSO scope esi-corporations.read_structures.v1",
"esi-fittings.read_fittings.v1": "EVE SSO scope esi-fittings.read_fittings.v1",
"esi-fittings.write_fittings.v1": "EVE SSO scope esi-fittings.write_fittings.v1",
"esi-fleets.read_fleet.v1": "EVE SSO scope esi-fleets.read_fleet.v1",
"esi-fleets.write_fleet.v1": "EVE SSO scope esi-fleets.write_fleet.v1",
"esi-killmails.read_killmails.v1": "EVE SSO scope esi-killmails.read_killmails.v1",
"esi-location.read_location.v1": "EVE SSO scope esi-location.read_location.v1",
"esi-location.read_ship_type.v1": "EVE SSO scope esi-location.read_ship_type.v1",
"esi-mail.organize_mail.v1": "EVE SSO scope esi-mail.organize_mail.v1",
"esi-mail.read_mail.v1": "EVE SSO scope esi-mail.read_mail.v1",
"esi-mail.send_mail.v1": "EVE SSO scope esi-mail.send_mail.v1",
"esi-markets.structure_markets.v1": "EVE SSO scope esi-markets.structure_markets.v1",
"esi-planets.manage_planets.v1": "EVE SSO scope esi-planets.manage_planets.v1",
"esi-search.search_structures.v1": "EVE SSO scope esi-search.search_structures.v1",
"esi-skills.read_skillqueue.v1": "EVE SSO scope esi-skills.read_skillqueue.v1",
"esi-skills.read_skills.v1": "EVE SSO scope esi-skills.read_skills.v1",
"esi-ui.open_window.v1": "EVE SSO scope esi-ui.open_window.v1",
"esi-ui.write_waypoint.v1": "EVE SSO scope esi-ui.write_waypoint.v1",
"esi-universe.read_structures.v1": "EVE SSO scope esi-universe.read_structures.v1",
"esi-wallet.read_character_wallet.v1": "EVE SSO scope esi-wallet.read_character_wallet.v1"
},
"type": "oauth2"
}
},
"swagger": "2.0"
}
Reference in a new issue View git blame Copy permalink