EVE Online Wars API

The Wars API from EVE Online — 6 operation(s) for wars.

OpenAPI Specification

eve-online-wars-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Wars API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Wars
paths:
  /wars/:
    get:
      description: 'Return a list of wars


        ---

        Alternate route: `/dev/wars/`


        Alternate route: `/legacy/wars/`


        Alternate route: `/v1/wars/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_wars
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - description: Only return wars with ID smaller than this
        in: query
        name: max_war_id
        required: false
        schema:
          type: integer
          format: int32
        example: 28332
      responses:
        '200':
          description: A list of war IDs, in descending order by war_id
          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 integer
                  format: int32
                  title: get_wars_200_ok
                  type: integer
                maxItems: 2000
                title: get_wars_ok
                type: array
              examples:
                response:
                  value:
                  - 3
                  - 2
                  - 1
        '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 Wars
      tags:
      - Wars
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wars/{war_id}/:
    get:
      description: 'Return details about a war


        ---

        Alternate route: `/dev/wars/{war_id}/`


        Alternate route: `/legacy/wars/{war_id}/`


        Alternate route: `/v1/wars/{war_id}/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_wars_war_id
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - description: ID for a war
        in: path
        name: war_id
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
        example: 28332
      responses:
        '200':
          description: Details about a war
          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:
                  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_ally_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_ally_corporation_id
                          type: integer
                      title: get_wars_war_id_ally
                      type: object
                    maxItems: 10000
                    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_defender_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_defender_corporation_id
                        type: integer
                      isk_destroyed:
                        description: ISK value of ships the defender has killed
                        format: float
                        title: get_wars_war_id_defender_isk_destroyed
                        type: number
                      ships_killed:
                        description: The number of ships the defender has killed
                        format: int32
                        title: get_wars_war_id_defender_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
              examples:
                response:
                  value:
                    aggressor:
                      corporation_id: 986665792
                      isk_destroyed: 0
                      ships_killed: 0
                    declared: 2004-05-22 05:20:00+00:00
                    defender:
                      corporation_id: 1001562011
                      isk_destroyed: 0
                      ships_killed: 0
                    id: 1941
                    mutual: false
                    open_for_allies: false
        '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
        '422':
          description: War not found
          content:
            application/json:
              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
              examples:
                response:
                  value:
                    error: Unprocessable entity 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 War Information
      tags:
      - Wars
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wars/{war_id}/killmails/:
    get:
      description: 'Return a list of kills related to a war


        ---

        Alternate route: `/dev/wars/{war_id}/killmails/`


        Alternate route: `/legacy/wars/{war_id}/killmails/`


        Alternate route: `/v1/wars/{war_id}/killmails/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_wars_war_id_killmails
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - description: A valid war ID
        in: path
        name: war_id
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
        example: 28332
      responses:
        '200':
          description: A list of killmail IDs and hashes
          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:
                    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
                maxItems: 2000
                title: get_wars_war_id_killmails_ok
                type: array
              examples:
                response:
                  value:
                  - killmail_hash: 8eef5e8fb6b88fe3407c489df33822b2e3b57a5e
                    killmail_id: 2
                  - killmail_hash: b41ccb498ece33d64019f64c0db392aa3aa701fb
                    killmail_id: 1
        '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
        '422':
          description: War not found
          content:
            application/json:
              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
              examples:
                response:
                  value:
                    error: Unprocessable entity 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 Kills for a War
      tags:
      - Wars
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/wars/:
    get:
      description: 'Return a list of wars


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_wars
      parameters:
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      - description: Only return wars with ID smaller than this
        format: int32
        in: query
        name: max_war_id
        required: false
        type: integer
      responses:
        '200':
          description: A list of war IDs, in descending order by war_id
          examples:
            application/json:
            - 3
            - 2
            - 1
          headers:
            Cache-Control:
              description: The caching mechanism used
              type: string
            ETag:
              description: RFC7232 compliant entity tag
              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
            maxItems: 2000
            title: get_wars_ok
            type: array
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              type: string
            ETag:
              description: RFC7232 compliant entity tag
              type: string
            Expires:
              description: RFC7231 formatted datetime string
              type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              type: string
        '400':
          description: Bad request
          examples:
            application/json:
              error: Bad request message
          schema:
            $ref: '#/definitions/bad_request'
        '420':
          description: Error limited
          examples:
            application/json:
              error: Error limited message
          schema:
            $ref: '#/definitions/error_limited'
        '500':
          description: Internal server error
          examples:
            application/json:
              error: Internal server error message
          schema:
            $ref: '#/definitions/internal_server_error'
        '503':
          description: Service unavailable
          examples:
            application/json:
              error: Service unavailable message
          schema:
            $ref: '#/definitions/service_unavailable'
        '504':
          description: Gateway timeout
          examples:
            application/json:
              error: Gateway timeout message
          schema:
            $ref: '#/definitions/gateway_timeout'
      summary: List wars
      tags:
      - Wars
      x-alternate-versions:
      - latest
      - legacy
      - v1
      x-cached-seconds: 3600
  /v1/wars/{war_id}/:
    get:
      description: 'Return details about a war


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_wars_war_id
      parameters:
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      - description: ID for a war
        format: int32
        in: path
        minimum: 1
        name: war_id
        required: true
        type: integer
      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
            ETag:
              description: RFC7232 compliant entity tag
              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_ally_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_ally_corporation_id
                      type: integer
                  title: get_wars_war_id_ally
                  type: object
                maxItems: 10000
                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_defender_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_defender_corporation_id
                    type: integer
                  isk_destroyed:
                    description: ISK value of ships the defender has killed
                    format: float
                    title: get_wars_war_id_defender_isk_destroyed
                    type: number
                  ships_killed:
                    description: The number of ships the defender has killed
                    format: int32
                    title: get_wars_war_id_defender_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
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              type: string
            ETag:
              description: RFC7232 compliant entity tag
              type: string
            Expires:
              description: RFC7231 formatted datetime string
              type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              type: string
        '400':
          description: Bad request
          examples:
            application/json:
              error: Bad request message
          schema:
            $ref: '#/definitions/bad_request'
        '420':
          description: Error limited
          examples:
            application/json:
              error: Error limited message
          schema:
            $ref: '#/definitions/error_limited'
        '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: Internal server error message
          schema:
            $ref: '#/definitions/internal_server_error'
        '503':
          description: Service unavailable
          examples:
            application/json:
              error: Service unavailable message
          schema:
            $ref: '#/definitions/service_unavailable'
   

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