EVE Online Loyalty API

openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Loyalty API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Loyalty
paths:
  /characters/{character_id}/loyalty/points/:
    get:
      description: 'Return a list of loyalty points for all corporations the character has worked for


        ---

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


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


        Alternate route: `/v1/characters/{character_id}/loyalty/points/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_characters_character_id_loyalty_points
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of loyalty points
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    corporation_id:
                      description: corporation_id integer
                      format: int32
                      title: get_characters_character_id_loyalty_points_corporation_id
                      type: integer
                    loyalty_points:
                      description: loyalty_points integer
                      format: int32
                      title: get_characters_character_id_loyalty_points_loyalty_points
                      type: integer
                  required:
                  - corporation_id
                  - loyalty_points
                  title: get_characters_character_id_loyalty_points_200_ok
                  type: object
                maxItems: 500
                title: get_characters_character_id_loyalty_points_ok
                type: array
              examples:
                response:
                  value:
                  - corporation_id: 123
                    loyalty_points: 100
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-characters.read_loyalty.v1
      summary: EVE Online Get Loyalty Points
      tags:
      - Loyalty
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /loyalty/stores/{corporation_id}/offers/:
    get:
      description: 'Return a list of offers from a specific corporation''s loyalty store


        ---

        Alternate route: `/dev/loyalty/stores/{corporation_id}/offers/`


        Alternate route: `/legacy/loyalty/stores/{corporation_id}/offers/`


        Alternate route: `/v1/loyalty/stores/{corporation_id}/offers/`


        ---

        This route expires daily at 11:05'
      operationId: get_loyalty_stores_corporation_id_offers
      parameters:
      - $ref: '#/components/parameters/corporation_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      responses:
        '200':
          description: A list of offers
          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:
                    ak_cost:
                      description: Analysis kredit cost
                      format: int32
                      title: get_loyalty_stores_corporation_id_offers_ak_cost
                      type: integer
                    isk_cost:
                      description: isk_cost integer
                      format: int64
                      title: get_loyalty_stores_corporation_id_offers_isk_cost
                      type: integer
                    lp_cost:
                      description: lp_cost integer
                      format: int32
                      title: get_loyalty_stores_corporation_id_offers_lp_cost
                      type: integer
                    offer_id:
                      description: offer_id integer
                      format: int32
                      title: get_loyalty_stores_corporation_id_offers_offer_id
                      type: integer
                    quantity:
                      description: quantity integer
                      format: int32
                      title: get_loyalty_stores_corporation_id_offers_quantity
                      type: integer
                    required_items:
                      description: required_items array
                      items:
                        description: required_item object
                        properties:
                          quantity:
                            description: quantity integer
                            format: int32
                            title: get_loyalty_stores_corporation_id_offers_required_item_quantity
                            type: integer
                          type_id:
                            description: type_id integer
                            format: int32
                            title: get_loyalty_stores_corporation_id_offers_required_item_type_id
                            type: integer
                        required:
                        - type_id
                        - quantity
                        title: get_loyalty_stores_corporation_id_offers_required_item
                        type: object
                      maxItems: 100
                      title: get_loyalty_stores_corporation_id_offers_required_items
                      type: array
                    type_id:
                      description: type_id integer
                      format: int32
                      title: get_loyalty_stores_corporation_id_offers_type_id
                      type: integer
                  required:
                  - offer_id
                  - type_id
                  - quantity
                  - lp_cost
                  - isk_cost
                  - required_items
                  title: get_loyalty_stores_corporation_id_offers_200_ok
                  type: object
                maxItems: 10000
                title: get_loyalty_stores_corporation_id_offers_ok
                type: array
              examples:
                response:
                  value:
                  - ak_cost: 35000
                    isk_cost: 0
                    lp_cost: 100
                    offer_id: 1
                    quantity: 1
                    required_items: []
                    type_id: 123
                  - isk_cost: 1000
                    lp_cost: 100
                    offer_id: 2
                    quantity: 10
                    required_items:
                    - quantity: 10
                      type_id: 1234
                    type_id: 1235
        '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 loyalty point store found for the provided corporation
          content:
            application/json:
              schema:
                description: Not found
                properties:
                  error:
                    description: Not found message
                    title: get_loyalty_stores_corporation_id_offers_404_not_found
                    type: string
                title: get_loyalty_stores_corporation_id_offers_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 List Loyalty Store Offers
      tags:
      - Loyalty
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/characters/{character_id}/loyalty/points/:
    get:
      description: 'Return a list of loyalty points for all corporations the character has worked for


        ---


        This route is cached for up to 3600 seconds'
      operationId: get_characters_character_id_loyalty_points
      parameters:
      - $ref: '#/parameters/character_id'
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      - $ref: '#/parameters/token'
      responses:
        '200':
          description: A list of loyalty points
          examples:
            application/json:
            - corporation_id: 123
              loyalty_points: 100
          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:
                corporation_id:
                  description: corporation_id integer
                  format: int32
                  title: get_characters_character_id_loyalty_points_corporation_id
                  type: integer
                loyalty_points:
                  description: loyalty_points integer
                  format: int32
                  title: get_characters_character_id_loyalty_points_loyalty_points
                  type: integer
              required:
              - corporation_id
              - loyalty_points
              title: get_characters_character_id_loyalty_points_200_ok
              type: object
            maxItems: 500
            title: get_characters_character_id_loyalty_points_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'
        '401':
          description: Unauthorized
          examples:
            application/json:
              error: Unauthorized message
          schema:
            $ref: '#/definitions/unauthorized'
        '403':
          description: Forbidden
          examples:
            application/json:
              error: Forbidden message
          schema:
            $ref: '#/definitions/forbidden'
        '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'
      security:
      - evesso:
        - esi-characters.read_loyalty.v1
      summary: Get loyalty points
      tags:
      - Loyalty
      x-alternate-versions:
      - latest
      - legacy
      - v1
      x-cached-seconds: 3600
  /v1/loyalty/stores/{corporation_id}/offers/:
    get:
      description: 'Return a list of offers from a specific corporation''s loyalty store


        ---


        This route expires daily at 11:05'
      operationId: get_loyalty_stores_corporation_id_offers
      parameters:
      - $ref: '#/parameters/corporation_id'
      - $ref: '#/parameters/datasource'
      - $ref: '#/parameters/If-None-Match'
      responses:
        '200':
          description: A list of offers
          examples:
            application/json:
            - ak_cost: 35000
              isk_cost: 0
              lp_cost: 100
              offer_id: 1
              quantity: 1
              required_items: []
              type_id: 123
            - isk_cost: 1000
              lp_cost: 100
              offer_id: 2
              quantity: 10
              required_items:
              - quantity: 10
                type_id: 1234
              type_id: 1235
          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:
                ak_cost:
                  description: Analysis kredit cost
                  format: int32
                  title: get_loyalty_stores_corporation_id_offers_ak_cost
                  type: integer
                isk_cost:
                  description: isk_cost integer
                  format: int64
                  title: get_loyalty_stores_corporation_id_offers_isk_cost
                  type: integer
                lp_cost:
                  description: lp_cost integer
                  format: int32
                  title: get_loyalty_stores_corporation_id_offers_lp_cost
                  type: integer
                offer_id:
                  description: offer_id integer
                  format: int32
                  title: get_loyalty_stores_corporation_id_offers_offer_id
                  type: integer
                quantity:
                  description: quantity integer
                  format: int32
                  title: get_loyalty_stores_corporation_id_offers_quantity
                  type: integer
                required_items:
                  description: required_items array
                  items:
                    description: required_item object
                    properties:
                      quantity:
                        description: quantity integer
                        format: int32
                        title: get_loyalty_stores_corporation_id_offers_required_item_quantity
                        type: integer
                      type_id:
                        description: type_id integer
                        format: int32
                        title: get_loyalty_stores_corporation_id_offers_required_item_type_id
                        type: integer
                    required:
                    - type_id
                    - quantity
                    title: get_loyalty_stores_corporation_id_offers_required_item
                    type: object
                  maxItems: 100
                  title: get_loyalty_stores_corporation_id_offers_required_items
                  type: array
                type_id:
                  description: type_id integer
                  format: int32
                  title: get_loyalty_stores_corporation_id_offers_type_id
                  type: integer
              required:
              - offer_id
              - type_id
              - quantity
              - lp_cost
              - isk_cost
              - required_items
              title: get_loyalty_stores_corporation_id_offers_200_ok
              type: object
            maxItems: 10000
            title: get_loyalty_stores_corporation_id_offers_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'
        '404':
          description: No loyalty point store found for the provided corporation
          examples:
            application/json:
              error: Not found message
          schema:
            description: Not found
            properties:
              error:
                description: Not found message
                title: get_loyalty_stores_corporation_id_offers_404_not_found
                type: string
            title: get_loyalty_stores_corporation_id_offers_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: List loyalty store offers
      tags:
      - Loyalty
      x-alternate-versions:
      - latest
      - legacy
      - v1
components:
  schemas:
    internal_server_error:
      description: Internal server error model
      properties:
        error:
          description: Internal server error message
          type: string
          example: example
      required:
      - error
      title: Internal server error
      type: object
    forbidden:
      description: Forbidden model
      properties:
        error:
          description: Forbidden message
          type: string
          example: example
        sso_status:
          description: status code received from SSO
          type: integer
          example: 1
      required:
      - error
      title: Forbidden
      type: object
    service_unavailable:
      description: Service unavailable model
      properties:
        error:
          description: Service unavailable message
          type: string
          example: example
      required:
      - error
      title: Service unavailable
      type: object
    bad_request:
      description: Bad request model
      properties:
        error:
          description: Bad request message
          type: string
          example: example
      required:
      - error
      title: Bad request
      type: object
    unauthorized:
      description: Unauthorized model
      properties:
        error:
          description: Unauthorized message
          type: string
          example: example
      required:
      - error
      title: Unauthorized
      type: object
    gateway_timeout:
      description: Gateway timeout model
      properties:
        error:
          description: Gateway timeout message
          type: string
          example: example
        timeout:
          description: number of seconds the request was given
          type: integer
          example: 1
      required:
      - error
      title: Gateway timeout
      type: object
    error_limited:
      description: Error limited model
      properties:
        error:
          description: Error limited message
          type: string
          example: example
      required:
      - error
      title: Error limited
      type: object
  parameters:
    corporation_id:
      description: An EVE corporation ID
      in: path
      name: corporation_id
      required: true
      schema:
        type: integer
        format: int32
        minimum: 1
    datasource:
      description: The server name you would like data from
      in: query
      name: datasource
      schema:
        type: string
        enum:
        - tranquility
        default: tranquility
    character_id:
      description: An EVE character ID
      in: path
      name: character_id
      required: true
      schema:
        type: integer
        format: int32
        minimum: 1
    token:
      description: Access token to use if unable to set a header
      in: query
      name: token
      schema:
        type: string
    If-None-Match:
      description: ETag from a previous request. A 304 will be returned if this matches the current ETag
      in: header
      name: If-None-Match
      schema:
        type: string
  securitySchemes:
    evesso:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.eveonline.com/v2/oauth/authorize
          scopes:
            esi-alliances.read_contacts.v1: EVE SSO scope esi-alliances.read_contacts.v1
            esi-assets.read_assets.v1: EVE SSO scope esi-assets.read_assets.v1
            esi-assets.read_corporation_assets.v1: EVE SSO scope esi-assets.read_corporation_assets.v1
            esi-calendar.read_calendar_events.v1: EVE SSO scope esi-calendar.read_calendar_events.v1
            esi-calendar.respond_calendar_events.v1: EVE SSO scope esi-calendar.respond_calendar_events.v1
            esi-characters.read_agents_research.v1: EVE SSO scope esi-characters.read_agents_research.v1
            esi-characters.read_blueprints.v1: EVE SSO scope esi-characters.read_blueprints.v1
            esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1
            esi-characters.read_corporation_roles.v1: EVE SSO scope esi-characters.read_corporation_roles.v1
            esi-characters.read_fatigue.v1: EVE SSO scope esi-characters.read_fatigue.v1
            esi-characters.read_fw_stats.v1: EVE SSO scope esi-characters.read_fw_stats.v1
            esi-characters.read_loyalty.v1: EVE SSO scope esi-characters.read_loyalty.v1
            esi-characters.read_medals.v1: EVE SSO scope esi-characters.read_medals.v1
            esi-characters.read_notifications.v1: EVE SSO scope esi-characters.read_notifications.v1
            esi-characters.read_standings.v1: EVE SSO scope esi-characters.read_standings.v1
            esi-characters.read_titles.v1: EVE SSO scope esi-characters.read_titles.v1
            esi-characters.write_contacts.v1: EVE SSO scope esi-characters.write_contacts.v1
            esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1
            esi-clones.read_implants.v1: EVE SSO scope esi-clones.read_implants.v1
            esi-contracts.read_character_contracts.v1: EVE SSO scope esi-contracts.read_character_contracts.v1
            esi-contracts.read_corporation_contracts.v1: EVE SSO scope esi-contracts.read_corporation_contracts.v1
            esi-corporations.read_blueprints.v1: EVE SSO scope esi-corporations.read_blueprints.v1
            esi-corporations.read_contacts.v1: EVE SSO scope esi-corporations.read_contacts.v1
            esi-corporations.read_container_logs.v1: EVE SSO scope esi-corporations.read_container_logs.v1
            esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1
            esi-corporations.read_divisions.v1: EVE SSO scope esi-corporations.read_divisions.v1
            esi-corporations.read_facilities.v1: EVE SSO scope esi-corporations.read_facilities.v1
            esi-corporations.read_fw_stats.v1: EVE SSO scope esi-corporations.read_fw_stats.v1
            esi-corporations.read_medals.v1: EVE SSO scope esi-corporations.read_medals.v1
            esi-corporations.read_standings.v1: EVE SSO scope esi-corporations.read_standings.v1
            esi-corporations.read_starbases.v1: EVE SSO scope esi-corporations.read_starbases.v1
            esi-corporations.read_structures.v1: EVE SSO scope esi-corporations.read_structures.v1
            esi-corporations.read_titles.v1: EVE SSO scope esi-corporations.read_titles.v1
            esi-corporations.track_members.v1: EVE SSO scope esi-corporations.track_members.v1
            esi-fittings.read_fittings.v1: EVE SSO scope esi-fittings.read_fittings.v1
            esi-fittings.write_fittings.v1: EVE SSO scope esi-fittings.write_fittings.v1
            esi-fleets.read_fleet.v1: EVE SSO scope esi-fleets.read_fleet.v1
            esi-fleets.write_fleet.v1: EVE SSO scope esi-fleets.write_fleet.v1
            esi-industry.read_character_jobs.v1: EVE SSO scope esi-industry.read_character_jobs.v1
            esi-industry.read_character_mining.v1: EVE SSO scope esi-industry.read_character_mining.v1
            esi-industry.read_corporation_jobs.v1: EVE SSO scope esi-industry.read_corporation_jobs.v1
            esi-industry.read_corporation_mining.v1: EVE SSO scope esi-industry.read_corporation_mining.v1
            esi-killmails.read_corporation_killmails.v1: EVE SSO scope esi-killmails.read_corporation_killmails.v1
            esi-killmails.read_killmails.v1: EVE SSO scope esi-killmails.read_killmails.v1
            esi-location.read_location.v1: EVE SSO scope esi-location.read_location.v1
            esi-location.read_online.v1: EVE SSO scope esi-location.read_online.v1
            esi-location.read_ship_type.v1: EVE SSO scope esi-location.read_ship_type.v1
            esi-mail.organize_mail.v1: EVE SSO scope esi-mail.organize_mail.v1
            esi-mail.read_mail.v1: EVE SSO scope esi-mail.read_mail.v1
            esi-mail.send_mail.v1: EVE SSO scope esi-mail.send_m

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