README

An OpenAPI for EVE Online

This PHP package is automatically generated by the Swagger Codegen project:

API version: 0.3.9
Build date: 2017-01-25T12:12:13.556-05:00
Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, run composer require mglinski/php-esi-lib

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
use ESI\Client\ApiException;
use ESI\Client\HTTPlugApiClient;

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

$api_instance = new ESI\Client\Api\AllianceApi(new HTTPlugApiClient());

$datasource = "tranquility"; // string | The server name you would like data from

try {
    $result = $api_instance->getAlliances($datasource);
    var_dump($result);
} catch (ApiException $e) {
    echo 'Exception when calling AllianceApi->getAlliances: ', $e->getResponseHeaders()[0], ' "', $e->getResponseBody()->error, '"', PHP_EOL;
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AllianceApi	getAlliances	GET /alliances/	List all alliances
AllianceApi	getAlliancesAllianceId	GET /alliances/{alliance_id}/	Get alliance information
AllianceApi	getAlliancesAllianceIdCorporations	GET /alliances/{alliance_id}/corporations/	List alliance's corporations
AllianceApi	getAlliancesAllianceIdIcons	GET /alliances/{alliance_id}/icons/	Get alliance icon
AllianceApi	getAlliancesNames	GET /alliances/names/	Get alliance names
AssetsApi	getCharactersCharacterIdAssets	GET /characters/{character_id}/assets/	Get character assets
BookmarksApi	getCharactersCharacterIdBookmarks	GET /characters/{character_id}/bookmarks/	List bookmarks
BookmarksApi	getCharactersCharacterIdBookmarksFolders	GET /characters/{character_id}/bookmarks/folders/	List bookmark folders
CalendarApi	getCharactersCharacterIdCalendar	GET /characters/{character_id}/calendar/	List calendar event summaries
CalendarApi	getCharactersCharacterIdCalendarEventId	GET /characters/{character_id}/calendar/{event_id}/	Get an event
CalendarApi	putCharactersCharacterIdCalendarEventId	PUT /characters/{character_id}/calendar/{event_id}/	Respond to an event
CharacterApi	getCharactersCharacterId	GET /characters/{character_id}/	Get character's public information
CharacterApi	getCharactersCharacterIdCorporationhistory	GET /characters/{character_id}/corporationhistory/	Get corporation history
CharacterApi	getCharactersCharacterIdPortrait	GET /characters/{character_id}/portrait/	Get character portraits
CharacterApi	getCharactersNames	GET /characters/names/	Get character names
CharacterApi	postCharactersCharacterIdCspa	POST /characters/{character_id}/cspa/	Calculate a CSPA charge cost
ClonesApi	getCharactersCharacterIdClones	GET /characters/{character_id}/clones/	Get clones
CorporationApi	getCorporationsCorporationId	GET /corporations/{corporation_id}/	Get corporation information
CorporationApi	getCorporationsCorporationIdAlliancehistory	GET /corporations/{corporation_id}/alliancehistory/	Get alliance history
CorporationApi	getCorporationsCorporationIdIcons	GET /corporations/{corporation_id}/icons/	Get corporation icon
CorporationApi	getCorporationsCorporationIdMembers	GET /corporations/{corporation_id}/members/	Get corporation members
CorporationApi	getCorporationsCorporationIdRoles	GET /corporations/{corporation_id}/roles/	Get corporation member roles
CorporationApi	getCorporationsNames	GET /corporations/names/	Get corporation names
FleetsApi	deleteFleetsFleetIdMembersMemberId	DELETE /fleets/{fleet_id}/members/{member_id}/	Kick fleet member
FleetsApi	deleteFleetsFleetIdSquadsSquadId	DELETE /fleets/{fleet_id}/squads/{squad_id}/	Delete fleet squad
FleetsApi	deleteFleetsFleetIdWingsWingId	DELETE /fleets/{fleet_id}/wings/{wing_id}/	Delete fleet wing
FleetsApi	getFleetsFleetId	GET /fleets/{fleet_id}/	Get fleet information
FleetsApi	getFleetsFleetIdMembers	GET /fleets/{fleet_id}/members/	Get fleet members
FleetsApi	getFleetsFleetIdWings	GET /fleets/{fleet_id}/wings/	Get fleet wings
FleetsApi	postFleetsFleetIdMembers	POST /fleets/{fleet_id}/members/	Create fleet invitation
FleetsApi	postFleetsFleetIdWings	POST /fleets/{fleet_id}/wings/	Create fleet wing
FleetsApi	postFleetsFleetIdWingsWingIdSquads	POST /fleets/{fleet_id}/wings/{wing_id}/squads/	Create fleet squad
FleetsApi	putFleetsFleetId	PUT /fleets/{fleet_id}/	Update fleet
FleetsApi	putFleetsFleetIdMembersMemberId	PUT /fleets/{fleet_id}/members/{member_id}/	Move fleet member
FleetsApi	putFleetsFleetIdSquadsSquadId	PUT /fleets/{fleet_id}/squads/{squad_id}/	Rename fleet squad
FleetsApi	putFleetsFleetIdWingsWingId	PUT /fleets/{fleet_id}/wings/{wing_id}/	Rename fleet wing
IncursionsApi	getIncursions	GET /incursions/	List incursions
IndustryApi	getIndustryFacilities	GET /industry/facilities/	List industry facilities
IndustryApi	getIndustrySystems	GET /industry/systems/	List solar system cost indices
InsuranceApi	getInsurancePrices	GET /insurance/prices/	List insurance levels
KillmailsApi	getCharactersCharacterIdKillmailsRecent	GET /characters/{character_id}/killmails/recent/	List kills and losses
KillmailsApi	getKillmailsKillmailIdKillmailHash	GET /killmails/{killmail_id}/{killmail_hash}/	Get a single killmail
LocationApi	getCharactersCharacterIdLocation	GET /characters/{character_id}/location/	Get character location
LocationApi	getCharactersCharacterIdShip	GET /characters/{character_id}/ship/	Get current ship
MailApi	deleteCharactersCharacterIdMailMailId	DELETE /characters/{character_id}/mail/{mail_id}/	Delete a mail
MailApi	getCharactersCharacterIdMail	GET /characters/{character_id}/mail/	Return mail headers
MailApi	getCharactersCharacterIdMailLabels	GET /characters/{character_id}/mail/labels/	Get mail labels and unread counts
MailApi	getCharactersCharacterIdMailLists	GET /characters/{character_id}/mail/lists/	Return mailing list subscriptions
MailApi	getCharactersCharacterIdMailMailId	GET /characters/{character_id}/mail/{mail_id}/	Return a mail
MailApi	postCharactersCharacterIdMail	POST /characters/{character_id}/mail/	Send a new mail
MailApi	postCharactersCharacterIdMailLabels	POST /characters/{character_id}/mail/labels/	Create a mail label
MailApi	putCharactersCharacterIdMailMailId	PUT /characters/{character_id}/mail/{mail_id}/	Update metadata about a mail
MarketApi	getMarketsPrices	GET /markets/prices/	List market prices
MarketApi	getMarketsRegionIdHistory	GET /markets/{region_id}/history/	List historical market statistics in a region
MarketApi	getMarketsRegionIdOrders	GET /markets/{region_id}/orders/	List orders in a region
PlanetaryInteractionApi	getCharactersCharacterIdPlanets	GET /characters/{character_id}/planets/	Get colonies
PlanetaryInteractionApi	getCharactersCharacterIdPlanetsPlanetId	GET /characters/{character_id}/planets/{planet_id}/	Get colony layout
PlanetaryInteractionApi	getUniverseSchematicsSchematicId	GET /universe/schematics/{schematic_id}/	Get schematic information
SearchApi	getCharactersCharacterIdSearch	GET /characters/{character_id}/search/	Search on a string
SearchApi	getSearch	GET /search/	Search on a string
SkillsApi	getCharactersCharacterIdSkillqueue	GET /characters/{character_id}/skillqueue/	Get character's skill queue
SkillsApi	getCharactersCharacterIdSkills	GET /characters/{character_id}/skills/	Get character skills
SovereigntyApi	getSovereigntyCampaigns	GET /sovereignty/campaigns/	List sovereignty campaigns
SovereigntyApi	getSovereigntyStructures	GET /sovereignty/structures/	List sovereignty structures
UniverseApi	getUniverseStationsStationId	GET /universe/stations/{station_id}/	Get station information
UniverseApi	getUniverseStructures	GET /universe/structures/	List all public structures
UniverseApi	getUniverseStructuresStructureId	GET /universe/structures/{structure_id}/	Get structure information
UniverseApi	getUniverseSystemsSystemId	GET /universe/systems/{system_id}/	Get solar system information
UniverseApi	getUniverseTypesTypeId	GET /universe/types/{type_id}/	Get type information
UniverseApi	postUniverseNames	POST /universe/names/	Get names and categories for a set of ID's
WalletApi	getCharactersCharacterIdWallets	GET /characters/{character_id}/wallets/	List wallets and balances
WarsApi	getWars	GET /wars/	List wars
WarsApi	getWarsWarId	GET /wars/{war_id}/	Get war information
WarsApi	getWarsWarIdKillmails	GET /wars/{war_id}/killmails/	List kills for a war

Documentation For Models

Documentation For Authorization

evesso

Type: OAuth
Flow: implicit
Authorization URL: https://login.eveonline.com/oauth/authorize
Scopes:
esi-assets.read_assets.v1: EVE SSO scope esi-assets.read_assets.v1
esi-bookmarks.read_character_bookmarks.v1: EVE SSO scope esi-bookmarks.read_character_bookmarks.v1
esi-calendar.read_calendar_events.v1: EVE SSO scope esi-calendar.read_calendar_events.v1
esi-calendar.respond_calendar_events.v1: EVE SSO scope esi-calendar.respond_calendar_events.v1
esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1
esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1
esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1
esi-fleets.read_fleet.v1: EVE SSO scope esi-fleets.read_fleet.v1
esi-fleets.write_fleet.v1: EVE SSO scope esi-fleets.write_fleet.v1
esi-killmails.read_killmails.v1: EVE SSO scope esi-killmails.read_killmails.v1
esi-location.read_location.v1: EVE SSO scope esi-location.read_location.v1
esi-location.read_ship_type.v1: EVE SSO scope esi-location.read_ship_type.v1
esi-mail.organize_mail.v1: EVE SSO scope esi-mail.organize_mail.v1
esi-mail.read_mail.v1: EVE SSO scope esi-mail.read_mail.v1
esi-mail.send_mail.v1: EVE SSO scope esi-mail.send_mail.v1
esi-planets.manage_planets.v1: EVE SSO scope esi-planets.manage_planets.v1
esi-search.search_structures.v1: EVE SSO scope esi-search.search_structures.v1
esi-skills.read_skillqueue.v1: EVE SSO scope esi-skills.read_skillqueue.v1
esi-skills.read_skills.v1: EVE SSO scope esi-skills.read_skills.v1
esi-universe.read_structures.v1: EVE SSO scope esi-universe.read_structures.v1
esi-wallet.read_character_wallet.v1: EVE SSO scope esi-wallet.read_character_wallet.v1

mglinski / php-esi-lib

Maintainers

Details