EVE Online Character API

The Character API from EVE Online — 28 operation(s) for character.

OpenAPI Specification

eve-online-character-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Character API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Character
paths:
  /characters/affiliation/:
    post:
      description: 'Bulk lookup of character IDs to corporation, alliance and faction


        ---

        Alternate route: `/dev/characters/affiliation/`


        Alternate route: `/legacy/characters/affiliation/`


        Alternate route: `/v1/characters/affiliation/`


        Alternate route: `/v2/characters/affiliation/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: post_characters_affiliation
      parameters:
      - $ref: '#/components/parameters/datasource'
      requestBody:
        content:
          application/json:
            schema:
              description: characters array
              items:
                description: character integer
                format: int32
                title: post_characters_affiliation_character
                type: integer
              maxItems: 1000
              minItems: 1
              title: post_characters_affiliation_characters
              type: array
              uniqueItems: true
            examples:
              PostCharactersAffiliationRequestExample:
                summary: Default post_characters_affiliation request
                x-microcks-default: true
                value: {}
        description: The character IDs to fetch affiliations for. All characters must exist, or none will be returned
        required: true
      responses:
        '200':
          description: Character corporation, alliance and faction IDs
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    alliance_id:
                      description: The character's alliance ID, if their corporation is in an alliance
                      format: int32
                      title: post_characters_affiliation_alliance_id
                      type: integer
                    character_id:
                      description: The character's ID
                      format: int32
                      title: post_characters_affiliation_character_id
                      type: integer
                    corporation_id:
                      description: The character's corporation ID
                      format: int32
                      title: post_characters_affiliation_corporation_id
                      type: integer
                    faction_id:
                      description: The character's faction ID, if their corporation is in a faction
                      format: int32
                      title: post_characters_affiliation_faction_id
                      type: integer
                  required:
                  - character_id
                  - corporation_id
                  title: post_characters_affiliation_200_ok
                  type: object
                maxItems: 1000
                title: post_characters_affiliation_ok
                type: array
              examples:
                response:
                  value:
                  - alliance_id: 434243723
                    character_id: 95538921
                    corporation_id: 109299958
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      summary: EVE Online Character Affiliation
      tags:
      - Character
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/:
    get:
      description: 'Public information about a character


        ---

        Alternate route: `/dev/characters/{character_id}/`


        Alternate route: `/legacy/characters/{character_id}/`


        Alternate route: `/v5/characters/{character_id}/`


        ---

        This route is cached for up to 604800 seconds'
      operationId: get_characters_character_id
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Public data for the given character
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              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
                  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
                  faction_id:
                    description: ID of the faction the character is fighting for, if the character is enlisted in Factional Warfare
                    format: int32
                    title: get_characters_character_id_faction_id
                    type: integer
                  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
                  title:
                    description: The individual title of the character
                    title: get_characters_character_id_title
                    type: string
                required:
                - corporation_id
                - birthday
                - name
                - gender
                - race_id
                - bloodline_id
                title: get_characters_character_id_ok
                type: object
              examples:
                response:
                  value:
                    birthday: 2015-03-24 11:37:00+00:00
                    bloodline_id: 3
                    corporation_id: 109299958
                    description: ''
                    gender: male
                    name: CCP Bartender
                    race_id: 2
                    title: All round pretty awesome guy
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '404':
          description: Character not found
          content:
            application/json:
              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
              examples:
                response:
                  value:
                    error: Not found message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      summary: EVE Online Get Character's Public Information
      tags:
      - Character
      x-alternate-versions:
      - dev
      - legacy
      - v5
      x-cached-seconds: 604800
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/agents_research/:
    get:
      description: 'Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate)


        ---

        Alternate route: `/dev/characters/{character_id}/agents_research/`


        Alternate route: `/legacy/characters/{character_id}/agents_research/`


        Alternate route: `/v1/characters/{character_id}/agents_research/`


        Alternate route: `/v2/characters/{character_id}/agents_research/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_characters_character_id_agents_research
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of agents research information
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    agent_id:
                      description: agent_id integer
                      format: int32
                      title: get_characters_character_id_agents_research_agent_id
                      type: integer
                    points_per_day:
                      description: points_per_day number
                      format: float
                      title: get_characters_character_id_agents_research_points_per_day
                      type: number
                    remainder_points:
                      description: remainder_points number
                      format: float
                      title: get_characters_character_id_agents_research_remainder_points
                      type: number
                    skill_type_id:
                      description: skill_type_id integer
                      format: int32
                      title: get_characters_character_id_agents_research_skill_type_id
                      type: integer
                    started_at:
                      description: started_at string
                      format: date-time
                      title: get_characters_character_id_agents_research_started_at
                      type: string
                  required:
                  - agent_id
                  - skill_type_id
                  - started_at
                  - points_per_day
                  - remainder_points
                  title: get_characters_character_id_agents_research_200_ok
                  type: object
                maxItems: 1000
                title: get_characters_character_id_agents_research_ok
                type: array
              examples:
                response:
                  value:
                  - agent_id: 3009358
                    points_per_day: 53.5346162146776
                    remainder_points: 53604.0634303189
                    skill_type_id: 11450
                    started_at: 2017-03-23 14:47:00+00:00
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-characters.read_agents_research.v1
      summary: EVE Online Get Agents Research
      tags:
      - Character
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/blueprints/:
    get:
      description: 'Return a list of blueprints the character owns


        ---

        Alternate route: `/dev/characters/{character_id}/blueprints/`


        Alternate route: `/legacy/characters/{character_id}/blueprints/`


        Alternate route: `/v2/characters/{character_id}/blueprints/`


        Alternate route: `/v3/characters/{character_id}/blueprints/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_characters_character_id_blueprints
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of blueprints
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            X-Pages:
              description: Maximum page number
              schema:
                type: integer
                format: int32
                default: 1
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    item_id:
                      description: Unique ID for this item.
                      format: int64
                      title: get_characters_character_id_blueprints_item_id
                      type: integer
                    location_flag:
                      description: Type of the location_id
                      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_blueprints_location_flag
                      type: string
                    location_id:
                      description: References a station, a ship or an item_id if this blueprint is located within a container. If the return value is an item_id, then the Character AssetList API must be queried to find the container using the given item_id to determine the correct location of the Blueprint.
                      format: int64
                      title: get_characters_character_id_blueprints_location_id
                      type: integer
                    material_efficiency:
                      description: Material Efficiency Level of the blueprint.
                      format: int32
                      maximum: 25
                      minimum: 0
                      title: get_characters_character_id_blueprints_material_efficiency
                      type: integer
                    quantity:
                      description: A range of numbers with a minimum of -2 and no maximum value where -1 is an original and -2 is a copy. It can be a positive integer if it is a stack of blueprint originals fresh from the market (e.g. no activities performed on them yet).
                      format: int32
                      minimum: -2
                      title: get_characters_character_id_blueprints_quantity
                      type: integer
                    runs:
                      description: Number of runs remaining if the blueprint is a copy, -1 if it is an original.
                      format: int32
                      minimum: -1
                      title: get_characters_character_id_blueprints_runs
                      type: integer
                    time_efficiency:
                      description: Time Efficiency Level of the blueprint.
                      format: int32
                      maximum: 20
                      minimum: 0
                      title: get_characters_character_id_blueprints_time_efficiency
                      type: integer
                    type_id:
                      description: type_id integer
                      format: int32
                      title: get_characters_character_id_blueprints_type_id
                      type: integer
                  required:
                  - item_id
                  - type_id
                  - location_id
                  - location_flag
                  - quantity
                  - time_efficiency
                  - material_efficiency
                  - runs
                  title: get_characters_character_id_blueprints_200_ok
                  type: object
                maxItems: 1000
                title: get_characters_character_id_blueprints_ok
                type: array
              examples:
                response:
                  value:
                  - item_id: 1000000010495
                    location_flag: Hangar
                    location_id: 60014719
                    material_efficiency: 0
                    quantity: 1
                    runs: -1
                    time_efficiency: 0
                    type_id: 691
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-characters.read_blueprints.v1
      summary: EVE Online Get Blueprints
      tags:
      - Character
      x-alternate-versions:
      - dev
      - legacy
      - v2
      - v3
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/corporationhistory/:
    get:
      description: 'Get a list of all the corporations a character has been a member of


        ---

        Alternate route: `/dev/characters/{character_id}/corporationhistory/`


        Alternate route: `/legacy/characters/{character_id}/corporationhistory/`


        Alternate route: `/v1/characters/{character_id}/corporationhistory/`


        Alternate route: `/v2/characters/{character_id}/corporationhistory/`


        ---

        This route is cached for up to 86400 seconds'
      operationId: get_characters_character_id_corporationhistory
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Corporation history for the given character
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    corporation_id:
                      description: corporation

# --- truncated at 32 KB (212 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eve-online/refs/heads/main/openapi/eve-online-character-api-openapi.yml