allianceauth/eveonline/swagger.json

{"basePath": "/", "definitions": {"internal_server_error": {"description": "Internal server error model", "type": "object", "properties": {"error": {"description": "Internal server error message", "type": "string"}}, "required": ["error"], "title": "Internal server error"}, "forbidden": {"description": "Forbidden model", "type": "object", "properties": {"sso_status": {"description": "Status code received from SSO", "type": "integer"}, "error": {"description": "Forbidden message", "type": "string"}}, "required": ["error"], "title": "Forbidden"}}, "info": {"description": "An OpenAPI for EVE Online", "version": "0.5.5", "title": "EVE Swagger Interface"}, "parameters": {"character_id": {"description": "An EVE character ID", "name": "character_id", "in": "path", "type": "integer", "required": true, "format": "int32"}, "language": {"description": "Language to use in the response", "enum": ["de", "en-us", "fr", "ja", "ru", "zh"], "default": "en-us", "in": "query", "type": "string", "name": "language"}, "X-User-Agent": {"description": "Client identifier, takes precedence over User-Agent", "type": "string", "name": "X-User-Agent", "in": "header"}, "datasource": {"description": "The server name you would like data from", "enum": ["tranquility", "singularity"], "default": "tranquility", "in": "query", "type": "string", "name": "datasource"}, "token": {"description": "Access token to use if unable to set a header", "type": "string", "name": "token", "in": "query"}, "corporation_id": {"description": "An EVE corporation ID", "name": "corporation_id", "in": "path", "type": "integer", "required": true, "format": "int32"}, "page": {"description": "Which page of results to return", "default": 1, "in": "query", "type": "integer", "name": "page", "format": "int32"}, "alliance_id": {"description": "An EVE alliance ID", "name": "alliance_id", "in": "path", "type": "integer", "required": true, "format": "int32"}, "user_agent": {"description": "Client identifier, takes precedence over headers", "type": "string", "name": "user_agent", "in": "query"}}, "produces": ["application/json"], "securityDefinitions": {"evesso": {"flow": "implicit", "scopes": {"esi-fleets.write_fleet.v1": "EVE SSO scope esi-fleets.write_fleet.v1", "esi-characters.read_chat_channels.v1": "EVE SSO scope esi-characters.read_chat_channels.v1", "esi-assets.read_corporation_assets.v1": "EVE SSO scope esi-assets.read_corporation_assets.v1", "esi-bookmarks.read_character_bookmarks.v1": "EVE SSO scope esi-bookmarks.read_character_bookmarks.v1", "esi-killmails.read_killmails.v1": "EVE SSO scope esi-killmails.read_killmails.v1", "esi-characters.read_standings.v1": "EVE SSO scope esi-characters.read_standings.v1", "esi-wallet.read_character_wallet.v1": "EVE SSO scope esi-wallet.read_character_wallet.v1", "esi-corporations.write_structures.v1": "EVE SSO scope esi-corporations.write_structures.v1", "esi-markets.structure_markets.v1": "EVE SSO scope esi-markets.structure_markets.v1", "esi-universe.read_structures.v1": "EVE SSO scope esi-universe.read_structures.v1", "esi-location.read_online.v1": "EVE SSO scope esi-location.read_online.v1", "esi-fittings.write_fittings.v1": "EVE SSO scope esi-fittings.write_fittings.v1", "esi-industry.read_character_jobs.v1": "EVE SSO scope esi-industry.read_character_jobs.v1", "esi-corporations.track_members.v1": "EVE SSO scope esi-corporations.track_members.v1", "esi-characters.read_contacts.v1": "EVE SSO scope esi-characters.read_contacts.v1", "esi-search.search_structures.v1": "EVE SSO scope esi-search.search_structures.v1", "esi-clones.read_clones.v1": "EVE SSO scope esi-clones.read_clones.v1", "esi-skills.read_skills.v1": "EVE SSO scope esi-skills.read_skills.v1", "esi-characters.read_notifications.v1": "EVE SSO scope esi-characters.read_notifications.v1", "esi-location.read_location.v1": "EVE SSO scope esi-location.read_location.v1", "esi-characters.read_opportunities.v1": "EVE SSO scope esi-characters.read_opportunities.v1", "esi-characters.read_medals.v1": "EVE SSO scope esi-characters.read_medals.v1", "esi-corporations.read_contacts.v1": "EVE SSO scope esi-corporations.read_contacts.v1", "esi-ui.open_window.v1": "EVE SSO scope esi-ui.open_window.v1", "esi-characters.read_agents_research.v1": "EVE SSO scope esi-characters.read_agents_research.v1", "esi-location.read_ship_type.v1": "EVE SSO scope esi-location.read_ship_type.v1", "esi-calendar.read_calendar_events.v1": "EVE SSO scope esi-calendar.read_calendar_events.v1", "esi-mail.read_mail.v1": "EVE SSO scope esi-mail.read_mail.v1", "esi-characters.read_corporation_roles.v1": "EVE SSO scope esi-characters.read_corporation_roles.v1", "esi-characters.read_blueprints.v1": "EVE SSO scope esi-characters.read_blueprints.v1", "esi-ui.write_waypoint.v1": "EVE SSO scope esi-ui.write_waypoint.v1", "esi-fleets.read_fleet.v1": "EVE SSO scope esi-fleets.read_fleet.v1", "esi-markets.read_character_orders.v1": "EVE SSO scope esi-markets.read_character_orders.v1", "esi-mail.send_mail.v1": "EVE SSO scope esi-mail.send_mail.v1", "esi-corporations.read_divisions.v1": "EVE SSO scope esi-corporations.read_divisions.v1", "esi-skills.read_skillqueue.v1": "EVE SSO scope esi-skills.read_skillqueue.v1", "esi-mail.organize_mail.v1": "EVE SSO scope esi-mail.organize_mail.v1", "esi-characters.write_contacts.v1": "EVE SSO scope esi-characters.write_contacts.v1", "esi-calendar.respond_calendar_events.v1": "EVE SSO scope esi-calendar.respond_calendar_events.v1", "esi-corporations.read_structures.v1": "EVE SSO scope esi-corporations.read_structures.v1", "esi-assets.read_assets.v1": "EVE SSO scope esi-assets.read_assets.v1", "esi-planets.manage_planets.v1": "EVE SSO scope esi-planets.manage_planets.v1", "esi-wallet.read_corporation_wallets.v1": "EVE SSO scope esi-wallet.read_corporation_wallets.v1", "esi-characters.read_loyalty.v1": "EVE SSO scope esi-characters.read_loyalty.v1", "esi-killmails.read_corporation_killmails.v1": "EVE SSO scope esi-killmails.read_corporation_killmails.v1", "esi-corporations.read_corporation_membership.v1": "EVE SSO scope esi-corporations.read_corporation_membership.v1", "esi-clones.read_implants.v1": "EVE SSO scope esi-clones.read_implants.v1", "esi-contracts.read_character_contracts.v1": "EVE SSO scope esi-contracts.read_character_contracts.v1", "esi-fittings.read_fittings.v1": "EVE SSO scope esi-fittings.read_fittings.v1", "esi-characters.read_fatigue.v1": "EVE SSO scope esi-characters.read_fatigue.v1"}, "authorizationUrl": "https://login.eveonline.com/oauth/authorize", "type": "oauth2"}}, "schemes": ["https"], "swagger": "2.0", "host": "esi.tech.ccp.is", "paths": {"/v1/alliances/{alliance_id}/corporations/": {"get": {"description": "List all current member corporations of an alliance\n\n---\n\nThis route is cached for up to 3600 seconds", "x-cached-seconds": 3600, "operationId": "get_alliances_alliance_id_corporations", "summary": "List alliance's corporations", "responses": {"200": {"schema": {"description": "200 ok array", "type": "array", "title": "get_alliances_alliance_id_corporations_ok", "maxItems": 1000, "items": {"minimum": 0, "uniqueItems": true, "description": "200 ok integer", "type": "integer", "title": "get_alliances_alliance_id_corporations_200_ok", "format": "int32"}}, "description": "List of corporation IDs", "headers": {"Last-Modified": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Expires": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Cache-Control": {"description": "The caching mechanism used", "type": "string"}}, "examples": {"application/json": [98000001]}}, "500": {"schema": {"$ref": "#/definitions/internal_server_error"}, "description": "Internal server error", "examples": {"application/json": {"error": "Internal server error message"}}}}, "tags": ["Alliance"], "parameters": [{"$ref": "#/parameters/alliance_id"}, {"$ref": "#/parameters/datasource"}, {"$ref": "#/parameters/user_agent"}, {"$ref": "#/parameters/X-User-Agent"}], "x-alternate-versions": ["dev", "legacy", "v1"]}}, "/v4/characters/{character_id}/": {"get": {"description": "Public information about a character\n\n---\n\nThis route is cached for up to 3600 seconds", "x-cached-seconds": 3600, "operationId": "get_characters_character_id", "summary": "Get character's public information", "responses": {"200": {"schema": {"description": "200 ok object", "type": "object", "properties": {"bloodline_id": {"description": "bloodline_id integer", "type": "integer", "title": "get_characters_character_id_bloodline_id", "format": "int32"}, "name": {"description": "name string", "type": "string", "title": "get_characters_character_id_name"}, "race_id": {"description": "race_id integer", "type": "integer", "title": "get_characters_character_id_race_id", "format": "int32"}, "security_status": {"minimum": -10, "maximum": 10, "description": "security_status number", "type": "number", "title": "get_characters_character_id_security_status", "format": "float"}, "description": {"description": "description string", "type": "string", "title": "get_characters_character_id_description"}, "corporation_id": {"description": "The character's corporation ID", "type": "integer", "title": "get_characters_character_id_corporation_id", "format": "int32"}, "birthday": {"description": "Creation date of the character", "type": "string", "title": "get_characters_character_id_birthday", "format": "date-time"}, "alliance_id": {"description": "The character's alliance ID", "type": "integer", "title": "get_characters_character_id_alliance_id", "format": "int32"}, "gender": {"description": "gender string", "enum": ["female", "male"], "type": "string", "title": "get_characters_character_id_gender"}, "ancestry_id": {"description": "ancestry_id integer", "type": "integer", "title": "get_characters_character_id_ancestry_id", "format": "int32"}}, "required": ["corporation_id", "birthday", "name", "gender", "race_id", "bloodline_id"], "title": "get_characters_character_id_ok"}, "description": "Public data for the given character", "headers": {"Last-Modified": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Expires": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Cache-Control": {"description": "The caching mechanism used", "type": "string"}}, "examples": {"application/json": {"bloodline_id": 3, "name": "CCP Bartender", "race_id": 2, "description": "", "corporation_id": 109299958, "birthday": "2015-03-24T11:37:00Z", "gender": "male", "ancestry_id": 19}}}, "500": {"schema": {"$ref": "#/definitions/internal_server_error"}, "description": "Internal server error", "examples": {"application/json": {"error": "Internal server error message"}}}, "404": {"schema": {"description": "Not found", "type": "object", "properties": {"error": {"description": "Not found message", "type": "string", "title": "get_characters_character_id_404_not_found"}}, "title": "get_characters_character_id_not_found"}, "description": "Character not found", "examples": {"application/json": {"error": "Not found message"}}}}, "tags": ["Character"], "parameters": [{"$ref": "#/parameters/character_id"}, {"$ref": "#/parameters/datasource"}, {"$ref": "#/parameters/user_agent"}, {"$ref": "#/parameters/X-User-Agent"}], "x-alternate-versions": ["dev", "v4"]}}, "/v2/universe/types/{type_id}/": {"get": {"description": "Get information on a type\n\n---\n\nThis route expires daily at 11:05", "operationId": "get_universe_types_type_id", "summary": "Get type information", "responses": {"200": {"schema": {"description": "200 ok object", "type": "object", "properties": {"published": {"description": "published boolean", "type": "boolean", "title": "get_universe_types_type_id_published"}, "group_id": {"description": "group_id integer", "type": "integer", "title": "get_universe_types_type_id_group_id", "format": "int32"}, "mass": {"description": "mass number", "type": "number", "title": "get_universe_types_type_id_mass", "format": "float"}, "graphic_id": {"description": "graphic_id integer", "type": "integer", "title": "get_universe_types_type_id_graphic_id", "format": "int32"}, "type_id": {"description": "type_id integer", "type": "integer", "title": "get_universe_types_type_id_type_id", "format": "int32"}, "volume": {"description": "volume number", "type": "number", "title": "get_universe_types_type_id_volume", "format": "float"}, "radius": {"description": "radius number", "type": "number", "title": "get_universe_types_type_id_radius", "format": "float"}, "dogma_effects": {"description": "dogma_effects array", "type": "array", "title": "get_universe_types_type_id_dogma_effects", "maxItems": 1000, "items": {"description": "dogma_effect object", "type": "object", "properties": {"effect_id": {"description": "effect_id integer", "type": "integer", "title": "get_universe_types_type_id_effect_id", "format": "int32"}, "is_default": {"description": "is_default boolean", "type": "boolean", "title": "get_universe_types_type_id_is_default"}}, "required": ["effect_id", "is_default"], "title": "get_universe_types_type_id_dogma_effect"}}, "portion_size": {"description": "portion_size integer", "type": "integer", "title": "get_universe_types_type_id_portion_size", "format": "int32"}, "description": {"description": "description string", "type": "string", "title": "get_universe_types_type_id_description"}, "name": {"description": "name string", "type": "string", "title": "get_universe_types_type_id_name"}, "icon_id": {"description": "icon_id integer", "type": "integer", "title": "get_universe_types_type_id_icon_id", "format": "int32"}, "capacity": {"description": "capacity number", "type": "number", "title": "get_universe_types_type_id_capacity", "format": "float"}, "dogma_attributes": {"description": "dogma_attributes array", "type": "array", "title": "get_universe_types_type_id_dogma_attributes", "maxItems": 1000, "items": {"description": "dogma_attribute object", "type": "object", "properties": {"attribute_id": {"description": "attribute_id integer", "type": "integer", "title": "get_universe_types_type_id_attribute_id", "format": "int32"}, "value": {"description": "value number", "type": "number", "title": "get_universe_types_type_id_value", "format": "float"}}, "required": ["attribute_id", "value"], "title": "get_universe_types_type_id_dogma_attribute"}}}, "required": ["type_id", "name", "description", "published", "group_id"], "title": "get_universe_types_type_id_ok"}, "description": "Information about a type", "headers": {"Content-Language": {"description": "The language used in the response", "enum": ["de", "en-us", "fr", "ja", "ru", "zh"], "type": "string"}, "Last-Modified": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Expires": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Cache-Control": {"description": "The caching mechanism used", "type": "string"}}, "examples": {"application/json": {"published": true, "description": "The Rifter is a...", "type_id": 587, "name": "Rifter", "group_id": 25}}}, "500": {"schema": {"$ref": "#/definitions/internal_server_error"}, "description": "Internal server error", "examples": {"application/json": {"error": "Internal server error message"}}}, "404": {"schema": {"description": "Not found", "type": "object", "properties": {"error": {"description": "Not found message", "type": "string", "title": "get_universe_types_type_id_404_not_found"}}, "title": "get_universe_types_type_id_not_found"}, "description": "Type not found", "examples": {"application/json": {"error": "Not found message"}}}}, "tags": ["Universe"], "parameters": [{"$ref": "#/parameters/datasource"}, {"$ref": "#/parameters/language"}, {"description": "An Eve item type ID", "name": "type_id", "in": "path", "type": "integer", "required": true, "format": "int32"}, {"$ref": "#/parameters/user_agent"}, {"$ref": "#/parameters/X-User-Agent"}], "x-alternate-versions": ["legacy", "v2"]}}, "/v2/alliances/{alliance_id}/": {"get": {"description": "Public information about an alliance\n\n---\n\nThis route is cached for up to 3600 seconds", "x-cached-seconds": 3600, "operationId": "get_alliances_alliance_id", "summary": "Get alliance information", "responses": {"200": {"schema": {"description": "200 ok object", "type": "object", "properties": {"alliance_name": {"description": "the full name of the alliance", "type": "string", "title": "get_alliances_alliance_id_alliance_name"}, "executor_corp": {"description": "the executor corporation ID, if this alliance is not closed", "type": "integer", "title": "get_alliances_alliance_id_executor_corp", "format": "int32"}, "ticker": {"description": "the short name of the alliance", "type": "string", "title": "get_alliances_alliance_id_ticker"}, "date_founded": {"description": "date_founded string", "type": "string", "title": "get_alliances_alliance_id_date_founded", "format": "date-time"}}, "required": ["alliance_name", "ticker", "date_founded"], "title": "get_alliances_alliance_id_ok"}, "description": "Public data about an alliance", "headers": {"Last-Modified": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Expires": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Cache-Control": {"description": "The caching mechanism used", "type": "string"}}, "examples": {"application/json": {"alliance_name": "C C P Alliance", "executor_corp": 98356193, "ticker": "<C C P>", "date_founded": "2016-06-26T21:00:00Z"}}}, "500": {"schema": {"$ref": "#/definitions/internal_server_error"}, "description": "Internal server error", "examples": {"application/json": {"error": "Internal server error message"}}}, "404": {"schema": {"description": "Alliance not found", "type": "object", "properties": {"error": {"description": "error message", "type": "string", "title": "get_alliances_alliance_id_error"}}, "title": "get_alliances_alliance_id_not_found"}, "description": "Alliance not found", "examples": {"application/json": {"error": "Alliance not found"}}}}, "tags": ["Alliance"], "parameters": [{"$ref": "#/parameters/alliance_id"}, {"$ref": "#/parameters/datasource"}, {"$ref": "#/parameters/user_agent"}, {"$ref": "#/parameters/X-User-Agent"}], "x-alternate-versions": ["v2"]}}, "/v3/corporations/{corporation_id}/": {"get": {"description": "Public information about a corporation\n\n---\n\nThis route is cached for up to 3600 seconds", "x-cached-seconds": 3600, "operationId": "get_corporations_corporation_id", "summary": "Get corporation information", "responses": {"200": {"schema": {"description": "200 ok object", "type": "object", "properties": {"creator_id": {"description": "creator_id integer", "type": "integer", "title": "get_corporations_corporation_id_creator_id", "format": "int32"}, "url": {"description": "url string", "type": "string", "title": "get_corporations_corporation_id_url"}, "ticker": {"description": "the short name of the corporation", "type": "string", "title": "get_corporations_corporation_id_ticker"}, "member_count": {"description": "member_count integer", "type": "integer", "title": "get_corporations_corporation_id_member_count", "format": "int32"}, "corporation_description": {"description": "corporation_description string", "type": "string", "title": "get_corporations_corporation_id_corporation_description"}, "creation_date": {"description": "creation_date string", "type": "string", "title": "get_corporations_corporation_id_creation_date", "format": "date-time"}, "faction": {"description": "faction string", "enum": ["Minmatar", "Gallente", "Caldari", "Amarr"], "type": "string", "title": "get_corporations_corporation_id_faction"}, "corporation_name": {"description": "the full name of the corporation", "type": "string", "title": "get_corporations_corporation_id_corporation_name"}, "alliance_id": {"description": "id of alliance that corporation is a member of, if any", "type": "integer", "title": "get_corporations_corporation_id_alliance_id", "format": "int32"}, "ceo_id": {"description": "ceo_id integer", "type": "integer", "title": "get_corporations_corporation_id_ceo_id", "format": "int32"}, "tax_rate": {"minimum": 0, "maximum": 1, "description": "tax_rate number", "type": "number", "title": "get_corporations_corporation_id_tax_rate", "format": "float"}}, "required": ["corporation_name", "ticker", "member_count", "ceo_id", "corporation_description", "tax_rate", "creator_id", "url"], "title": "get_corporations_corporation_id_ok"}, "description": "Public data about a corporation", "headers": {"Last-Modified": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Expires": {"description": "RFC7231 formatted datetime string", "type": "string"}, "Cache-Control": {"description": "The caching mechanism used", "type": "string"}}, "examples": {"application/json": {"creator_id": 180548812, "url": "http://www.eveonline.com", "ticker": "-CCP-", "member_count": 656, "corporation_description": "This is a corporation description, it's basically just a string", "creation_date": "2004-11-28T16:42:51Z", "corporation_name": "C C P", "alliance_id": 434243723, "ceo_id": 180548812, "tax_rate": 0.256}}}, "500": {"schema": {"$ref": "#/definitions/internal_server_error"}, "description": "Internal server error", "examples": {"application/json": {"error": "Internal server error message"}}}, "404": {"schema": {"description": "Not found", "type": "object", "properties": {"error": {"description": "Not found message", "type": "string", "title": "get_corporations_corporation_id_404_not_found"}}, "title": "get_corporations_corporation_id_not_found"}, "description": "Corporation not found", "examples": {"application/json": {"error": "Not found message"}}}}, "tags": ["Corporation"], "parameters": [{"$ref": "#/parameters/corporation_id"}, {"$ref": "#/parameters/datasource"}, {"$ref": "#/parameters/user_agent"}, {"$ref": "#/parameters/X-User-Agent"}], "x-alternate-versions": ["v3"]}}}}