eve-esi-client-ts 1.0.1

package/docs/MarketApi.md

@@ -0,0 +1,770 @@
+# MarketApi
+
+All URIs are relative to *https://esi.evetech.net/latest*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCharactersCharacterIdOrders**](#getcharacterscharacteridorders) | **GET** /characters/{character_id}/orders/ | List open orders from a character|
+|[**getCharactersCharacterIdOrdersHistory**](#getcharacterscharacteridordershistory) | **GET** /characters/{character_id}/orders/history/ | List historical orders by a character|
+|[**getCorporationsCorporationIdOrders**](#getcorporationscorporationidorders) | **GET** /corporations/{corporation_id}/orders/ | List open orders from a corporation|
+|[**getCorporationsCorporationIdOrdersHistory**](#getcorporationscorporationidordershistory) | **GET** /corporations/{corporation_id}/orders/history/ | List historical orders from a corporation|
+|[**getMarketsGroups**](#getmarketsgroups) | **GET** /markets/groups/ | Get item groups|
+|[**getMarketsGroupsMarketGroupId**](#getmarketsgroupsmarketgroupid) | **GET** /markets/groups/{market_group_id}/ | Get item group information|
+|[**getMarketsPrices**](#getmarketsprices) | **GET** /markets/prices/ | List market prices|
+|[**getMarketsRegionIdHistory**](#getmarketsregionidhistory) | **GET** /markets/{region_id}/history/ | List historical market statistics in a region|
+|[**getMarketsRegionIdOrders**](#getmarketsregionidorders) | **GET** /markets/{region_id}/orders/ | List orders in a region|
+|[**getMarketsRegionIdTypes**](#getmarketsregionidtypes) | **GET** /markets/{region_id}/types/ | List type IDs relevant to a market|
+|[**getMarketsStructuresStructureId**](#getmarketsstructuresstructureid) | **GET** /markets/structures/{structure_id}/ | List orders in a structure|
+
+# **getCharactersCharacterIdOrders**
+> Array<GetCharactersCharacterIdOrders200Ok> getCharactersCharacterIdOrders()
+
+List open market orders placed by a character  --- Alternate route: `/dev/characters/{character_id}/orders/`  Alternate route: `/v2/characters/{character_id}/orders/`  --- This route is cached for up to 1200 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdOrders(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCharactersCharacterIdOrders200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Open market orders placed by a character |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getCharactersCharacterIdOrdersHistory**
+> Array<GetCharactersCharacterIdOrdersHistory200Ok> getCharactersCharacterIdOrdersHistory()
+
+List cancelled and expired market orders placed by a character up to 90 days in the past.  --- Alternate route: `/dev/characters/{character_id}/orders/history/`  Alternate route: `/legacy/characters/{character_id}/orders/history/`  Alternate route: `/v1/characters/{character_id}/orders/history/`  --- This route is cached for up to 3600 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdOrdersHistory(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    page,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCharactersCharacterIdOrdersHistory200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Expired and cancelled market orders placed by a character |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getCorporationsCorporationIdOrders**
+> Array<GetCorporationsCorporationIdOrders200Ok> getCorporationsCorporationIdOrders()
+
+List open market orders placed on behalf of a corporation  --- Alternate route: `/dev/corporations/{corporation_id}/orders/`  Alternate route: `/legacy/corporations/{corporation_id}/orders/`  Alternate route: `/v2/corporations/{corporation_id}/orders/`  Alternate route: `/v3/corporations/{corporation_id}/orders/`  --- This route is cached for up to 1200 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader 
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let corporationId: number; //An EVE corporation ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCorporationsCorporationIdOrders(
+    corporationId,
+    datasource,
+    ifNoneMatch,
+    page,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **corporationId** | [**number**] | An EVE corporation ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCorporationsCorporationIdOrders200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of open market orders |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getCorporationsCorporationIdOrdersHistory**
+> Array<GetCorporationsCorporationIdOrdersHistory200Ok> getCorporationsCorporationIdOrdersHistory()
+
+List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.  --- Alternate route: `/dev/corporations/{corporation_id}/orders/history/`  Alternate route: `/legacy/corporations/{corporation_id}/orders/history/`  Alternate route: `/v1/corporations/{corporation_id}/orders/history/`  Alternate route: `/v2/corporations/{corporation_id}/orders/history/`  --- This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader 
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let corporationId: number; //An EVE corporation ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCorporationsCorporationIdOrdersHistory(
+    corporationId,
+    datasource,
+    ifNoneMatch,
+    page,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **corporationId** | [**number**] | An EVE corporation ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCorporationsCorporationIdOrdersHistory200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Expired and cancelled market orders placed on behalf of a corporation |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsGroups**
+> Array<number> getMarketsGroups()
+
+Get a list of item groups  --- Alternate route: `/dev/markets/groups/`  Alternate route: `/legacy/markets/groups/`  Alternate route: `/v1/markets/groups/`  --- This route expires daily at 11:05
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMarketsGroups(
+    datasource,
+    ifNoneMatch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<number>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of item group ids |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsGroupsMarketGroupId**
+> GetMarketsGroupsMarketGroupIdOk getMarketsGroupsMarketGroupId()
+
+Get information on an item group  --- Alternate route: `/dev/markets/groups/{market_group_id}/`  Alternate route: `/legacy/markets/groups/{market_group_id}/`  Alternate route: `/v1/markets/groups/{market_group_id}/`  --- This route expires daily at 11:05
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let marketGroupId: number; //An Eve item group ID (default to undefined)
+let acceptLanguage: 'en' | 'en-us' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'; //Language to use in the response (optional) (default to 'en')
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let language: 'en' | 'en-us' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'; //Language to use in the response, takes precedence over Accept-Language (optional) (default to 'en')
+
+const { status, data } = await apiInstance.getMarketsGroupsMarketGroupId(
+    marketGroupId,
+    acceptLanguage,
+    datasource,
+    ifNoneMatch,
+    language
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **marketGroupId** | [**number**] | An Eve item group ID | defaults to undefined|
+| **acceptLanguage** | [**&#39;en&#39; | &#39;en-us&#39; | &#39;de&#39; | &#39;fr&#39; | &#39;ja&#39; | &#39;ru&#39; | &#39;zh&#39; | &#39;ko&#39; | &#39;es&#39;**]**Array<&#39;en&#39; &#124; &#39;en-us&#39; &#124; &#39;de&#39; &#124; &#39;fr&#39; &#124; &#39;ja&#39; &#124; &#39;ru&#39; &#124; &#39;zh&#39; &#124; &#39;ko&#39; &#124; &#39;es&#39;>** | Language to use in the response | (optional) defaults to 'en'|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **language** | [**&#39;en&#39; | &#39;en-us&#39; | &#39;de&#39; | &#39;fr&#39; | &#39;ja&#39; | &#39;ru&#39; | &#39;zh&#39; | &#39;ko&#39; | &#39;es&#39;**]**Array<&#39;en&#39; &#124; &#39;en-us&#39; &#124; &#39;de&#39; &#124; &#39;fr&#39; &#124; &#39;ja&#39; &#124; &#39;ru&#39; &#124; &#39;zh&#39; &#124; &#39;ko&#39; &#124; &#39;es&#39;>** | Language to use in the response, takes precedence over Accept-Language | (optional) defaults to 'en'|
+
+
+### Return type
+
+**GetMarketsGroupsMarketGroupIdOk**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Information about an item group |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * Content-Language - The language used in the response <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**404** | Market group not found |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsPrices**
+> Array<GetMarketsPrices200Ok> getMarketsPrices()
+
+Return a list of prices  --- Alternate route: `/dev/markets/prices/`  Alternate route: `/legacy/markets/prices/`  Alternate route: `/v1/markets/prices/`  --- This route is cached for up to 3600 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMarketsPrices(
+    datasource,
+    ifNoneMatch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetMarketsPrices200Ok>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of prices |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsRegionIdHistory**
+> Array<GetMarketsRegionIdHistory200Ok> getMarketsRegionIdHistory()
+
+Return a list of historical market statistics for the specified type in a region  --- Alternate route: `/dev/markets/{region_id}/history/`  Alternate route: `/legacy/markets/{region_id}/history/`  Alternate route: `/v1/markets/{region_id}/history/`  --- This route expires daily at 11:05
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let regionId: number; //Return statistics in this region (default to undefined)
+let typeId: number; //Return statistics for this type (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMarketsRegionIdHistory(
+    regionId,
+    typeId,
+    datasource,
+    ifNoneMatch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **regionId** | [**number**] | Return statistics in this region | defaults to undefined|
+| **typeId** | [**number**] | Return statistics for this type | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetMarketsRegionIdHistory200Ok>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of historical market statistics |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**404** | Type not found |  -  |
+|**420** | Error limited |  -  |
+|**422** | Not found |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+|**520** | Internal error thrown from the EVE server |  -  |
+
+[[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)
+
+# **getMarketsRegionIdOrders**
+> Array<GetMarketsRegionIdOrders200Ok> getMarketsRegionIdOrders()
+
+Return a list of orders in a region  --- Alternate route: `/dev/markets/{region_id}/orders/`  Alternate route: `/legacy/markets/{region_id}/orders/`  Alternate route: `/v1/markets/{region_id}/orders/`  --- This route is cached for up to 300 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let orderType: 'buy' | 'sell' | 'all'; //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')
+let regionId: number; //Return orders in this region (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+let typeId: number; //Return orders only for this type (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMarketsRegionIdOrders(
+    orderType,
+    regionId,
+    datasource,
+    ifNoneMatch,
+    page,
+    typeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderType** | [**&#39;buy&#39; | &#39;sell&#39; | &#39;all&#39;**]**Array<&#39;buy&#39; &#124; &#39;sell&#39; &#124; &#39;all&#39;>** | Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders | defaults to 'all'|
+| **regionId** | [**number**] | Return orders in this region | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+| **typeId** | [**number**] | Return orders only for this type | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetMarketsRegionIdOrders200Ok>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of orders |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**404** | Not found |  -  |
+|**420** | Error limited |  -  |
+|**422** | Not found |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsRegionIdTypes**
+> Array<number> getMarketsRegionIdTypes()
+
+Return a list of type IDs that have active orders in the region, for efficient market indexing.  --- Alternate route: `/dev/markets/{region_id}/types/`  Alternate route: `/legacy/markets/{region_id}/types/`  Alternate route: `/v1/markets/{region_id}/types/`  --- This route is cached for up to 600 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let regionId: number; //Return statistics in this region (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+
+const { status, data } = await apiInstance.getMarketsRegionIdTypes(
+    regionId,
+    datasource,
+    ifNoneMatch,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **regionId** | [**number**] | Return statistics in this region | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+
+
+### Return type
+
+**Array<number>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of type IDs |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**404** | Not found |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getMarketsStructuresStructureId**
+> Array<GetMarketsStructuresStructureId200Ok> getMarketsStructuresStructureId()
+
+Return all orders in a structure  --- Alternate route: `/dev/markets/structures/{structure_id}/`  Alternate route: `/legacy/markets/structures/{structure_id}/`  Alternate route: `/v1/markets/structures/{structure_id}/`  --- This route is cached for up to 300 seconds
+
+### Example
+
+```typescript
+import {
+    MarketApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MarketApi(configuration);
+
+let structureId: number; //Return orders in this structure (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let page: number; //Which page of results to return (optional) (default to 1)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMarketsStructuresStructureId(
+    structureId,
+    datasource,
+    ifNoneMatch,
+    page,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **structureId** | [**number**] | Return orders in this structure | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **page** | [**number**] | Which page of results to return | (optional) defaults to 1|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetMarketsStructuresStructureId200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of orders |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  * X-Pages - Maximum page number <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+