module ESI::Client::Market

ESI market operations.

Public Instance Methods

get_character_orders(character_id:, headers: {}, params: {}) click to toggle source

List open market orders placed by a character.

This endpoint is cached for up to 1200 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-markets.read_character_orders.v1

@esi_version dev @esi_version v2

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_characters_character_id_orders

# File lib/esi/client/market.rb, line 31
def get_character_orders(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/orders/", headers: headers, params: params)
end
get_character_orders_history(character_id:, headers: {}, params: {}) click to toggle source

List cancelled and expired market orders placed by a character up to 90 days in the past.

This endpoint is cached for up to 3600 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-markets.read_character_orders.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_characters_character_id_orders_history

# File lib/esi/client/market.rb, line 61
def get_character_orders_history(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/orders/history/", headers: headers, params: params)
end
get_characters_character_id_orders(character_id:, headers: {}, params: {})
get_characters_character_id_orders_history(character_id:, headers: {}, params: {})
get_corporation_orders(corporation_id:, headers: {}, params: {}) click to toggle source

List open market orders placed on behalf of a corporation.

This endpoint is cached for up to 1200 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-markets.read_corporation_orders.v1

@esi_version dev @esi_version v3

@param corporation_id [Integer] An EVE corporation ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_corporations_corporation_id_orders

# File lib/esi/client/market.rb, line 90
def get_corporation_orders(corporation_id:, headers: {}, params: {})
  get("/corporations/#{corporation_id}/orders/", headers: headers, params: params)
end
get_corporation_orders_history(corporation_id:, headers: {}, params: {}) click to toggle source

List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.

This endpoint is cached for up to 3600 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-markets.read_corporation_orders.v1

@esi_version dev @esi_version v2

@param corporation_id [Integer] An EVE corporation ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_corporations_corporation_id_orders_history

# File lib/esi/client/market.rb, line 119
def get_corporation_orders_history(corporation_id:, headers: {}, params: {})
  get("/corporations/#{corporation_id}/orders/history/", headers: headers, params: params)
end
get_corporations_corporation_id_orders(corporation_id:, headers: {}, params: {})
get_corporations_corporation_id_orders_history(corporation_id:, headers: {}, params: {})
get_market_groups(headers: {}, params: {}) click to toggle source

Get a list of item groups.

@esi_version dev @esi_version legacy @esi_version v1

@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_groups

# File lib/esi/client/market.rb, line 140
def get_market_groups(headers: {}, params: {})
  get("/markets/groups/", headers: headers, params: params)
end
Also aliased as: get_markets_groups
get_market_groups_market_group(market_group_id:, headers: {}, params: {}) click to toggle source

Get information on an item group.

@esi_version dev @esi_version legacy @esi_version v1

@param market_group_id [Integer] An Eve item group ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Market group not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_groups_market_group_id

# File lib/esi/client/market.rb, line 163
def get_market_groups_market_group(market_group_id:, headers: {}, params: {})
  get("/markets/groups/#{market_group_id}/", headers: headers, params: params)
end
get_market_prices(headers: {}, params: {}) click to toggle source

Return a list of prices.

This endpoint is cached for up to 3600 seconds.

@esi_version dev @esi_version legacy @esi_version v1

@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_prices

# File lib/esi/client/market.rb, line 186
def get_market_prices(headers: {}, params: {})
  get("/markets/prices/", headers: headers, params: params)
end
Also aliased as: get_markets_prices
get_markets_groups(headers: {}, params: {})
Alias for: get_market_groups
get_markets_groups_market_group_id(market_group_id:, headers: {}, params: {})
get_markets_prices(headers: {}, params: {})
Alias for: get_market_prices
get_markets_region_history(region_id:, type_id:, headers: {}, params: {}) click to toggle source

Return a list of historical market statistics for the specified type in a region.

@esi_version dev @esi_version legacy @esi_version v1

@param region_id [Integer] Return statistics in this region @param type_id [Integer] Return statistics for this type @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Type not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::UnprocessableEntityError] Not found @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server

@see esi.evetech.net/ui/#/Market/get_markets_region_id_history

# File lib/esi/client/market.rb, line 212
def get_markets_region_history(region_id:, type_id:, headers: {}, params: {})
  params.merge!("type_id" => type_id)
  get("/markets/#{region_id}/history/", headers: headers, params: params)
end
get_markets_region_id_history(region_id:, type_id:, headers: {}, params: {})
get_markets_region_id_orders(region_id:, order_type: "all", type_id: nil, headers: {}, params: {})
get_markets_region_id_types(region_id:, headers: {}, params: {})
get_markets_region_orders(region_id:, order_type: "all", type_id: nil, headers: {}, params: {}) click to toggle source

Return a list of orders in a region.

This endpoint is cached for up to 300 seconds.

@esi_version dev @esi_version legacy @esi_version v1

@param region_id [Integer] Return orders in this region @param order_type [String] Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. Must be one of: `buy`, `sell`, `all` @param type_id [Integer] Return orders only for this type @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::UnprocessableEntityError] Not found @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_region_id_orders

# File lib/esi/client/market.rb, line 241
def get_markets_region_orders(region_id:, order_type: "all", type_id: nil, headers: {}, params: {})
  params.merge!("order_type" => order_type, "type_id" => type_id)
  get("/markets/#{region_id}/orders/", headers: headers, params: params)
end
Also aliased as: get_markets_region_id_orders
get_markets_region_types(region_id:, headers: {}, params: {}) click to toggle source

Return a list of type IDs that have active orders in the region, for efficient market indexing.

This endpoint is cached for up to 600 seconds.

@esi_version dev @esi_version legacy @esi_version v1

@param region_id [Integer] Return statistics in this region @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_region_id_types

# File lib/esi/client/market.rb, line 266
def get_markets_region_types(region_id:, headers: {}, params: {})
  get("/markets/#{region_id}/types/", headers: headers, params: params)
end
Also aliased as: get_markets_region_id_types
get_markets_structure(structure_id:, headers: {}, params: {}) click to toggle source

Return all orders in a structure.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-markets.structure_markets.v1

@esi_version dev @esi_version legacy @esi_version v1

@param structure_id [Integer] Return orders in this structure @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Market/get_markets_structures_structure_id

# File lib/esi/client/market.rb, line 296
def get_markets_structure(structure_id:, headers: {}, params: {})
  get("/markets/structures/#{structure_id}/", headers: headers, params: params)
end
get_markets_structures_structure_id(structure_id:, headers: {}, params: {})