EveSwaggerInterface.MarketApi

All URIs are relative to https://esi.evetech.net/latest

Method	HTTP request	Description
getCharactersCharacterIdOrders	GET /characters/{character_id}/orders/	List open orders from a character
getCharactersCharacterIdOrdersHistory	GET /characters/{character_id}/orders/history/	List historical orders by a character
getCorporationsCorporationIdOrders	GET /corporations/{corporation_id}/orders/	List open orders from a corporation
getCorporationsCorporationIdOrdersHistory	GET /corporations/{corporation_id}/orders/history/	List historical orders from a corporation
getMarketsGroups	GET /markets/groups/	Get item groups
getMarketsGroupsMarketGroupId	GET /markets/groups/{market_group_id}/	Get item group information
getMarketsPrices	GET /markets/prices/	List market prices
getMarketsRegionIdHistory	GET /markets/{region_id}/history/	List historical market statistics in a region
getMarketsRegionIdOrders	GET /markets/{region_id}/orders/	List orders in a region
getMarketsRegionIdTypes	GET /markets/{region_id}/types/	List type IDs relevant to a market
getMarketsStructuresStructureId	GET /markets/structures/{structure_id}/	List orders in a structure

getCharactersCharacterIdOrders

[GetCharactersCharacterIdOrders200Ok] getCharactersCharacterIdOrders(characterId, opts)

List open orders from a character

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MarketApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdOrders(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCharactersCharacterIdOrders200Ok]

Authorization

evesso

HTTP request headers

Content-Type: application/json
Accept: application/json

getCharactersCharacterIdOrdersHistory

[GetCharactersCharacterIdOrdersHistory200Ok] getCharactersCharacterIdOrdersHistory(characterId, opts)

List historical orders by a character

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MarketApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdOrdersHistory(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCharactersCharacterIdOrdersHistory200Ok]

Authorization

evesso

HTTP request headers

Content-Type: application/json
Accept: application/json

getCorporationsCorporationIdOrders

[GetCorporationsCorporationIdOrders200Ok] getCorporationsCorporationIdOrders(corporationId, opts)

List open orders from a corporation

List open market orders placed on behalf of a corporation --- Alternate route: /dev/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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MarketApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdOrders(corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
corporationId	Number	An EVE corporation ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCorporationsCorporationIdOrders200Ok]

Authorization

evesso

HTTP request headers

Content-Type: application/json
Accept: application/json

getCorporationsCorporationIdOrdersHistory

[GetCorporationsCorporationIdOrdersHistory200Ok] getCorporationsCorporationIdOrdersHistory(corporationId, opts)

List historical orders from a corporation

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: /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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MarketApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdOrdersHistory(corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
corporationId	Number	An EVE corporation ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCorporationsCorporationIdOrdersHistory200Ok]

Authorization

evesso

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsGroups

['Number'] getMarketsGroups(opts)

Get item groups

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsGroups(opts, callback);

Parameters

Name	Type	Description	Notes
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]

Return type

['Number']

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsGroupsMarketGroupId

GetMarketsGroupsMarketGroupIdOk getMarketsGroupsMarketGroupId(marketGroupId, opts)

Get item group information

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var marketGroupId = 56; // Number | An Eve item group ID

var opts = { 
  'acceptLanguage': "en", // String | Language to use in the response
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'language': "en" // String | Language to use in the response, takes precedence over Accept-Language
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsGroupsMarketGroupId(marketGroupId, opts, callback);

Parameters

Name	Type	Description	Notes
marketGroupId	Number	An Eve item group ID
acceptLanguage	String	Language to use in the response	[optional] [default to en]
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
language	String	Language to use in the response, takes precedence over Accept-Language	[optional] [default to en]

Return type

GetMarketsGroupsMarketGroupIdOk

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsPrices

[GetMarketsPrices200Ok] getMarketsPrices(opts)

List market prices

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsPrices(opts, callback);

Parameters

Name	Type	Description	Notes
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]

Return type

[GetMarketsPrices200Ok]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsRegionIdHistory

[GetMarketsRegionIdHistory200Ok] getMarketsRegionIdHistory(regionId, typeId, opts)

List historical market statistics in a region

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var regionId = 56; // Number | Return statistics in this region

var typeId = 56; // Number | Return statistics for this type

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsRegionIdHistory(regionId, typeId, opts, callback);

Parameters

Name	Type	Description	Notes
regionId	Number	Return statistics in this region
typeId	Number	Return statistics for this type
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]

Return type

[GetMarketsRegionIdHistory200Ok]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsRegionIdOrders

[GetMarketsRegionIdOrders200Ok] getMarketsRegionIdOrders(orderType, regionId, opts)

List orders in a region

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var orderType = "all"; // String | Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders

var regionId = 56; // Number | Return orders in this region

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'typeId': 56 // Number | Return orders only for this type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsRegionIdOrders(orderType, regionId, opts, callback);

Parameters

Name	Type	Description	Notes
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]
regionId	Number	Return orders in this region
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]
typeId	Number	Return orders only for this type	[optional]

Return type

[GetMarketsRegionIdOrders200Ok]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsRegionIdTypes

['Number'] getMarketsRegionIdTypes(regionId, opts)

List type IDs relevant to a market

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.MarketApi();

var regionId = 56; // Number | Return statistics in this region

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsRegionIdTypes(regionId, opts, callback);

Parameters

Name	Type	Description	Notes
regionId	Number	Return statistics in this region
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]

Return type

['Number']

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getMarketsStructuresStructureId

[GetMarketsStructuresStructureId200Ok] getMarketsStructuresStructureId(structureId, opts)

List orders in a structure

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MarketApi();

var structureId = 789; // Number | Return orders in this structure

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMarketsStructuresStructureId(structureId, opts, callback);

Parameters

Name	Type	Description	Notes
structureId	Number	Return orders in this structure
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetMarketsStructuresStructureId200Ok]

Authorization

evesso

HTTP request headers

Content-Type: application/json
Accept: application/json

FilesExpand file tree

MarketApi.md

Latest commit

History

MarketApi.md

File metadata and controls

EveSwaggerInterface.MarketApi

getCharactersCharacterIdOrders

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdOrdersHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdOrders

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdOrdersHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsGroups

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsGroupsMarketGroupId

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsPrices

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsRegionIdHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsRegionIdOrders

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsRegionIdTypes

Example

Parameters

Return type

Authorization

HTTP request headers

getMarketsStructuresStructureId

Example

Parameters

Return type

Authorization

HTTP request headers