EVE Online Faction Warfare API

The Faction Warfare API from EVE Online — 16 operation(s) for faction warfare.

OpenAPI Specification

eve-online-faction-warfare-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Faction Warfare API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Faction Warfare
paths:
  /characters/{character_id}/fw/stats/:
    get:
      description: 'Statistical overview of a character involved in faction warfare


        ---

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


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


        Alternate route: `/v1/characters/{character_id}/fw/stats/`


        Alternate route: `/v2/characters/{character_id}/fw/stats/`


        ---

        This route expires daily at 11:05'
      operationId: get_characters_character_id_fw_stats
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: Faction warfare statistics for a 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:
                  current_rank:
                    description: The given character's current faction rank
                    format: int32
                    maximum: 9
                    minimum: 0
                    title: get_characters_character_id_fw_stats_current_rank
                    type: integer
                  enlisted_on:
                    description: The enlistment date of the given character into faction warfare. Will not be included if character is not enlisted in faction warfare
                    format: date-time
                    title: get_characters_character_id_fw_stats_enlisted_on
                    type: string
                  faction_id:
                    description: The faction the given character is enlisted to fight for. Will not be included if character is not enlisted in faction warfare
                    format: int32
                    title: get_characters_character_id_fw_stats_faction_id
                    type: integer
                  highest_rank:
                    description: The given character's highest faction rank achieved
                    format: int32
                    maximum: 9
                    minimum: 0
                    title: get_characters_character_id_fw_stats_highest_rank
                    type: integer
                  kills:
                    description: Summary of kills done by the given character against enemy factions
                    properties:
                      last_week:
                        description: Last week's total number of kills by a given character against enemy factions
                        format: int32
                        title: get_characters_character_id_fw_stats_last_week
                        type: integer
                      total:
                        description: Total number of kills by a given character against enemy factions since the character enlisted
                        format: int32
                        title: get_characters_character_id_fw_stats_total
                        type: integer
                      yesterday:
                        description: Yesterday's total number of kills by a given character against enemy factions
                        format: int32
                        title: get_characters_character_id_fw_stats_yesterday
                        type: integer
                    required:
                    - yesterday
                    - last_week
                    - total
                    title: get_characters_character_id_fw_stats_kills
                    type: object
                  victory_points:
                    description: Summary of victory points gained by the given character for the enlisted faction
                    properties:
                      last_week:
                        description: Last week's victory points gained by the given character
                        format: int32
                        title: get_characters_character_id_fw_stats_victory_points_last_week
                        type: integer
                      total:
                        description: Total victory points gained since the given character enlisted
                        format: int32
                        title: get_characters_character_id_fw_stats_victory_points_total
                        type: integer
                      yesterday:
                        description: Yesterday's victory points gained by the given character
                        format: int32
                        title: get_characters_character_id_fw_stats_victory_points_yesterday
                        type: integer
                    required:
                    - yesterday
                    - last_week
                    - total
                    title: get_characters_character_id_fw_stats_victory_points
                    type: object
                required:
                - kills
                - victory_points
                title: get_characters_character_id_fw_stats_ok
                type: object
              examples:
                response:
                  value:
                    enlisted_on: 2017-10-17 00:00:00+00:00
                    faction_id: 500001
                    kills:
                      last_week: 893
                      total: 684350
                      yesterday: 136
                    victory_points:
                      last_week: 102640
                      total: 52658260
                      yesterday: 15980
        '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_fw_stats.v1
      summary: EVE Online Overview of a Character Involved in Faction Warfare
      tags:
      - Faction Warfare
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /corporations/{corporation_id}/fw/stats/:
    get:
      description: 'Statistics about a corporation involved in faction warfare


        ---

        Alternate route: `/dev/corporations/{corporation_id}/fw/stats/`


        Alternate route: `/legacy/corporations/{corporation_id}/fw/stats/`


        Alternate route: `/v1/corporations/{corporation_id}/fw/stats/`


        Alternate route: `/v2/corporations/{corporation_id}/fw/stats/`


        ---

        This route expires daily at 11:05'
      operationId: get_corporations_corporation_id_fw_stats
      parameters:
      - $ref: '#/components/parameters/corporation_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: Faction warfare statistics for a given corporation
          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:
                  enlisted_on:
                    description: The enlistment date of the given corporation into faction warfare. Will not be included if corporation is not enlisted in faction warfare
                    format: date-time
                    title: get_corporations_corporation_id_fw_stats_enlisted_on
                    type: string
                  faction_id:
                    description: The faction the given corporation is enlisted to fight for. Will not be included if corporation is not enlisted in faction warfare
                    format: int32
                    title: get_corporations_corporation_id_fw_stats_faction_id
                    type: integer
                  kills:
                    description: Summary of kills done by the given corporation against enemy factions
                    properties:
                      last_week:
                        description: Last week's total number of kills by members of the given corporation against enemy factions
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_last_week
                        type: integer
                      total:
                        description: Total number of kills by members of the given corporation against enemy factions since the corporation enlisted
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_total
                        type: integer
                      yesterday:
                        description: Yesterday's total number of kills by members of the given corporation against enemy factions
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_yesterday
                        type: integer
                    required:
                    - yesterday
                    - last_week
                    - total
                    title: get_corporations_corporation_id_fw_stats_kills
                    type: object
                  pilots:
                    description: How many pilots the enlisted corporation has. Will not be included if corporation is not enlisted in faction warfare
                    format: int32
                    title: get_corporations_corporation_id_fw_stats_pilots
                    type: integer
                  victory_points:
                    description: Summary of victory points gained by the given corporation for the enlisted faction
                    properties:
                      last_week:
                        description: Last week's victory points gained by members of the given corporation
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_victory_points_last_week
                        type: integer
                      total:
                        description: Total victory points gained since the given corporation enlisted
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_victory_points_total
                        type: integer
                      yesterday:
                        description: Yesterday's victory points gained by members of the given corporation
                        format: int32
                        title: get_corporations_corporation_id_fw_stats_victory_points_yesterday
                        type: integer
                    required:
                    - yesterday
                    - last_week
                    - total
                    title: get_corporations_corporation_id_fw_stats_victory_points
                    type: object
                required:
                - kills
                - victory_points
                title: get_corporations_corporation_id_fw_stats_ok
                type: object
              examples:
                response:
                  value:
                    enlisted_on: 2017-10-17 00:00:00+00:00
                    faction_id: 500001
                    kills:
                      last_week: 893
                      total: 684350
                      yesterday: 136
                    pilots: 28863
                    victory_points:
                      last_week: 102640
                      total: 52658260
                      yesterday: 15980
        '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-corporations.read_fw_stats.v1
      summary: EVE Online Overview of a Corporation Involved in Faction Warfare
      tags:
      - Faction Warfare
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /fw/leaderboards/:
    get:
      description: 'Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday


        ---

        Alternate route: `/dev/fw/leaderboards/`


        Alternate route: `/legacy/fw/leaderboards/`


        Alternate route: `/v1/fw/leaderboards/`


        Alternate route: `/v2/fw/leaderboards/`


        ---

        This route expires daily at 11:05'
      operationId: get_fw_leaderboards
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Corporation leaderboard of kills and victory points within faction warfare
          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:
                  kills:
                    description: Top 4 rankings of factions by number of kills from yesterday, last week and in total
                    properties:
                      active_total:
                        description: Top 4 ranking of factions active in faction warfare by total kills. A faction is considered "active" if they have participated in faction warfare in the past 14 days
                        items:
                          description: active_total object
                          properties:
                            amount:
                              description: Amount of kills
                              format: int32
                              title: get_fw_leaderboards_amount
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_faction_id
                              type: integer
                          title: get_fw_leaderboards_active_total_active_total
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_active_total
                        type: array
                      last_week:
                        description: Top 4 ranking of factions by kills in the past week
                        items:
                          description: last_week object
                          properties:
                            amount:
                              description: Amount of kills
                              format: int32
                              title: get_fw_leaderboards_last_week_amount
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_last_week_faction_id
                              type: integer
                          title: get_fw_leaderboards_last_week_last_week
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_last_week
                        type: array
                      yesterday:
                        description: Top 4 ranking of factions by kills in the past day
                        items:
                          description: yesterday object
                          properties:
                            amount:
                              description: Amount of kills
                              format: int32
                              title: get_fw_leaderboards_yesterday_amount
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_yesterday_faction_id
                              type: integer
                          title: get_fw_leaderboards_yesterday_yesterday
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_yesterday
                        type: array
                    required:
                    - yesterday
                    - last_week
                    - active_total
                    title: get_fw_leaderboards_kills
                    type: object
                  victory_points:
                    description: Top 4 rankings of factions by victory points from yesterday, last week and in total
                    properties:
                      active_total:
                        description: Top 4 ranking of factions active in faction warfare by total victory points. A faction is considered "active" if they have participated in faction warfare in the past 14 days
                        items:
                          description: active_total object
                          properties:
                            amount:
                              description: Amount of victory points
                              format: int32
                              title: get_fw_leaderboards_active_total_amount
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_active_total_faction_id
                              type: integer
                          title: get_fw_leaderboards_active_total_active_total_1
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_victory_points_active_total
                        type: array
                      last_week:
                        description: Top 4 ranking of factions by victory points in the past week
                        items:
                          description: last_week object
                          properties:
                            amount:
                              description: Amount of victory points
                              format: int32
                              title: get_fw_leaderboards_last_week_amount_1
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_last_week_faction_id_1
                              type: integer
                          title: get_fw_leaderboards_last_week_last_week_1
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_victory_points_last_week
                        type: array
                      yesterday:
                        description: Top 4 ranking of factions by victory points in the past day
                        items:
                          description: yesterday object
                          properties:
                            amount:
                              description: Amount of victory points
                              format: int32
                              title: get_fw_leaderboards_yesterday_amount_1
                              type: integer
                            faction_id:
                              description: faction_id integer
                              format: int32
                              title: get_fw_leaderboards_yesterday_faction_id_1
                              type: integer
                          title: get_fw_leaderboards_yesterday_yesterday_1
                          type: object
                        maxItems: 4
                        title: get_fw_leaderboards_victory_points_yesterday
                        type: array
                    required:
                    - yesterday
                    - last_week
                    - active_total
                    title: get_fw_leaderboards_victory_points
                    type: object
                required:
                - kills
                - victory_points
                title: get_fw_leaderboards_ok
                type: object
              examples:
                response:
                  value:
                    kills:
                      active_total:
                      - amount: 832273
                        faction_id: 500004
                      - amount: 687915
                        faction_id: 500001
                      last_week:
                      - amount: 730
                        faction_id: 500001
                      - amount: 671
                        faction_id: 500004
                      yesterday:
                      - amount: 100
                        faction_id: 500001
                      - amount: 50
                        faction_id: 500004
                    victory_points:
                      active_total:
                      - amount: 53130500
                        faction_id: 500001
                      - amount: 50964263
                        faction_id: 500004
                      last_week:
                      - amount: 97360
                        faction_id: 500001
                      - amount: 84980
                        faction_id: 500004
                      yesterday:
                      - amount: 5000
                        faction_id: 500002
                      - amount: 3500
                        faction_id: 500003
        '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
        '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 List of the Top Factions in Faction Warfare
      tags:
      - Faction Warfare
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /fw/leaderboards/characters/:
    get:
      description: 'Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday


        ---

        Alternate route: `/dev/fw/leaderboards/characters/`


        Alternate route: `/legacy/fw/leaderboards/characters/`


        Alternate route: `/v1/fw/leaderboards/characters/`


        Alternate route: `/v2/fw/leaderboards/characters/`


        ---

        This route expires daily at 11:05'
      operationId: get_fw_leaderboards_characters
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Character leaderboard of kills and victory points within faction warfare
          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:
                  kills:
                    description: Top 100 rankings of pilots by number of kills from yesterday, last week and in total
                    properties:
                      acti

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