Swagger\Client\Eve\ContractsApi

All URIs are relative to https://esi.evetech.net, except if the operation defines another base path.

Method	HTTP request	Description
getCharactersCharacterIdContracts()	GET /v1/characters/{character_id}/contracts/	Get contracts
getCharactersCharacterIdContractsContractIdBids()	GET /v1/characters/{character_id}/contracts/{contract_id}/bids/	Get contract bids
getCharactersCharacterIdContractsContractIdItems()	GET /v1/characters/{character_id}/contracts/{contract_id}/items/	Get contract items
getContractsPublicBidsContractId()	GET /v1/contracts/public/bids/{contract_id}/	Get public contract bids
getContractsPublicItemsContractId()	GET /v1/contracts/public/items/{contract_id}/	Get public contract items
getContractsPublicRegionId()	GET /v1/contracts/public/{region_id}/	Get public contracts
getCorporationsCorporationIdContracts()	GET /v1/corporations/{corporation_id}/contracts/	Get corporation contracts
getCorporationsCorporationIdContractsContractIdBids()	GET /v1/corporations/{corporation_id}/contracts/{contract_id}/bids/	Get corporation contract bids
getCorporationsCorporationIdContractsContractIdItems()	GET /v1/corporations/{corporation_id}/contracts/{contract_id}/items/	Get corporation contract items

`getCharactersCharacterIdContracts()`

getCharactersCharacterIdContracts($character_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdContracts200Ok[]

Get contracts

Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". --- This route is cached for up to 300 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$character_id = 56; // int | An EVE character ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdContracts($character_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContracts: ', $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']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
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]

Return type

\Swagger\Client\Eve\Model\GetCharactersCharacterIdContracts200Ok[]

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]

`getCharactersCharacterIdContractsContractIdBids()`

getCharactersCharacterIdContractsContractIdBids($character_id, $contract_id, $datasource, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdContractsContractIdBids200Ok[]

Get contract bids

Lists bids on a particular auction contract --- This route is cached for up to 300 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$character_id = 56; // int | An EVE character ID
$contract_id = 56; // int | ID of a contract
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_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

try {
    $result = $apiInstance->getCharactersCharacterIdContractsContractIdBids($character_id, $contract_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContractsContractIdBids: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	An EVE character ID
contract_id	int	ID of a contract
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	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

\Swagger\Client\Eve\Model\GetCharactersCharacterIdContractsContractIdBids200Ok[]

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]

`getCharactersCharacterIdContractsContractIdItems()`

getCharactersCharacterIdContractsContractIdItems($character_id, $contract_id, $datasource, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdContractsContractIdItems200Ok[]

Get contract items

Lists items of a particular contract --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$character_id = 56; // int | An EVE character ID
$contract_id = 56; // int | ID of a contract
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_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

try {
    $result = $apiInstance->getCharactersCharacterIdContractsContractIdItems($character_id, $contract_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContractsContractIdItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	An EVE character ID
contract_id	int	ID of a contract
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	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

\Swagger\Client\Eve\Model\GetCharactersCharacterIdContractsContractIdItems200Ok[]

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]

`getContractsPublicBidsContractId()`

getContractsPublicBidsContractId($contract_id, $datasource, $if_none_match, $page): \Swagger\Client\Eve\Model\GetContractsPublicBidsContractId200Ok[]

Get public contract bids

Lists bids on a public auction contract --- This route is cached for up to 300 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$contract_id = 56; // int | ID of a contract
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return

try {
    $result = $apiInstance->getContractsPublicBidsContractId($contract_id, $datasource, $if_none_match, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getContractsPublicBidsContractId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contract_id	int	ID of a contract
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	int	Which page of results to return	[optional] [default to 1]

Return type

\Swagger\Client\Eve\Model\GetContractsPublicBidsContractId200Ok[]

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]

`getContractsPublicItemsContractId()`

getContractsPublicItemsContractId($contract_id, $datasource, $if_none_match, $page): \Swagger\Client\Eve\Model\GetContractsPublicItemsContractId200Ok[]

Get public contract items

Lists items of a public contract --- This route is cached for up to 3600 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$contract_id = 56; // int | ID of a contract
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return

try {
    $result = $apiInstance->getContractsPublicItemsContractId($contract_id, $datasource, $if_none_match, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getContractsPublicItemsContractId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contract_id	int	ID of a contract
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	int	Which page of results to return	[optional] [default to 1]

Return type

\Swagger\Client\Eve\Model\GetContractsPublicItemsContractId200Ok[]

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]

`getContractsPublicRegionId()`

getContractsPublicRegionId($region_id, $datasource, $if_none_match, $page): \Swagger\Client\Eve\Model\GetContractsPublicRegionId200Ok[]

Get public contracts

Returns a paginated list of all public contracts in the given region --- This route is cached for up to 1800 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$region_id = 56; // int | An EVE region id
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return

try {
    $result = $apiInstance->getContractsPublicRegionId($region_id, $datasource, $if_none_match, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getContractsPublicRegionId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
region_id	int	An EVE region id
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
page	int	Which page of results to return	[optional] [default to 1]

Return type

\Swagger\Client\Eve\Model\GetContractsPublicRegionId200Ok[]

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]

`getCorporationsCorporationIdContracts()`

getCorporationsCorporationIdContracts($corporation_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCorporationsCorporationIdContracts200Ok[]

Get corporation contracts

Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". --- This route is cached for up to 300 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$corporation_id = 56; // int | An EVE corporation ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCorporationsCorporationIdContracts($corporation_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCorporationsCorporationIdContracts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
corporation_id	int	An EVE corporation ID
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
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]

Return type

\Swagger\Client\Eve\Model\GetCorporationsCorporationIdContracts200Ok[]

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]

`getCorporationsCorporationIdContractsContractIdBids()`

getCorporationsCorporationIdContractsContractIdBids($contract_id, $corporation_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCorporationsCorporationIdContractsContractIdBids200Ok[]

Get corporation contract bids

Lists bids on a particular auction contract --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$contract_id = 56; // int | ID of a contract
$corporation_id = 56; // int | An EVE corporation ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCorporationsCorporationIdContractsContractIdBids($contract_id, $corporation_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCorporationsCorporationIdContractsContractIdBids: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contract_id	int	ID of a contract
corporation_id	int	An EVE corporation ID
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	string	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
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]

Return type

\Swagger\Client\Eve\Model\GetCorporationsCorporationIdContractsContractIdBids200Ok[]

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]

`getCorporationsCorporationIdContractsContractIdItems()`

getCorporationsCorporationIdContractsContractIdItems($contract_id, $corporation_id, $datasource, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCorporationsCorporationIdContractsContractIdItems200Ok[]

Get corporation contract items

Lists items of a particular contract --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\ContractsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$contract_id = 56; // int | ID of a contract
$corporation_id = 56; // int | An EVE corporation ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_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

try {
    $result = $apiInstance->getCorporationsCorporationIdContractsContractIdItems($contract_id, $corporation_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCorporationsCorporationIdContractsContractIdItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contract_id	int	ID of a contract
corporation_id	int	An EVE corporation ID
datasource	string	The server name you would like data from	[optional] [default to 'tranquility']
if_none_match	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

\Swagger\Client\Eve\Model\GetCorporationsCorporationIdContractsContractIdItems200Ok[]

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]

Files

ContractsApi.md

Latest commit

History

ContractsApi.md

File metadata and controls

Swagger\Client\Eve\ContractsApi

getCharactersCharacterIdContracts()

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdContractsContractIdBids()

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdContractsContractIdItems()

Example

Parameters

Return type

Authorization

HTTP request headers

getContractsPublicBidsContractId()

Example

Parameters

Return type

Authorization

HTTP request headers

getContractsPublicItemsContractId()

Example

Parameters

Return type

Authorization

HTTP request headers

getContractsPublicRegionId()

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdContracts()

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdContractsContractIdBids()

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdContractsContractIdItems()

Example

Parameters

Return type

Authorization

HTTP request headers

`getCharactersCharacterIdContracts()`

`getCharactersCharacterIdContractsContractIdBids()`

`getCharactersCharacterIdContractsContractIdItems()`

`getContractsPublicBidsContractId()`

`getContractsPublicItemsContractId()`

`getContractsPublicRegionId()`

`getCorporationsCorporationIdContracts()`

`getCorporationsCorporationIdContractsContractIdBids()`

`getCorporationsCorporationIdContractsContractIdItems()`