EveSwaggerInterface.ContractsApi

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

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

getCharactersCharacterIdContracts

[GetCharactersCharacterIdContracts200Ok] getCharactersCharacterIdContracts(characterId, opts)

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". --- Alternate route: /dev/characters/{character_id}/contracts/ Alternate route: /legacy/characters/{character_id}/contracts/ Alternate route: /v1/characters/{character_id}/contracts/ --- 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.ContractsApi();

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.getCharactersCharacterIdContracts(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

[GetCharactersCharacterIdContracts200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdContractsContractIdBids

[GetCharactersCharacterIdContractsContractIdBids200Ok] getCharactersCharacterIdContractsContractIdBids(characterIdcontractId, opts)

Get contract bids

Lists bids on a particular auction contract --- Alternate route: /dev/characters/{character_id}/contracts/{contract_id}/bids/ Alternate route: /legacy/characters/{character_id}/contracts/{contract_id}/bids/ Alternate route: /v1/characters/{character_id}/contracts/{contract_id}/bids/ --- 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.ContractsApi();

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

var contractId = 56; // Number | ID of a contract

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.getCharactersCharacterIdContractsContractIdBids(characterIdcontractId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contractId	Number	ID of a contract
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

[GetCharactersCharacterIdContractsContractIdBids200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdContractsContractIdItems

[GetCharactersCharacterIdContractsContractIdItems200Ok] getCharactersCharacterIdContractsContractIdItems(characterIdcontractId, opts)

Get contract items

Lists items of a particular contract --- Alternate route: /dev/characters/{character_id}/contracts/{contract_id}/items/ Alternate route: /legacy/characters/{character_id}/contracts/{contract_id}/items/ Alternate route: /v1/characters/{character_id}/contracts/{contract_id}/items/ --- 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.ContractsApi();

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

var contractId = 56; // Number | ID of a contract

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.getCharactersCharacterIdContractsContractIdItems(characterIdcontractId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contractId	Number	ID of a contract
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

[GetCharactersCharacterIdContractsContractIdItems200Ok]

Authorization

evesso

HTTP request headers

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

getContractsPublicBidsContractId

[GetContractsPublicBidsContractId200Ok] getContractsPublicBidsContractId(contractId, opts)

Get public contract bids

Lists bids on a public auction contract --- Alternate route: /dev/contracts/public/bids/{contract_id}/ Alternate route: /legacy/contracts/public/bids/{contract_id}/ Alternate route: /v1/contracts/public/bids/{contract_id}/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.ContractsApi();

var contractId = 56; // Number | ID of a contract

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.getContractsPublicBidsContractId(contractId, opts, callback);

Parameters

Name	Type	Description	Notes
contractId	Number	ID of a contract
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

[GetContractsPublicBidsContractId200Ok]

Authorization

No authorization required

HTTP request headers

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

getContractsPublicItemsContractId

[GetContractsPublicItemsContractId200Ok] getContractsPublicItemsContractId(contractId, opts)

Get public contract items

Lists items of a public contract --- Alternate route: /dev/contracts/public/items/{contract_id}/ Alternate route: /legacy/contracts/public/items/{contract_id}/ Alternate route: /v1/contracts/public/items/{contract_id}/ --- This route is cached for up to 3600 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.ContractsApi();

var contractId = 56; // Number | ID of a contract

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.getContractsPublicItemsContractId(contractId, opts, callback);

Parameters

Name	Type	Description	Notes
contractId	Number	ID of a contract
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

[GetContractsPublicItemsContractId200Ok]

Authorization

No authorization required

HTTP request headers

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

getContractsPublicRegionId

[GetContractsPublicRegionId200Ok] getContractsPublicRegionId(regionId, opts)

Get public contracts

Returns a paginated list of all public contracts in the given region --- Alternate route: /dev/contracts/public/{region_id}/ Alternate route: /legacy/contracts/public/{region_id}/ Alternate route: /v1/contracts/public/{region_id}/ --- This route is cached for up to 1800 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.ContractsApi();

var regionId = 56; // Number | An EVE region 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
};

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

Parameters

Name	Type	Description	Notes
regionId	Number	An EVE region 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]

Return type

[GetContractsPublicRegionId200Ok]

Authorization

No authorization required

HTTP request headers

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

getCorporationsCorporationIdContracts

[GetCorporationsCorporationIdContracts200Ok] getCorporationsCorporationIdContracts(corporationId, opts)

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". --- Alternate route: /dev/corporations/{corporation_id}/contracts/ Alternate route: /legacy/corporations/{corporation_id}/contracts/ Alternate route: /v1/corporations/{corporation_id}/contracts/ --- 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.ContractsApi();

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.getCorporationsCorporationIdContracts(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

[GetCorporationsCorporationIdContracts200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdContractsContractIdBids

[GetCorporationsCorporationIdContractsContractIdBids200Ok] getCorporationsCorporationIdContractsContractIdBids(contractId, corporationId, opts)

Get corporation contract bids

Lists bids on a particular auction contract --- Alternate route: /dev/corporations/{corporation_id}/contracts/{contract_id}/bids/ Alternate route: /legacy/corporations/{corporation_id}/contracts/{contract_id}/bids/ Alternate route: /v1/corporations/{corporation_id}/contracts/{contract_id}/bids/ --- 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.ContractsApi();

var contractId = 56; // Number | ID of a contract

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.getCorporationsCorporationIdContractsContractIdBids(contractId, corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
contractId	Number	ID of a contract
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

[GetCorporationsCorporationIdContractsContractIdBids200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdContractsContractIdItems

[GetCorporationsCorporationIdContractsContractIdItems200Ok] getCorporationsCorporationIdContractsContractIdItems(contractId, corporationId, opts)

Get corporation contract items

Lists items of a particular contract --- Alternate route: /dev/corporations/{corporation_id}/contracts/{contract_id}/items/ Alternate route: /legacy/corporations/{corporation_id}/contracts/{contract_id}/items/ Alternate route: /v1/corporations/{corporation_id}/contracts/{contract_id}/items/ --- 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.ContractsApi();

var contractId = 56; // Number | ID of a contract

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
  '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.getCorporationsCorporationIdContractsContractIdItems(contractId, corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
contractId	Number	ID of a contract
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]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCorporationsCorporationIdContractsContractIdItems200Ok]

Authorization

evesso

HTTP request headers

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

FilesExpand file tree

ContractsApi.md

Latest commit

History

ContractsApi.md

File metadata and controls

EveSwaggerInterface.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