EVE Online Sovereignty API

openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Sovereignty API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Sovereignty
paths:
  /sovereignty/campaigns/:
    get:
      description: 'Shows sovereignty data for campaigns.


        ---

        Alternate route: `/dev/sovereignty/campaigns/`


        Alternate route: `/legacy/sovereignty/campaigns/`


        Alternate route: `/v1/sovereignty/campaigns/`


        ---

        This route is cached for up to 5 seconds'
      operationId: get_sovereignty_campaigns
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: A list of sovereignty campaigns
          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:
                    attackers_score:
                      description: 'Score for all attacking parties, only present in Defense Events.

                        '
                      format: float
                      title: get_sovereignty_campaigns_attackers_score
                      type: number
                    campaign_id:
                      description: Unique ID for this campaign.
                      format: int32
                      title: get_sovereignty_campaigns_campaign_id
                      type: integer
                    constellation_id:
                      description: 'The constellation in which the campaign will take place.

                        '
                      format: int32
                      title: get_sovereignty_campaigns_constellation_id
                      type: integer
                    defender_id:
                      description: 'Defending alliance, only present in Defense Events

                        '
                      format: int32
                      title: get_sovereignty_campaigns_defender_id
                      type: integer
                    defender_score:
                      description: 'Score for the defending alliance, only present in Defense Events.

                        '
                      format: float
                      title: get_sovereignty_campaigns_defender_score
                      type: number
                    event_type:
                      description: 'Type of event this campaign is for. tcu_defense, ihub_defense and station_defense are referred to as "Defense Events", station_freeport as "Freeport Events".

                        '
                      enum:
                      - tcu_defense
                      - ihub_defense
                      - station_defense
                      - station_freeport
                      title: get_sovereignty_campaigns_event_type
                      type: string
                    participants:
                      description: 'Alliance participating and their respective scores, only present in Freeport Events.

                        '
                      items:
                        description: participant object
                        properties:
                          alliance_id:
                            description: alliance_id integer
                            format: int32
                            title: get_sovereignty_campaigns_alliance_id
                            type: integer
                          score:
                            description: score number
                            format: float
                            title: get_sovereignty_campaigns_score
                            type: number
                        required:
                        - alliance_id
                        - score
                        title: get_sovereignty_campaigns_participant
                        type: object
                      maxItems: 5000
                      title: get_sovereignty_campaigns_participants
                      type: array
                    solar_system_id:
                      description: 'The solar system the structure is located in.

                        '
                      format: int32
                      title: get_sovereignty_campaigns_solar_system_id
                      type: integer
                    start_time:
                      description: 'Time the event is scheduled to start.

                        '
                      format: date-time
                      title: get_sovereignty_campaigns_start_time
                      type: string
                    structure_id:
                      description: 'The structure item ID that is related to this campaign.

                        '
                      format: int64
                      title: get_sovereignty_campaigns_structure_id
                      type: integer
                  required:
                  - campaign_id
                  - structure_id
                  - solar_system_id
                  - constellation_id
                  - event_type
                  - start_time
                  title: get_sovereignty_campaigns_200_ok
                  type: object
                maxItems: 10000
                title: get_sovereignty_campaigns_ok
                type: array
              examples:
                response:
                  value:
                  - attackers_score: 0.4
                    campaign_id: 32833
                    constellation_id: 20000125
                    defender_id: 1695357456
                    defender_score: 0.6
                    event_type: station_defense
                    solar_system_id: 30000856
                    start_time: 2016-10-29 14:34:40+00:00
                    structure_id: 61001096
        '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 Sovereignty Campaigns
      tags:
      - Sovereignty
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sovereignty/map/:
    get:
      description: 'Shows sovereignty information for solar systems


        ---

        Alternate route: `/dev/sovereignty/map/`


        Alternate route: `/legacy/sovereignty/map/`


        Alternate route: `/v1/sovereignty/map/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_sovereignty_map
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: A list of sovereignty information for solar systems in New Eden
          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:
                    alliance_id:
                      description: alliance_id integer
                      format: int32
                      title: get_sovereignty_map_alliance_id
                      type: integer
                    corporation_id:
                      description: corporation_id integer
                      format: int32
                      title: get_sovereignty_map_corporation_id
                      type: integer
                    faction_id:
                      description: faction_id integer
                      format: int32
                      title: get_sovereignty_map_faction_id
                      type: integer
                    system_id:
                      description: system_id integer
                      format: int32
                      title: get_sovereignty_map_system_id
                      type: integer
                  required:
                  - system_id
                  title: get_sovereignty_map_200_ok
                  type: object
                maxItems: 10000
                title: get_sovereignty_map_ok
                type: array
              examples:
                response:
                  value:
                  - faction_id: 500001
                    system_id: 30045334
        '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 Sovereignty of Systems
      tags:
      - Sovereignty
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sovereignty/structures/:
    get:
      description: 'Shows sovereignty data for structures.


        ---

        Alternate route: `/dev/sovereignty/structures/`


        Alternate route: `/legacy/sovereignty/structures/`


        Alternate route: `/v1/sovereignty/structures/`


        ---

        This route is cached for up to 120 seconds'
      operationId: get_sovereignty_structures
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: A list of sovereignty structures
          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:
                    alliance_id:
                      description: 'The alliance that owns the structure.

                        '
                      format: int32
                      title: get_sovereignty_structures_alliance_id
                      type: integer
                    solar_system_id:
                      description: 'Solar system in which the structure is located.

                        '
                      format: int32
                      title: get_sovereignty_structures_solar_system_id
                      type: integer
                    structure_id:
                      description: Unique item ID for this structure.
                      format: int64
                      title: get_sovereignty_structures_structure_id
                      type: integer
                    structure_type_id:
                      description: 'A reference to the type of structure this is.

                        '
                      format: int32
                      title: get_sovereignty_structures_structure_type_id
                      type: integer
                    vulnerability_occupancy_level:
                      description: 'The occupancy level for the next or current vulnerability window. This takes into account all development indexes and capital system bonuses. Also known as Activity Defense Multiplier from in the client. It increases the time that attackers must spend using their entosis links on the structure.

                        '
                      format: float
                      title: get_sovereignty_structures_vulnerability_occupancy_level
                      type: number
                    vulnerable_end_time:
                      description: 'The time at which the next or current vulnerability window ends. At the end of a vulnerability window the next window is recalculated and locked in along with the vulnerabilityOccupancyLevel. If the structure is not in 100% entosis control of the defender, it will go in to ''overtime'' and stay vulnerable for as long as that situation persists. Only once the defenders have 100% entosis control and has the vulnerableEndTime passed does the vulnerability interval expire and a new one is calculated.

                        '
                      format: date-time
                      title: get_sovereignty_structures_vulnerable_end_time
                      type: string
                    vulnerable_start_time:
                      description: 'The next time at which the structure will become vulnerable. Or the start time of the current window if current time is between this and vulnerableEndTime.

                        '
                      format: date-time
                      title: get_sovereignty_structures_vulnerable_start_time
                      type: string
                  required:
                  - alliance_id
                  - solar_system_id
                  - structure_id
                  - structure_type_id
                  title: get_sovereignty_structures_200_ok
                  type: object
                maxItems: 10000
                title: get_sovereignty_structures_ok
                type: array
              examples:
                response:
                  value:
                  - alliance_id: 498125261
                    solar_system_id: 30000570
                    structure_id: 1018253388776
                    structure_type_id: 32226
                    vulnerability_occupancy_level: 2
                    vulnerable_end_time: 2016-10-29 05:30:00+00:00
                    vulnerable_start_time: 2016-10-28 20:30: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
        '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 Sovereignty Structures
      tags:
      - Sovereignty
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 120
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/sovereignty/campaigns/:
    get:
      description: 'Shows sovereignty data for campaigns.


        ---


        This route is cached for up to 5 seconds'
      operationId: get_sovereignty_campaigns
      parameters:
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: A list of sovereignty campaigns
          examples:
            application/json:
            - attackers_score: 0.4
              campaign_id: 32833
              constellation_id: 20000125
              defender_id: 1695357456
              defender_score: 0.6
              event_type: station_defense
              solar_system_id: 30000856
              start_time: '2016-10-29T14:34:40Z'
              structure_id: 61001096
          headers:
            Cache-Control:
              description: The caching mechanism used
              type: string
            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 object
              properties:
                attackers_score:
                  description: 'Score for all attacking parties, only present in Defense Events.

                    '
                  format: float
                  title: get_sovereignty_campaigns_attackers_score
                  type: number
                campaign_id:
                  description: Unique ID for this campaign.
                  format: int32
                  title: get_sovereignty_campaigns_campaign_id
                  type: integer
                constellation_id:
                  description: 'The constellation in which the campaign will take place.

                    '
                  format: int32
                  title: get_sovereignty_campaigns_constellation_id
                  type: integer
                defender_id:
                  description: 'Defending alliance, only present in Defense Events

                    '
                  format: int32
                  title: get_sovereignty_campaigns_defender_id
                  type: integer
                defender_score:
                  description: 'Score for the defending alliance, only present in Defense Events.

                    '
                  format: float
                  title: get_sovereignty_campaigns_defender_score
                  type: number
                event_type:
                  description: 'Type of event this campaign is for. tcu_defense, ihub_defense and station_defense are referred to as "Defense Events", station_freeport as "Freeport Events".

                    '
                  enum:
                  - tcu_defense
                  - ihub_defense
                  - station_defense
                  - station_freeport
                  title: get_sovereignty_campaigns_event_type
                  type: string
                participants:
                  description: 'Alliance participating and their respective scores, only present in Freeport Events.

                    '
                  items:
                    description: participant object
                    properties:
                      alliance_id:
                        description: alliance_id integer
                        format: int32
                        title: get_sovereignty_campaigns_alliance_id
                        type: integer
                      score:
                        description: score number
                        format: float
                        title: get_sovereignty_campaigns_score
                        type: number
                    required:
                    - alliance_id
                    - score
                    title: get_sovereignty_campaigns_participant
                    type: object
                  maxItems: 5000
                  title: get_sovereignty_campaigns_participants
                  type: array
                solar_system_id:
                  description: 'The solar system the structure is located in.

                    '
                  format: int32
                  title: get_sovereignty_campaigns_solar_system_id
                  type: integer
                start_time:
                  description: 'Time the event is scheduled to start.

                    '
                  format: date-time
                  title: get_sovereignty_campaigns_start_time
                  type: string
                structure_id:
                  description: 'The structure item ID that is related to this campaign.

                    '
                  format: int64
                  title: get_sovereignty_campaigns_structure_id
                  type: integer
              required:
              - campaign_id
              - structure_id
              - solar_system_id
              - constellation_id
              - event_type
              - start_time
              title: get_sovereignty_campaigns_200_ok
              type: object
            maxItems: 10000
            title: get_sovereignty_campaigns_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 sovereignty campaigns
      tags:
      - Sovereignty
      x-alternate-versions:
      - latest
      - legacy
      - v1
      x-cached-seconds: 5
  /v1/sovereignty/map/:
    get:
      description: 'Shows sovereignty information for solar systems


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_sovereignty_map
      parameters:
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: A list of sovereignty information for solar systems in New Eden
          examples:
            application/json:
            - faction_id: 500001
              system_id: 30045334
          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 object
              properties:
                alliance_id:
                  description: alliance_id integer
                  format: int32
                  title: get_sovereignty_map_alliance_id
                  type: integer
                corporation_id:
                  description: corporation_id integer
                  format: int32
                  title: get_sovereignty_map_corporation_id
                  type: integer
                faction_id:
                  description: faction_id integer
                  format: int32
                  title: get_sovereignty_map_faction_id
                  type: integer
                system_id:
                  description: system_id integer
                  format: int32
                  title: get_sovereignty_map_system_id
                  type: integer
              required:
              - system_id
              title: get_sovereignty_map_200_ok
              type: object
            maxItems: 10000
            title: get_sovereignty_map_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 sovereignty of systems
      tags:
      - Sovereignty
      x-alternate-versions:
      - latest
      - legacy
      - v1
      x-cached-seconds: 3600
  /v1/sovereignty/structures/:
    get:
      description: 'Shows sovereignty data for structures.


        ---


        This route is cached for up to 120 seconds'
      operationId: get_sovereignty_structures
      par

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