esi v0.1.1 ESI.API.Market
Summary
Types
Options for Market.group_market_group/2
Options for Market.history/2
Options for Market.orders/2
Options for Market.structure/2
Options for Market.types/2
Functions
Get information on an item group
Get a list of item groups
Return a list of historical market statistics for the specified type in a region
Return a list of orders in a region
Return a list of prices
Return all orders in a structure
Return a list of type IDs that have active orders in the region, for efficient market indexing
Types
group_market_group_opt() :: {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh}
Options for Market.group_market_group/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Market.history/2.
:type_id(REQUIRED) — Return statistics for this type
orders_opt :: {:order_type, :buy | :sell | :all} | {:page, nil | integer} | {:type_id, nil | integer}
Options for Market.orders/2.
:order_type(DEFAULT::all) — Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders.:page(DEFAULT:1) — Which page of results to return:type_id— Return orders only for this type
Options for Market.structure/2.
:page(DEFAULT:1) — Which page of results to return:token— Access token to use if unable to set a header
Options for Market.types/2.
:page(DEFAULT:1) — Which page of results to return
Functions
group_market_group(market_group_id :: integer, opts :: group_market_group_opts) :: ESI.Request.t
Get information on an item group.
Response Example
Information about an item group:
%{"description" => "Small, fast vessels suited to a variety of purposes.",
"market_group_id" => 5, "name" => "Standard Frigates",
"parent_group_id" => 1361, "types" => [582, 583]}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_groups_market_group_idpath—/markets/groups/{market_group_id}/
Get a list of item groups.
Response Example
A list of item group ids:
[1, 2, 3]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_groupspath—/markets/groups/
Return a list of historical market statistics for the specified type in a region.
Response Example
A list of historical market statistics:
[%{"average" => 5.25, "date" => "2015-05-01", "highest" => 5.27,
"lowest" => 5.11, "order_count" => 2267, "volume" => 16276782035}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_region_id_historypath—/markets/{region_id}/history/
Return a list of orders in a region.
Response Example
A list of orders:
[%{"duration" => 90, "is_buy_order" => false,
"issued" => "2016-09-03T05:12:25Z", "location_id" => 60005599,
"min_volume" => 1, "order_id" => 4623824223, "price" => 9.9,
"range" => "region", "type_id" => 34, "volume_remain" => 1296000,
"volume_total" => 2000000}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_region_id_orderspath—/markets/{region_id}/orders/
Return a list of prices.
Response Example
A list of prices:
[%{"adjusted_price" => 306988.09, "average_price" => 306292.67,
"type_id" => 32772}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_pricespath—/markets/prices/
structure(structure_id :: integer, opts :: structure_opts) :: ESI.Request.t
Return all orders in a structure.
Response Example
A list of orders:
[%{"duration" => 90, "is_buy_order" => false,
"issued" => "2016-09-03T05:12:25Z", "location_id" => 1020988381992,
"min_volume" => 1, "order_id" => 4623824223, "price" => 9.9,
"range" => "region", "type_id" => 34, "volume_remain" => 1296000,
"volume_total" => 2000000}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_structures_structure_idpath—/markets/structures/{structure_id}/
Return a list of type IDs that have active orders in the region, for efficient market indexing..
Response Example
A list of type IDs:
[587, 593, 597]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_markets_region_id_typespath—/markets/{region_id}/types/