github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/esi/docs/MarketApi.md (about) 1 # \MarketApi 2 3 All URIs are relative to *https://esi.evetech.net* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetCharactersCharacterIdOrders**](MarketApi.md#GetCharactersCharacterIdOrders) | **Get** /v2/characters/{character_id}/orders/ | List open orders from a character 8 [**GetCharactersCharacterIdOrdersHistory**](MarketApi.md#GetCharactersCharacterIdOrdersHistory) | **Get** /v1/characters/{character_id}/orders/history/ | List historical orders by a character 9 [**GetCorporationsCorporationIdOrders**](MarketApi.md#GetCorporationsCorporationIdOrders) | **Get** /v3/corporations/{corporation_id}/orders/ | List open orders from a corporation 10 [**GetCorporationsCorporationIdOrdersHistory**](MarketApi.md#GetCorporationsCorporationIdOrdersHistory) | **Get** /v2/corporations/{corporation_id}/orders/history/ | List historical orders from a corporation 11 [**GetMarketsGroups**](MarketApi.md#GetMarketsGroups) | **Get** /v1/markets/groups/ | Get item groups 12 [**GetMarketsGroupsMarketGroupId**](MarketApi.md#GetMarketsGroupsMarketGroupId) | **Get** /v1/markets/groups/{market_group_id}/ | Get item group information 13 [**GetMarketsPrices**](MarketApi.md#GetMarketsPrices) | **Get** /v1/markets/prices/ | List market prices 14 [**GetMarketsRegionIdHistory**](MarketApi.md#GetMarketsRegionIdHistory) | **Get** /v1/markets/{region_id}/history/ | List historical market statistics in a region 15 [**GetMarketsRegionIdOrders**](MarketApi.md#GetMarketsRegionIdOrders) | **Get** /v1/markets/{region_id}/orders/ | List orders in a region 16 [**GetMarketsRegionIdTypes**](MarketApi.md#GetMarketsRegionIdTypes) | **Get** /v1/markets/{region_id}/types/ | List type IDs relevant to a market 17 [**GetMarketsStructuresStructureId**](MarketApi.md#GetMarketsStructuresStructureId) | **Get** /v1/markets/structures/{structure_id}/ | List orders in a structure 18 19 20 # **GetCharactersCharacterIdOrders** 21 > []GetCharactersCharacterIdOrders200Ok GetCharactersCharacterIdOrders(ctx, characterId, optional) 22 List open orders from a character 23 24 List open market orders placed by a character --- This route is cached for up to 1200 seconds 25 26 ### Required Parameters 27 28 Name | Type | Description | Notes 29 ------------- | ------------- | ------------- | ------------- 30 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 31 **characterId** | **int32**| An EVE character ID | 32 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 33 34 ### Optional Parameters 35 Optional parameters are passed through a map[string]interface{}. 36 37 Name | Type | Description | Notes 38 ------------- | ------------- | ------------- | ------------- 39 **characterId** | **int32**| An EVE character ID | 40 **datasource** | **string**| The server name you would like data from | [default to tranquility] 41 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 42 **token** | **string**| Access token to use if unable to set a header | 43 44 ### Return type 45 46 [**[]GetCharactersCharacterIdOrders200Ok**](get_characters_character_id_orders_200_ok.md) 47 48 ### Authorization 49 50 [evesso](../README.md#evesso) 51 52 ### HTTP request headers 53 54 - **Content-Type**: application/json 55 - **Accept**: application/json 56 57 [[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) 58 59 # **GetCharactersCharacterIdOrdersHistory** 60 > []GetCharactersCharacterIdOrdersHistory200Ok GetCharactersCharacterIdOrdersHistory(ctx, characterId, optional) 61 List historical orders by a character 62 63 List cancelled and expired market orders placed by a character up to 90 days in the past. --- This route is cached for up to 3600 seconds 64 65 ### Required Parameters 66 67 Name | Type | Description | Notes 68 ------------- | ------------- | ------------- | ------------- 69 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 70 **characterId** | **int32**| An EVE character ID | 71 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 72 73 ### Optional Parameters 74 Optional parameters are passed through a map[string]interface{}. 75 76 Name | Type | Description | Notes 77 ------------- | ------------- | ------------- | ------------- 78 **characterId** | **int32**| An EVE character ID | 79 **datasource** | **string**| The server name you would like data from | [default to tranquility] 80 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 81 **page** | **int32**| Which page of results to return | [default to 1] 82 **token** | **string**| Access token to use if unable to set a header | 83 84 ### Return type 85 86 [**[]GetCharactersCharacterIdOrdersHistory200Ok**](get_characters_character_id_orders_history_200_ok.md) 87 88 ### Authorization 89 90 [evesso](../README.md#evesso) 91 92 ### HTTP request headers 93 94 - **Content-Type**: application/json 95 - **Accept**: application/json 96 97 [[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) 98 99 # **GetCorporationsCorporationIdOrders** 100 > []GetCorporationsCorporationIdOrders200Ok GetCorporationsCorporationIdOrders(ctx, corporationId, optional) 101 List open orders from a corporation 102 103 List open market orders placed on behalf of a corporation --- This route is cached for up to 1200 seconds --- Requires one of the following EVE corporation role(s): Accountant, Trader 104 105 ### Required Parameters 106 107 Name | Type | Description | Notes 108 ------------- | ------------- | ------------- | ------------- 109 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 110 **corporationId** | **int32**| An EVE corporation ID | 111 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 112 113 ### Optional Parameters 114 Optional parameters are passed through a map[string]interface{}. 115 116 Name | Type | Description | Notes 117 ------------- | ------------- | ------------- | ------------- 118 **corporationId** | **int32**| An EVE corporation ID | 119 **datasource** | **string**| The server name you would like data from | [default to tranquility] 120 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 121 **page** | **int32**| Which page of results to return | [default to 1] 122 **token** | **string**| Access token to use if unable to set a header | 123 124 ### Return type 125 126 [**[]GetCorporationsCorporationIdOrders200Ok**](get_corporations_corporation_id_orders_200_ok.md) 127 128 ### Authorization 129 130 [evesso](../README.md#evesso) 131 132 ### HTTP request headers 133 134 - **Content-Type**: application/json 135 - **Accept**: application/json 136 137 [[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) 138 139 # **GetCorporationsCorporationIdOrdersHistory** 140 > []GetCorporationsCorporationIdOrdersHistory200Ok GetCorporationsCorporationIdOrdersHistory(ctx, corporationId, optional) 141 List historical orders from a corporation 142 143 List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past. --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Trader 144 145 ### Required Parameters 146 147 Name | Type | Description | Notes 148 ------------- | ------------- | ------------- | ------------- 149 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 150 **corporationId** | **int32**| An EVE corporation ID | 151 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 152 153 ### Optional Parameters 154 Optional parameters are passed through a map[string]interface{}. 155 156 Name | Type | Description | Notes 157 ------------- | ------------- | ------------- | ------------- 158 **corporationId** | **int32**| An EVE corporation ID | 159 **datasource** | **string**| The server name you would like data from | [default to tranquility] 160 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 161 **page** | **int32**| Which page of results to return | [default to 1] 162 **token** | **string**| Access token to use if unable to set a header | 163 164 ### Return type 165 166 [**[]GetCorporationsCorporationIdOrdersHistory200Ok**](get_corporations_corporation_id_orders_history_200_ok.md) 167 168 ### Authorization 169 170 [evesso](../README.md#evesso) 171 172 ### HTTP request headers 173 174 - **Content-Type**: application/json 175 - **Accept**: application/json 176 177 [[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) 178 179 # **GetMarketsGroups** 180 > []int32 GetMarketsGroups(ctx, optional) 181 Get item groups 182 183 Get a list of item groups --- This route expires daily at 11:05 184 185 ### Required Parameters 186 187 Name | Type | Description | Notes 188 ------------- | ------------- | ------------- | ------------- 189 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 190 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 191 192 ### Optional Parameters 193 Optional parameters are passed through a map[string]interface{}. 194 195 Name | Type | Description | Notes 196 ------------- | ------------- | ------------- | ------------- 197 **datasource** | **string**| The server name you would like data from | [default to tranquility] 198 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 199 200 ### Return type 201 202 **[]int32** 203 204 ### Authorization 205 206 No authorization required 207 208 ### HTTP request headers 209 210 - **Content-Type**: application/json 211 - **Accept**: application/json 212 213 [[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) 214 215 # **GetMarketsGroupsMarketGroupId** 216 > GetMarketsGroupsMarketGroupIdOk GetMarketsGroupsMarketGroupId(ctx, marketGroupId, optional) 217 Get item group information 218 219 Get information on an item group --- This route expires daily at 11:05 220 221 ### Required Parameters 222 223 Name | Type | Description | Notes 224 ------------- | ------------- | ------------- | ------------- 225 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 226 **marketGroupId** | **int32**| An Eve item group ID | 227 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 228 229 ### Optional Parameters 230 Optional parameters are passed through a map[string]interface{}. 231 232 Name | Type | Description | Notes 233 ------------- | ------------- | ------------- | ------------- 234 **marketGroupId** | **int32**| An Eve item group ID | 235 **acceptLanguage** | **string**| Language to use in the response | [default to en] 236 **datasource** | **string**| The server name you would like data from | [default to tranquility] 237 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 238 **language** | **string**| Language to use in the response, takes precedence over Accept-Language | [default to en] 239 240 ### Return type 241 242 [**GetMarketsGroupsMarketGroupIdOk**](get_markets_groups_market_group_id_ok.md) 243 244 ### Authorization 245 246 No authorization required 247 248 ### HTTP request headers 249 250 - **Content-Type**: application/json 251 - **Accept**: application/json 252 253 [[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) 254 255 # **GetMarketsPrices** 256 > []GetMarketsPrices200Ok GetMarketsPrices(ctx, optional) 257 List market prices 258 259 Return a list of prices --- This route is cached for up to 3600 seconds 260 261 ### Required Parameters 262 263 Name | Type | Description | Notes 264 ------------- | ------------- | ------------- | ------------- 265 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 266 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 267 268 ### Optional Parameters 269 Optional parameters are passed through a map[string]interface{}. 270 271 Name | Type | Description | Notes 272 ------------- | ------------- | ------------- | ------------- 273 **datasource** | **string**| The server name you would like data from | [default to tranquility] 274 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 275 276 ### Return type 277 278 [**[]GetMarketsPrices200Ok**](get_markets_prices_200_ok.md) 279 280 ### Authorization 281 282 No authorization required 283 284 ### HTTP request headers 285 286 - **Content-Type**: application/json 287 - **Accept**: application/json 288 289 [[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) 290 291 # **GetMarketsRegionIdHistory** 292 > []GetMarketsRegionIdHistory200Ok GetMarketsRegionIdHistory(ctx, regionId, typeId, optional) 293 List historical market statistics in a region 294 295 Return a list of historical market statistics for the specified type in a region --- This route expires daily at 11:05 296 297 ### Required Parameters 298 299 Name | Type | Description | Notes 300 ------------- | ------------- | ------------- | ------------- 301 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 302 **regionId** | **int32**| Return statistics in this region | 303 **typeId** | **int32**| Return statistics for this type | 304 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 305 306 ### Optional Parameters 307 Optional parameters are passed through a map[string]interface{}. 308 309 Name | Type | Description | Notes 310 ------------- | ------------- | ------------- | ------------- 311 **regionId** | **int32**| Return statistics in this region | 312 **typeId** | **int32**| Return statistics for this type | 313 **datasource** | **string**| The server name you would like data from | [default to tranquility] 314 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 315 316 ### Return type 317 318 [**[]GetMarketsRegionIdHistory200Ok**](get_markets_region_id_history_200_ok.md) 319 320 ### Authorization 321 322 No authorization required 323 324 ### HTTP request headers 325 326 - **Content-Type**: application/json 327 - **Accept**: application/json 328 329 [[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) 330 331 # **GetMarketsRegionIdOrders** 332 > []GetMarketsRegionIdOrders200Ok GetMarketsRegionIdOrders(ctx, orderType, regionId, optional) 333 List orders in a region 334 335 Return a list of orders in a region --- This route is cached for up to 300 seconds 336 337 ### Required Parameters 338 339 Name | Type | Description | Notes 340 ------------- | ------------- | ------------- | ------------- 341 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 342 **orderType** | **string**| Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders | [default to all] 343 **regionId** | **int32**| Return orders in this region | 344 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 345 346 ### Optional Parameters 347 Optional parameters are passed through a map[string]interface{}. 348 349 Name | Type | Description | Notes 350 ------------- | ------------- | ------------- | ------------- 351 **orderType** | **string**| Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders | [default to all] 352 **regionId** | **int32**| Return orders in this region | 353 **datasource** | **string**| The server name you would like data from | [default to tranquility] 354 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 355 **page** | **int32**| Which page of results to return | [default to 1] 356 **typeId** | **int32**| Return orders only for this type | 357 358 ### Return type 359 360 [**[]GetMarketsRegionIdOrders200Ok**](get_markets_region_id_orders_200_ok.md) 361 362 ### Authorization 363 364 No authorization required 365 366 ### HTTP request headers 367 368 - **Content-Type**: application/json 369 - **Accept**: application/json 370 371 [[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) 372 373 # **GetMarketsRegionIdTypes** 374 > []int32 GetMarketsRegionIdTypes(ctx, regionId, optional) 375 List type IDs relevant to a market 376 377 Return a list of type IDs that have active orders in the region, for efficient market indexing. --- This route is cached for up to 600 seconds 378 379 ### Required Parameters 380 381 Name | Type | Description | Notes 382 ------------- | ------------- | ------------- | ------------- 383 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 384 **regionId** | **int32**| Return statistics in this region | 385 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 386 387 ### Optional Parameters 388 Optional parameters are passed through a map[string]interface{}. 389 390 Name | Type | Description | Notes 391 ------------- | ------------- | ------------- | ------------- 392 **regionId** | **int32**| Return statistics in this region | 393 **datasource** | **string**| The server name you would like data from | [default to tranquility] 394 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 395 **page** | **int32**| Which page of results to return | [default to 1] 396 397 ### Return type 398 399 **[]int32** 400 401 ### Authorization 402 403 No authorization required 404 405 ### HTTP request headers 406 407 - **Content-Type**: application/json 408 - **Accept**: application/json 409 410 [[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) 411 412 # **GetMarketsStructuresStructureId** 413 > []GetMarketsStructuresStructureId200Ok GetMarketsStructuresStructureId(ctx, structureId, optional) 414 List orders in a structure 415 416 Return all orders in a structure --- This route is cached for up to 300 seconds 417 418 ### Required Parameters 419 420 Name | Type | Description | Notes 421 ------------- | ------------- | ------------- | ------------- 422 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 423 **structureId** | **int64**| Return orders in this structure | 424 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 425 426 ### Optional Parameters 427 Optional parameters are passed through a map[string]interface{}. 428 429 Name | Type | Description | Notes 430 ------------- | ------------- | ------------- | ------------- 431 **structureId** | **int64**| Return orders in this structure | 432 **datasource** | **string**| The server name you would like data from | [default to tranquility] 433 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 434 **page** | **int32**| Which page of results to return | [default to 1] 435 **token** | **string**| Access token to use if unable to set a header | 436 437 ### Return type 438 439 [**[]GetMarketsStructuresStructureId200Ok**](get_markets_structures_structure_id_200_ok.md) 440 441 ### Authorization 442 443 [evesso](../README.md#evesso) 444 445 ### HTTP request headers 446 447 - **Content-Type**: application/json 448 - **Accept**: application/json 449 450 [[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) 451