EVE Online Alliance API

The Alliance API from EVE Online — 8 operation(s) for alliance.

OpenAPI Specification

eve-online-alliance-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Alliance
paths:
  /alliances/:
    get:
      description: 'List all active player alliances


        ---

        Alternate route: `/dev/alliances/`


        Alternate route: `/legacy/alliances/`


        Alternate route: `/v1/alliances/`


        Alternate route: `/v2/alliances/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_alliances
      parameters:
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: List of Alliance IDs
          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
                  minimum: 0
                  title: get_alliances_200_ok
                  type: integer
                  uniqueItems: true
                maxItems: 5000
                title: get_alliances_ok
                type: array
              examples:
                response:
                  value:
                  - 99000001
                  - 99000002
        '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 All Alliances
      tags:
      - Alliance
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /alliances/{alliance_id}/:
    get:
      description: 'Public information about an alliance


        ---

        Alternate route: `/dev/alliances/{alliance_id}/`


        Alternate route: `/legacy/alliances/{alliance_id}/`


        Alternate route: `/v3/alliances/{alliance_id}/`


        Alternate route: `/v4/alliances/{alliance_id}/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_alliances_alliance_id
      parameters:
      - $ref: '#/components/parameters/alliance_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Public data about an alliance
          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:
                  creator_corporation_id:
                    description: ID of the corporation that created the alliance
                    format: int32
                    title: get_alliances_alliance_id_creator_corporation_id
                    type: integer
                  creator_id:
                    description: ID of the character that created the alliance
                    format: int32
                    title: get_alliances_alliance_id_creator_id
                    type: integer
                  date_founded:
                    description: date_founded string
                    format: date-time
                    title: get_alliances_alliance_id_date_founded
                    type: string
                  executor_corporation_id:
                    description: the executor corporation ID, if this alliance is not closed
                    format: int32
                    title: get_alliances_alliance_id_executor_corporation_id
                    type: integer
                  faction_id:
                    description: Faction ID this alliance is fighting for, if this alliance is enlisted in factional warfare
                    format: int32
                    title: get_alliances_alliance_id_faction_id
                    type: integer
                  name:
                    description: the full name of the alliance
                    title: get_alliances_alliance_id_name
                    type: string
                  ticker:
                    description: the short name of the alliance
                    title: get_alliances_alliance_id_ticker
                    type: string
                required:
                - name
                - creator_id
                - creator_corporation_id
                - ticker
                - date_founded
                title: get_alliances_alliance_id_ok
                type: object
              examples:
                response:
                  value:
                    creator_corporation_id: 45678
                    creator_id: 12345
                    date_founded: 2016-06-26 21:00:00+00:00
                    executor_corporation_id: 98356193
                    name: C C P Alliance
                    ticker: <C C P>
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '404':
          description: Alliance not found
          content:
            application/json:
              schema:
                description: Not found
                properties:
                  error:
                    description: Not found message
                    title: get_alliances_alliance_id_404_not_found
                    type: string
                title: get_alliances_alliance_id_not_found
                type: object
              examples:
                response:
                  value:
                    error: Not found message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      summary: EVE Online Get Alliance Information
      tags:
      - Alliance
      x-alternate-versions:
      - dev
      - legacy
      - v3
      - v4
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /alliances/{alliance_id}/corporations/:
    get:
      description: 'List all current member corporations of an alliance


        ---

        Alternate route: `/dev/alliances/{alliance_id}/corporations/`


        Alternate route: `/legacy/alliances/{alliance_id}/corporations/`


        Alternate route: `/v1/alliances/{alliance_id}/corporations/`


        Alternate route: `/v2/alliances/{alliance_id}/corporations/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_alliances_alliance_id_corporations
      parameters:
      - $ref: '#/components/parameters/alliance_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: List of corporation IDs
          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
                  minimum: 0
                  title: get_alliances_alliance_id_corporations_200_ok
                  type: integer
                  uniqueItems: true
                maxItems: 1000
                title: get_alliances_alliance_id_corporations_ok
                type: array
              examples:
                response:
                  value:
                  - 98000001
        '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 Alliance's Corporations
      tags:
      - Alliance
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /alliances/{alliance_id}/icons/:
    get:
      description: 'Get the icon urls for a alliance


        ---

        Alternate route: `/dev/alliances/{alliance_id}/icons/`


        Alternate route: `/legacy/alliances/{alliance_id}/icons/`


        Alternate route: `/v1/alliances/{alliance_id}/icons/`


        Alternate route: `/v2/alliances/{alliance_id}/icons/`


        ---

        This route expires daily at 11:05'
      operationId: get_alliances_alliance_id_icons
      parameters:
      - $ref: '#/components/parameters/alliance_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: Icon URLs for the given alliance id and server
          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:
                  px128x128:
                    description: px128x128 string
                    title: get_alliances_alliance_id_icons_px128x128
                    type: string
                  px64x64:
                    description: px64x64 string
                    title: get_alliances_alliance_id_icons_px64x64
                    type: string
                title: get_alliances_alliance_id_icons_ok
                type: object
              examples:
                response:
                  value:
                    px128x128: https://images.evetech.net/alliances/503818424/logo?tenant=tranquility&size=128
                    px64x64: https://images.evetech.net/alliances/503818424/logo?tenant=tranquility&size=64
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '404':
          description: No image server for this datasource
          content:
            application/json:
              schema:
                description: No image server for this datasource
                properties:
                  error:
                    description: error message
                    title: get_alliances_alliance_id_icons_error
                    type: string
                title: get_alliances_alliance_id_icons_not_found
                type: object
              examples:
                response:
                  value:
                    error: No image server for this datasource
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      summary: EVE Online Get Alliance Icon
      tags:
      - Alliance
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/alliances/:
    get:
      description: 'List all active player alliances


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_alliances
      parameters:
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: List of Alliance IDs
          examples:
            application/json:
            - 99000001
            - 99000002
          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
              minimum: 0
              title: get_alliances_200_ok
              type: integer
              uniqueItems: true
            maxItems: 5000
            title: get_alliances_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 all alliances
      tags:
      - Alliance
      x-alternate-versions:
      - latest
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
  /v1/alliances/{alliance_id}/corporations/:
    get:
      description: 'List all current member corporations of an alliance


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_alliances_alliance_id_corporations
      parameters:
      - $ref: '#/parameters/alliance_id'
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: List of corporation IDs
          examples:
            application/json:
            - 98000001
          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
              minimum: 0
              title: get_alliances_alliance_id_corporations_200_ok
              type: integer
              uniqueItems: true
            maxItems: 1000
            title: get_alliances_alliance_id_corporations_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 alliance's corporations
      tags:
      - Alliance
      x-alternate-versions:
      - latest
      - legacy
      - v1
      - v2
      x-cached-seconds: 3600
  /v1/alliances/{alliance_id}/icons/:
    get:
      description: 'Get the icon urls for a alliance


        ---


        This route expires daily at 11:05'
      operationId: get_alliances_alliance_id_icons
      parameters:
      - $ref: '#/parameters/alliance_id'
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: Icon URLs for the given alliance id and server
          examples:
            application/json:
              px128x128: https://images.evetech.net/alliances/503818424/logo?tenant=tranquility&size=128
              px64x64: https://images.evetech.net/alliances/503818424/logo?tenant=tranquility&size=64
          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:
              px128x128:
                description: px128x128 string
                title: get_alliances_alliance_id_icons_px128x128
                type: string
              px64x64:
                description: px64x64 string
                title: get_alliances_alliance_id_icons_px64x64
                type: string
            title: get_alliances_alliance_id_icons_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'
        '404':
          description: No image server for this datasource
          examples:
            application/json:
              error: No image server for this datasource
          schema:
            description: No image server for this datasource
            properties:
              error:
                description: error message
                title: get_alliances_alliance_id_icons_error
                type: string
            title: get_alliances_alliance_id_icons_not_found
            type: object
        '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: Get alliance icon
      tags:
      - Alliance
      x-alternate-versions:
      - latest
      - legacy
      - v1
      - v2
  /v3/alliances/{alliance_id}/:
    get:
      description: 'Public information about an alliance


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_alliances_alliance_id
      parameters:
      - $ref: '#/parameters/alliance_id'
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: Public data about an alliance
          examples:
            application/json:
              creator_corporation_id: 45678
              creator_id: 12345
              date_founded: '2016-06-26T21:00:00Z'
              executor_corporation_id: 98356193
              name: C C P Alliance
              ticker: <C C P>
          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:
              creator_corporation_id:
                description: ID of the corporation that created the alliance
                format: int32
                title: get_alliances_alliance_id_creator_corporation_id
                type: integer
              creator_id:
                description: ID of the character that created the alliance
                format: int32
                title: get_alliances_alliance_id_creator_id
                type: integer
              date_founded:
                description: date_founded string
                format: date-time
                title: get_alliances_alliance_id_date_founded
                type: string
              executor_corporation_id:
                de

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