github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/esi/docs/FactionWarfareApi.md (about) 1 # \FactionWarfareApi 2 3 All URIs are relative to *https://esi.evetech.net* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetCharactersCharacterIdFwStats**](FactionWarfareApi.md#GetCharactersCharacterIdFwStats) | **Get** /v1/characters/{character_id}/fw/stats/ | Overview of a character involved in faction warfare 8 [**GetCorporationsCorporationIdFwStats**](FactionWarfareApi.md#GetCorporationsCorporationIdFwStats) | **Get** /v1/corporations/{corporation_id}/fw/stats/ | Overview of a corporation involved in faction warfare 9 [**GetFwLeaderboards**](FactionWarfareApi.md#GetFwLeaderboards) | **Get** /v1/fw/leaderboards/ | List of the top factions in faction warfare 10 [**GetFwLeaderboardsCharacters**](FactionWarfareApi.md#GetFwLeaderboardsCharacters) | **Get** /v1/fw/leaderboards/characters/ | List of the top pilots in faction warfare 11 [**GetFwLeaderboardsCorporations**](FactionWarfareApi.md#GetFwLeaderboardsCorporations) | **Get** /v1/fw/leaderboards/corporations/ | List of the top corporations in faction warfare 12 [**GetFwStats**](FactionWarfareApi.md#GetFwStats) | **Get** /v1/fw/stats/ | An overview of statistics about factions involved in faction warfare 13 [**GetFwSystems**](FactionWarfareApi.md#GetFwSystems) | **Get** /v2/fw/systems/ | Ownership of faction warfare systems 14 [**GetFwWars**](FactionWarfareApi.md#GetFwWars) | **Get** /v1/fw/wars/ | Data about which NPC factions are at war 15 16 17 # **GetCharactersCharacterIdFwStats** 18 > GetCharactersCharacterIdFwStatsOk GetCharactersCharacterIdFwStats(ctx, characterId, optional) 19 Overview of a character involved in faction warfare 20 21 Statistical overview of a character involved in faction warfare --- This route expires daily at 11:05 22 23 ### Required Parameters 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 28 **characterId** | **int32**| An EVE character ID | 29 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 30 31 ### Optional Parameters 32 Optional parameters are passed through a map[string]interface{}. 33 34 Name | Type | Description | Notes 35 ------------- | ------------- | ------------- | ------------- 36 **characterId** | **int32**| An EVE character ID | 37 **datasource** | **string**| The server name you would like data from | [default to tranquility] 38 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 39 **token** | **string**| Access token to use if unable to set a header | 40 41 ### Return type 42 43 [**GetCharactersCharacterIdFwStatsOk**](get_characters_character_id_fw_stats_ok.md) 44 45 ### Authorization 46 47 [evesso](../README.md#evesso) 48 49 ### HTTP request headers 50 51 - **Content-Type**: application/json 52 - **Accept**: application/json 53 54 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 55 56 # **GetCorporationsCorporationIdFwStats** 57 > GetCorporationsCorporationIdFwStatsOk GetCorporationsCorporationIdFwStats(ctx, corporationId, optional) 58 Overview of a corporation involved in faction warfare 59 60 Statistics about a corporation involved in faction warfare --- This route expires daily at 11:05 61 62 ### Required Parameters 63 64 Name | Type | Description | Notes 65 ------------- | ------------- | ------------- | ------------- 66 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 67 **corporationId** | **int32**| An EVE corporation ID | 68 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 69 70 ### Optional Parameters 71 Optional parameters are passed through a map[string]interface{}. 72 73 Name | Type | Description | Notes 74 ------------- | ------------- | ------------- | ------------- 75 **corporationId** | **int32**| An EVE corporation ID | 76 **datasource** | **string**| The server name you would like data from | [default to tranquility] 77 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 78 **token** | **string**| Access token to use if unable to set a header | 79 80 ### Return type 81 82 [**GetCorporationsCorporationIdFwStatsOk**](get_corporations_corporation_id_fw_stats_ok.md) 83 84 ### Authorization 85 86 [evesso](../README.md#evesso) 87 88 ### HTTP request headers 89 90 - **Content-Type**: application/json 91 - **Accept**: application/json 92 93 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 94 95 # **GetFwLeaderboards** 96 > GetFwLeaderboardsOk GetFwLeaderboards(ctx, optional) 97 List of the top factions in faction warfare 98 99 Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday --- This route expires daily at 11:05 100 101 ### Required Parameters 102 103 Name | Type | Description | Notes 104 ------------- | ------------- | ------------- | ------------- 105 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 106 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 107 108 ### Optional Parameters 109 Optional parameters are passed through a map[string]interface{}. 110 111 Name | Type | Description | Notes 112 ------------- | ------------- | ------------- | ------------- 113 **datasource** | **string**| The server name you would like data from | [default to tranquility] 114 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 115 116 ### Return type 117 118 [**GetFwLeaderboardsOk**](get_fw_leaderboards_ok.md) 119 120 ### Authorization 121 122 No authorization required 123 124 ### HTTP request headers 125 126 - **Content-Type**: application/json 127 - **Accept**: application/json 128 129 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 130 131 # **GetFwLeaderboardsCharacters** 132 > GetFwLeaderboardsCharactersOk GetFwLeaderboardsCharacters(ctx, optional) 133 List of the top pilots in faction warfare 134 135 Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday --- This route expires daily at 11:05 136 137 ### Required Parameters 138 139 Name | Type | Description | Notes 140 ------------- | ------------- | ------------- | ------------- 141 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 142 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 143 144 ### Optional Parameters 145 Optional parameters are passed through a map[string]interface{}. 146 147 Name | Type | Description | Notes 148 ------------- | ------------- | ------------- | ------------- 149 **datasource** | **string**| The server name you would like data from | [default to tranquility] 150 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 151 152 ### Return type 153 154 [**GetFwLeaderboardsCharactersOk**](get_fw_leaderboards_characters_ok.md) 155 156 ### Authorization 157 158 No authorization required 159 160 ### HTTP request headers 161 162 - **Content-Type**: application/json 163 - **Accept**: application/json 164 165 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 166 167 # **GetFwLeaderboardsCorporations** 168 > GetFwLeaderboardsCorporationsOk GetFwLeaderboardsCorporations(ctx, optional) 169 List of the top corporations in faction warfare 170 171 Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday --- This route expires daily at 11:05 172 173 ### Required Parameters 174 175 Name | Type | Description | Notes 176 ------------- | ------------- | ------------- | ------------- 177 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 178 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 179 180 ### Optional Parameters 181 Optional parameters are passed through a map[string]interface{}. 182 183 Name | Type | Description | Notes 184 ------------- | ------------- | ------------- | ------------- 185 **datasource** | **string**| The server name you would like data from | [default to tranquility] 186 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 187 188 ### Return type 189 190 [**GetFwLeaderboardsCorporationsOk**](get_fw_leaderboards_corporations_ok.md) 191 192 ### Authorization 193 194 No authorization required 195 196 ### HTTP request headers 197 198 - **Content-Type**: application/json 199 - **Accept**: application/json 200 201 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 202 203 # **GetFwStats** 204 > []GetFwStats200Ok GetFwStats(ctx, optional) 205 An overview of statistics about factions involved in faction warfare 206 207 Statistical overviews of factions involved in faction warfare --- This route expires daily at 11:05 208 209 ### Required Parameters 210 211 Name | Type | Description | Notes 212 ------------- | ------------- | ------------- | ------------- 213 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 214 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 215 216 ### Optional Parameters 217 Optional parameters are passed through a map[string]interface{}. 218 219 Name | Type | Description | Notes 220 ------------- | ------------- | ------------- | ------------- 221 **datasource** | **string**| The server name you would like data from | [default to tranquility] 222 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 223 224 ### Return type 225 226 [**[]GetFwStats200Ok**](get_fw_stats_200_ok.md) 227 228 ### Authorization 229 230 No authorization required 231 232 ### HTTP request headers 233 234 - **Content-Type**: application/json 235 - **Accept**: application/json 236 237 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 238 239 # **GetFwSystems** 240 > []GetFwSystems200Ok GetFwSystems(ctx, optional) 241 Ownership of faction warfare systems 242 243 An overview of the current ownership of faction warfare solar systems --- This route is cached for up to 1800 seconds 244 245 ### Required Parameters 246 247 Name | Type | Description | Notes 248 ------------- | ------------- | ------------- | ------------- 249 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 250 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 251 252 ### Optional Parameters 253 Optional parameters are passed through a map[string]interface{}. 254 255 Name | Type | Description | Notes 256 ------------- | ------------- | ------------- | ------------- 257 **datasource** | **string**| The server name you would like data from | [default to tranquility] 258 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 259 260 ### Return type 261 262 [**[]GetFwSystems200Ok**](get_fw_systems_200_ok.md) 263 264 ### Authorization 265 266 No authorization required 267 268 ### HTTP request headers 269 270 - **Content-Type**: application/json 271 - **Accept**: application/json 272 273 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 274 275 # **GetFwWars** 276 > []GetFwWars200Ok GetFwWars(ctx, optional) 277 Data about which NPC factions are at war 278 279 Data about which NPC factions are at war --- This route expires daily at 11:05 280 281 ### Required Parameters 282 283 Name | Type | Description | Notes 284 ------------- | ------------- | ------------- | ------------- 285 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 286 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 287 288 ### Optional Parameters 289 Optional parameters are passed through a map[string]interface{}. 290 291 Name | Type | Description | Notes 292 ------------- | ------------- | ------------- | ------------- 293 **datasource** | **string**| The server name you would like data from | [default to tranquility] 294 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 295 296 ### Return type 297 298 [**[]GetFwWars200Ok**](get_fw_wars_200_ok.md) 299 300 ### Authorization 301 302 No authorization required 303 304 ### HTTP request headers 305 306 - **Content-Type**: application/json 307 - **Accept**: application/json 308 309 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 310