CCP Games Faction Warfare API
The Faction Warfare API from CCP Games — 8 operation(s) for faction warfare.
The Faction Warfare API from CCP Games — 8 operation(s) for faction warfare.
openapi: 3.1.0
info:
contact:
name: ESI Support
url: https://developers.eveonline.com/docs/support/
license:
name: EVE Developer License
url: https://developers.eveonline.com/license-agreement
termsOfService: https://support.eveonline.com/hc/en-us/articles/8414770561948-EVE-Online-Terms-of-Service
title: EVE Swagger Incineration (ESI) - tranquility Alliance Faction Warfare API
version: '2020-01-01'
servers:
- url: https://esi.evetech.net
tags:
- name: Faction Warfare
paths:
/characters/{character_id}/fw/stats:
get:
description: 'Statistical overview of a character involved in faction warfare
This route expires daily at 11:05'
operationId: GetCharactersCharacterIdFwStats
parameters:
- description: The ID of the character
in: path
name: character_id
required: true
schema:
$ref: '#/components/schemas/CharacterID'
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CharactersCharacterIdFwStatsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
security:
- OAuth2:
- esi-characters.read_fw_stats.v1
summary: Overview of a character involved in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/corporations/{corporation_id}/fw/stats:
get:
description: 'Statistics about a corporation involved in faction warfare
This route expires daily at 11:05'
operationId: GetCorporationsCorporationIdFwStats
parameters:
- description: The ID of the corporation
in: path
name: corporation_id
required: true
schema:
$ref: '#/components/schemas/CorporationID'
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CorporationsCorporationIdFwStatsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
security:
- OAuth2:
- esi-corporations.read_fw_stats.v1
summary: Overview of a corporation involved in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/leaderboards:
get:
description: 'Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday
This route expires daily at 11:05'
operationId: GetFwLeaderboards
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwLeaderboardsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: List of the top factions in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/leaderboards/characters:
get:
description: 'Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday
This route expires daily at 11:05'
operationId: GetFwLeaderboardsCharacters
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwLeaderboardsCharactersGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: List of the top pilots in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/leaderboards/corporations:
get:
description: 'Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday
This route expires daily at 11:05'
operationId: GetFwLeaderboardsCorporations
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwLeaderboardsCorporationsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: List of the top corporations in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/stats:
get:
description: 'Statistical overviews of factions involved in faction warfare
This route expires daily at 11:05'
operationId: GetFwStats
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwStatsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: An overview of statistics about factions involved in faction warfare
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/systems:
get:
description: An overview of the current ownership of faction warfare solar systems
operationId: GetFwSystems
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwSystemsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: Ownership of faction warfare systems
tags:
- Faction Warfare
x-cache-age: 1800
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
/fw/wars:
get:
description: 'Data about which NPC factions are at war
This route expires daily at 11:05'
operationId: GetFwWars
parameters:
- $ref: '#/components/parameters/AcceptLanguage'
- $ref: '#/components/parameters/IfNoneMatch'
- $ref: '#/components/parameters/CompatibilityDate'
- $ref: '#/components/parameters/Tenant'
- $ref: '#/components/parameters/IfModifiedSince'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FwWarsGet'
description: OK
headers:
Cache-Control:
$ref: '#/components/headers/CacheControl'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error
summary: Data about which NPC factions are at war
tags:
- Faction Warfare
x-compatibility-date: '2020-01-01'
x-rate-limit:
group: factional-warfare
max-tokens: 150
window-size: 15m
components:
schemas:
FwStatsGet:
items:
properties:
faction_id:
format: int64
type: integer
kills:
description: Summary of kills against an enemy faction for the given faction
properties:
last_week:
description: Last week's total number of kills against enemy factions
format: int64
type: integer
total:
description: Total number of kills against enemy factions since faction warfare began
format: int64
type: integer
yesterday:
description: Yesterday's total number of kills against enemy factions
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
pilots:
description: How many pilots fight for the given faction
format: int64
type: integer
systems_controlled:
description: The number of solar systems controlled by the given faction
format: int64
type: integer
victory_points:
description: Summary of victory points gained for the given faction
properties:
last_week:
description: Last week's victory points gained
format: int64
type: integer
total:
description: Total victory points gained since faction warfare began
format: int64
type: integer
yesterday:
description: Yesterday's victory points gained
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
required:
- faction_id
- pilots
- systems_controlled
- kills
- victory_points
type: object
type: array
FwWarsGet:
description: List of factions at war
items:
properties:
against_id:
description: The faction ID of the enemy faction.
format: int64
type: integer
faction_id:
format: int64
type: integer
required:
- faction_id
- against_id
type: object
type: array
ErrorDetail:
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
Error:
properties:
details:
description: List of individual error details.
items:
$ref: '#/components/schemas/ErrorDetail'
type: array
error:
description: Error message.
type: string
required:
- error
type: object
CharacterID:
examples:
- 90000001
format: int64
type: integer
x-common-model: 'true'
CorporationsCorporationIdFwStatsGet:
properties:
enlisted_on:
description: The enlistment date of the given corporation into faction warfare. Will not be included if corporation is not enlisted in faction warfare
format: date-time
type: string
faction_id:
description: The faction the given corporation is enlisted to fight for. Will not be included if corporation is not enlisted in faction warfare
format: int64
type: integer
kills:
description: Summary of kills done by the given corporation against enemy factions
properties:
last_week:
description: Last week's total number of kills by members of the given corporation against enemy factions
format: int64
type: integer
total:
description: Total number of kills by members of the given corporation against enemy factions since the corporation enlisted
format: int64
type: integer
yesterday:
description: Yesterday's total number of kills by members of the given corporation against enemy factions
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
pilots:
description: How many pilots the enlisted corporation has. Will not be included if corporation is not enlisted in faction warfare
format: int64
type: integer
victory_points:
description: Summary of victory points gained by the given corporation for the enlisted faction
properties:
last_week:
description: Last week's victory points gained by members of the given corporation
format: int64
type: integer
total:
description: Total victory points gained since the given corporation enlisted
format: int64
type: integer
yesterday:
description: Yesterday's victory points gained by members of the given corporation
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
required:
- kills
- victory_points
type: object
FwLeaderboardsCorporationsGet:
properties:
kills:
description: Top 10 rankings of corporations by number of kills from yesterday, last week and in total
properties:
active_total:
description: Top 10 ranking of corporations active in faction warfare by total kills. A corporation is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of kills
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 10 ranking of corporations by kills in the past week
items:
description: last_week object
properties:
amount:
description: Amount of kills
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 10 ranking of corporations by kills in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of kills
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
victory_points:
description: Top 10 rankings of corporations by victory points from yesterday, last week and in total
properties:
active_total:
description: Top 10 ranking of corporations active in faction warfare by total victory points. A corporation is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 10 ranking of corporations by victory points in the past week
items:
description: last_week object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 10 ranking of corporations by victory points in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
corporation_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
required:
- kills
- victory_points
type: object
FwLeaderboardsCharactersGet:
properties:
kills:
description: Top 100 rankings of pilots by number of kills from yesterday, last week and in total
properties:
active_total:
description: Top 100 ranking of pilots active in faction warfare by total kills. A pilot is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of kills
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 100 ranking of pilots by kills in the past week
items:
description: last_week object
properties:
amount:
description: Amount of kills
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 100 ranking of pilots by kills in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of kills
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
victory_points:
description: Top 100 rankings of pilots by victory points from yesterday, last week and in total
properties:
active_total:
description: Top 100 ranking of pilots active in faction warfare by total victory points. A pilot is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 100 ranking of pilots by victory points in the past week
items:
description: last_week object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 100 ranking of pilots by victory points in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
character_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
required:
- kills
- victory_points
type: object
CorporationID:
examples:
- 98777771
format: int64
type: integer
x-common-model: 'true'
CharactersCharacterIdFwStatsGet:
properties:
current_rank:
description: The given character's current faction rank
format: int64
type: integer
enlisted_on:
description: The enlistment date of the given character into faction warfare. Will not be included if character is not enlisted in faction warfare
format: date-time
type: string
faction_id:
description: The faction the given character is enlisted to fight for. Will not be included if character is not enlisted in faction warfare
format: int64
type: integer
highest_rank:
description: The given character's highest faction rank achieved
format: int64
type: integer
kills:
description: Summary of kills done by the given character against enemy factions
properties:
last_week:
description: Last week's total number of kills by a given character against enemy factions
format: int64
type: integer
total:
description: Total number of kills by a given character against enemy factions since the character enlisted
format: int64
type: integer
yesterday:
description: Yesterday's total number of kills by a given character against enemy factions
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
victory_points:
description: Summary of victory points gained by the given character for the enlisted faction
properties:
last_week:
description: Last week's victory points gained by the given character
format: int64
type: integer
total:
description: Total victory points gained since the given character enlisted
format: int64
type: integer
yesterday:
description: Yesterday's victory points gained by the given character
format: int64
type: integer
required:
- yesterday
- last_week
- total
type: object
required:
- kills
- victory_points
type: object
FwSystemsGet:
items:
properties:
contested:
enum:
- captured
- contested
- uncontested
- vulnerable
type: string
occupier_faction_id:
format: int64
type: integer
owner_faction_id:
format: int64
type: integer
solar_system_id:
format: int64
type: integer
victory_points:
format: int64
type: integer
victory_points_threshold:
format: int64
type: integer
required:
- solar_system_id
- occupier_faction_id
- owner_faction_id
- victory_points
- victory_points_threshold
- contested
type: object
type: array
FwLeaderboardsGet:
properties:
kills:
description: Top 4 rankings of factions by number of kills from yesterday, last week and in total
properties:
active_total:
description: Top 4 ranking of factions active in faction warfare by total kills. A faction is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of kills
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 4 ranking of factions by kills in the past week
items:
description: last_week object
properties:
amount:
description: Amount of kills
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 4 ranking of factions by kills in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of kills
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
victory_points:
description: Top 4 rankings of factions by victory points from yesterday, last week and in total
properties:
active_total:
description: Top 4 ranking of factions active in faction warfare by total victory points. A faction is considered "active" if they have participated in faction warfare in the past 14 days
items:
description: active_total object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
last_week:
description: Top 4 ranking of factions by victory points in the past week
items:
description: last_week object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
yesterday:
description: Top 4 ranking of factions by victory points in the past day
items:
description: yesterday object
properties:
amount:
description: Amount of victory points
format: int64
type: integer
faction_id:
format: int64
type: integer
type: object
type: array
required:
- yesterday
- last_week
- active_total
type: object
required:
- kills
- victory_points
type: object
parameters:
IfNoneMatch:
description: The ETag of the previous requ
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ccp-games/refs/heads/main/openapi/ccp-games-faction-warfare-api-openapi.yml