Swagger\Client\MarketApi

All URIs are relative to https://esi.tech.ccp.is/latest

Method	HTTP request	Description
getCharactersCharacterIdOrders	GET /characters/{character_id}/orders/	List orders from a character
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
getMarketsStructuresStructureId	GET /markets/structures/{structure_id}/	List orders in a structure

getCharactersCharacterIdOrders

\Swagger\Client\Model\GetCharactersCharacterIdOrders200Ok[] getCharactersCharacterIdOrders($character_id, $datasource, $token, $user_agent, $x_user_agent)

List orders from a character

List market orders placed by a character --- Alternate route: /v1/characters/{character_id}/orders/ Alternate route: /legacy/characters/{character_id}/orders/ Alternate route: /dev/characters/{character_id}/orders/ --- This route is cached for up to 3600 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdOrders($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getCharactersCharacterIdOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
character_id	int	An EVE character ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdOrders200Ok[]

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsGroups

int[] getMarketsGroups($datasource, $user_agent, $x_user_agent)

Get item groups

Get a list of item groups --- Alternate route: /v1/markets/groups/ Alternate route: /legacy/markets/groups/ Alternate route: /dev/markets/groups/ --- This route expires daily at 11:05

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsGroups($datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
datasource	string	The server name you would like data from	[optional] [default to tranquility]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

int[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsGroupsMarketGroupId

\Swagger\Client\Model\GetMarketsGroupsMarketGroupIdOk getMarketsGroupsMarketGroupId($market_group_id, $datasource, $language, $user_agent, $x_user_agent)

Get item group information

Get information on an item group --- Alternate route: /v1/markets/groups/{market_group_id}/ Alternate route: /legacy/markets/groups/{market_group_id}/ Alternate route: /dev/markets/groups/{market_group_id}/ --- This route expires daily at 11:05

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$market_group_id = 56; // int | An Eve item group ID
$datasource = "tranquility"; // string | The server name you would like data from
$language = "en-us"; // string | Language to use in the response
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsGroupsMarketGroupId($market_group_id, $datasource, $language, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsGroupsMarketGroupId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
market_group_id	int	An Eve item group ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
language	string	Language to use in the response	[optional] [default to en-us]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetMarketsGroupsMarketGroupIdOk

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsPrices

\Swagger\Client\Model\GetMarketsPrices200Ok[] getMarketsPrices($datasource, $user_agent, $x_user_agent)

List market prices

Return a list of prices --- Alternate route: /v1/markets/prices/ Alternate route: /legacy/markets/prices/ Alternate route: /dev/markets/prices/ --- This route is cached for up to 3600 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsPrices($datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsPrices: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
datasource	string	The server name you would like data from	[optional] [default to tranquility]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetMarketsPrices200Ok[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsRegionIdHistory

\Swagger\Client\Model\GetMarketsRegionIdHistory200Ok[] getMarketsRegionIdHistory($region_id, $type_id, $datasource, $user_agent, $x_user_agent)

List historical market statistics in a region

Return a list of historical market statistics for the specified type in a region --- Alternate route: /v1/markets/{region_id}/history/ Alternate route: /legacy/markets/{region_id}/history/ Alternate route: /dev/markets/{region_id}/history/ --- This route is cached for up to 3600 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$region_id = 56; // int | Return statistics in this region
$type_id = 56; // int | Return statistics for this type
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsRegionIdHistory($region_id, $type_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsRegionIdHistory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
region_id	int	Return statistics in this region
type_id	int	Return statistics for this type
datasource	string	The server name you would like data from	[optional] [default to tranquility]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetMarketsRegionIdHistory200Ok[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsRegionIdOrders

\Swagger\Client\Model\GetMarketsRegionIdOrders200Ok[] getMarketsRegionIdOrders($order_type, $region_id, $datasource, $page, $type_id, $user_agent, $x_user_agent)

List orders in a region

Return a list of orders in a region --- Alternate route: /v1/markets/{region_id}/orders/ Alternate route: /legacy/markets/{region_id}/orders/ Alternate route: /dev/markets/{region_id}/orders/ --- This route is cached for up to 300 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$order_type = "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.
$region_id = 56; // int | Return orders in this region
$datasource = "tranquility"; // string | The server name you would like data from
$page = 1; // int | Which page of results to return
$type_id = 56; // int | Return orders only for this type
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsRegionIdOrders($order_type, $region_id, $datasource, $page, $type_id, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsRegionIdOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
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.	[default to all]
region_id	int	Return orders in this region
datasource	string	The server name you would like data from	[optional] [default to tranquility]
page	int	Which page of results to return	[optional] [default to 1]
type_id	int	Return orders only for this type	[optional]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetMarketsRegionIdOrders200Ok[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMarketsStructuresStructureId

\Swagger\Client\Model\GetMarketsStructuresStructureId200Ok[] getMarketsStructuresStructureId($structure_id, $datasource, $page, $token, $user_agent, $x_user_agent)

List orders in a structure

Return all orders in a structure --- Alternate route: /v1/markets/structures/{structure_id}/ Alternate route: /legacy/markets/structures/{structure_id}/ Alternate route: /dev/markets/structures/{structure_id}/ --- This route is cached for up to 300 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MarketApi(new \Http\Adapter\Guzzle6\Client());
$structure_id = 789; // int | Return orders in this structure
$datasource = "tranquility"; // string | The server name you would like data from
$page = 1; // int | Which page of results to return
$token = "token_example"; // string | Access token to use if unable to set a header
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getMarketsStructuresStructureId($structure_id, $datasource, $page, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MarketApi->getMarketsStructuresStructureId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
structure_id	int	Return orders in this structure
datasource	string	The server name you would like data from	[optional] [default to tranquility]
page	int	Which page of results to return	[optional] [default to 1]
token	string	Access token to use if unable to set a header	[optional]
user_agent	string	Client identifier, takes precedence over headers	[optional]
x_user_agent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\Swagger\Client\Model\GetMarketsStructuresStructureId200Ok[]

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

MarketApi.md

Latest commit

History

MarketApi.md

File metadata and controls

Swagger\Client\MarketApi

getCharactersCharacterIdOrders

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

getMarketsStructuresStructureId

Example

Parameters

Return type

Authorization

HTTP request headers