github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/esi/docs/AllianceApi.md (about) 1 # \AllianceApi 2 3 All URIs are relative to *https://esi.evetech.net* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetAlliances**](AllianceApi.md#GetAlliances) | **Get** /v1/alliances/ | List all alliances 8 [**GetAlliancesAllianceId**](AllianceApi.md#GetAlliancesAllianceId) | **Get** /v3/alliances/{alliance_id}/ | Get alliance information 9 [**GetAlliancesAllianceIdCorporations**](AllianceApi.md#GetAlliancesAllianceIdCorporations) | **Get** /v1/alliances/{alliance_id}/corporations/ | List alliance's corporations 10 [**GetAlliancesAllianceIdIcons**](AllianceApi.md#GetAlliancesAllianceIdIcons) | **Get** /v1/alliances/{alliance_id}/icons/ | Get alliance icon 11 12 13 # **GetAlliances** 14 > []int32 GetAlliances(ctx, optional) 15 List all alliances 16 17 List all active player alliances --- This route is cached for up to 3600 seconds 18 19 ### Required Parameters 20 21 Name | Type | Description | Notes 22 ------------- | ------------- | ------------- | ------------- 23 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 24 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 25 26 ### Optional Parameters 27 Optional parameters are passed through a map[string]interface{}. 28 29 Name | Type | Description | Notes 30 ------------- | ------------- | ------------- | ------------- 31 **datasource** | **string**| The server name you would like data from | [default to tranquility] 32 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 33 34 ### Return type 35 36 **[]int32** 37 38 ### Authorization 39 40 No authorization required 41 42 ### HTTP request headers 43 44 - **Content-Type**: application/json 45 - **Accept**: application/json 46 47 [[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) 48 49 # **GetAlliancesAllianceId** 50 > GetAlliancesAllianceIdOk GetAlliancesAllianceId(ctx, allianceId, optional) 51 Get alliance information 52 53 Public information about an alliance --- This route is cached for up to 3600 seconds 54 55 ### Required Parameters 56 57 Name | Type | Description | Notes 58 ------------- | ------------- | ------------- | ------------- 59 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 60 **allianceId** | **int32**| An EVE alliance ID | 61 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 62 63 ### Optional Parameters 64 Optional parameters are passed through a map[string]interface{}. 65 66 Name | Type | Description | Notes 67 ------------- | ------------- | ------------- | ------------- 68 **allianceId** | **int32**| An EVE alliance ID | 69 **datasource** | **string**| The server name you would like data from | [default to tranquility] 70 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 71 72 ### Return type 73 74 [**GetAlliancesAllianceIdOk**](get_alliances_alliance_id_ok.md) 75 76 ### Authorization 77 78 No authorization required 79 80 ### HTTP request headers 81 82 - **Content-Type**: application/json 83 - **Accept**: application/json 84 85 [[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) 86 87 # **GetAlliancesAllianceIdCorporations** 88 > []int32 GetAlliancesAllianceIdCorporations(ctx, allianceId, optional) 89 List alliance's corporations 90 91 List all current member corporations of an alliance --- This route is cached for up to 3600 seconds 92 93 ### Required Parameters 94 95 Name | Type | Description | Notes 96 ------------- | ------------- | ------------- | ------------- 97 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 98 **allianceId** | **int32**| An EVE alliance ID | 99 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 100 101 ### Optional Parameters 102 Optional parameters are passed through a map[string]interface{}. 103 104 Name | Type | Description | Notes 105 ------------- | ------------- | ------------- | ------------- 106 **allianceId** | **int32**| An EVE alliance ID | 107 **datasource** | **string**| The server name you would like data from | [default to tranquility] 108 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 109 110 ### Return type 111 112 **[]int32** 113 114 ### Authorization 115 116 No authorization required 117 118 ### HTTP request headers 119 120 - **Content-Type**: application/json 121 - **Accept**: application/json 122 123 [[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) 124 125 # **GetAlliancesAllianceIdIcons** 126 > GetAlliancesAllianceIdIconsOk GetAlliancesAllianceIdIcons(ctx, allianceId, optional) 127 Get alliance icon 128 129 Get the icon urls for a alliance --- This route expires daily at 11:05 --- [Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/alliances/{alliance_id}/icons/) 130 131 ### Required Parameters 132 133 Name | Type | Description | Notes 134 ------------- | ------------- | ------------- | ------------- 135 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 136 **allianceId** | **int32**| An EVE alliance ID | 137 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 138 139 ### Optional Parameters 140 Optional parameters are passed through a map[string]interface{}. 141 142 Name | Type | Description | Notes 143 ------------- | ------------- | ------------- | ------------- 144 **allianceId** | **int32**| An EVE alliance ID | 145 **datasource** | **string**| The server name you would like data from | [default to tranquility] 146 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 147 148 ### Return type 149 150 [**GetAlliancesAllianceIdIconsOk**](get_alliances_alliance_id_icons_ok.md) 151 152 ### Authorization 153 154 No authorization required 155 156 ### HTTP request headers 157 158 - **Content-Type**: application/json 159 - **Accept**: application/json 160 161 [[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) 162