Skip to content

Swagger Generated PHP Client for EVE Online ESI API

Notifications You must be signed in to change notification settings

DEQC/eve-swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwaggerClient-php

An OpenAPI for EVE Online

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

  • API version: 0.5.3
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new Swagger\Client\Api\AllianceApi();
$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->getAlliances($datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliances: ', $e->getMessage(), 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 getCharactersCharacterIdAgentsResearch GET /characters/{character_id}/agents_research/ Get agents research
CharacterApi getCharactersCharacterIdBlueprints GET /characters/{character_id}/blueprints/ Get blueprints
CharacterApi getCharactersCharacterIdChatChannels GET /characters/{character_id}/chat_channels/ Get chat channels
CharacterApi getCharactersCharacterIdCorporationhistory GET /characters/{character_id}/corporationhistory/ Get corporation history
CharacterApi getCharactersCharacterIdFatigue GET /characters/{character_id}/fatigue/ Get jump fatigue
CharacterApi getCharactersCharacterIdMedals GET /characters/{character_id}/medals/ Get medals
CharacterApi getCharactersCharacterIdPortrait GET /characters/{character_id}/portrait/ Get character portraits
CharacterApi getCharactersCharacterIdRoles GET /characters/{character_id}/roles/ Get character corporation roles
CharacterApi getCharactersCharacterIdStandings GET /characters/{character_id}/standings/ Get standings
CharacterApi getCharactersNames GET /characters/names/ Get character names
CharacterApi postCharactersAffiliation POST /characters/affiliation/ Character affiliation
CharacterApi postCharactersCharacterIdCspa POST /characters/{character_id}/cspa/ Calculate a CSPA charge cost
ClonesApi getCharactersCharacterIdClones GET /characters/{character_id}/clones/ Get clones
ClonesApi getCharactersCharacterIdImplants GET /characters/{character_id}/implants/ Get active implants
ContactsApi deleteCharactersCharacterIdContacts DELETE /characters/{character_id}/contacts/ Delete contacts
ContactsApi getCharactersCharacterIdContacts GET /characters/{character_id}/contacts/ Get contacts
ContactsApi getCharactersCharacterIdContactsLabels GET /characters/{character_id}/contacts/labels/ Get contact labels
ContactsApi postCharactersCharacterIdContacts POST /characters/{character_id}/contacts/ Add contacts
ContactsApi putCharactersCharacterIdContacts PUT /characters/{character_id}/contacts/ Edit contacts
ContractsApi getCharactersCharacterIdContracts GET /characters/{character_id}/contracts/ Get contracts
ContractsApi getCharactersCharacterIdContractsContractIdBids GET /characters/{character_id}/contracts/{contract_id}/bids/ Get contract bids
ContractsApi getCharactersCharacterIdContractsContractIdItems GET /characters/{character_id}/contracts/{contract_id}/items/ Get contract items
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 getCorporationsCorporationIdStructures GET /corporations/{corporation_id}/structures/ Get corporation structures
CorporationApi getCorporationsNames GET /corporations/names/ Get corporation names
CorporationApi getCorporationsNpccorps GET /corporations/npccorps/ Get npc corporations
CorporationApi putCorporationsCorporationIdStructuresStructureId PUT /corporations/{corporation_id}/structures/{structure_id}/ Update structure vulnerability schedule
DogmaApi getDogmaAttributes GET /dogma/attributes/ Get attributes
DogmaApi getDogmaAttributesAttributeId GET /dogma/attributes/{attribute_id}/ Get attribute information
DogmaApi getDogmaEffects GET /dogma/effects/ Get effects
DogmaApi getDogmaEffectsEffectId GET /dogma/effects/{effect_id}/ Get effect information
FittingsApi deleteCharactersCharacterIdFittingsFittingId DELETE /characters/{character_id}/fittings/{fitting_id}/ Delete fitting
FittingsApi getCharactersCharacterIdFittings GET /characters/{character_id}/fittings/ Get fittings
FittingsApi postCharactersCharacterIdFittings POST /characters/{character_id}/fittings/ Create fitting
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 getCharactersCharacterIdIndustryJobs GET /characters/{character_id}/industry/jobs/ List character industry jobs
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 getCharactersCharacterIdOnline GET /characters/{character_id}/online/ Get character online
LocationApi getCharactersCharacterIdShip GET /characters/{character_id}/ship/ Get current ship
LoyaltyApi getCharactersCharacterIdLoyaltyPoints GET /characters/{character_id}/loyalty/points/ Get loyalty points
LoyaltyApi getLoyaltyStoresCorporationIdOffers GET /loyalty/stores/{corporation_id}/offers/ List loyalty store offers
MailApi deleteCharactersCharacterIdMailLabelsLabelId DELETE /characters/{character_id}/mail/labels/{label_id}/ Delete a mail label
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 getCharactersCharacterIdOrders GET /characters/{character_id}/orders/ List orders from a character
MarketApi getMarketsGroups GET /markets/groups/ Get item groups
MarketApi getMarketsGroupsMarketGroupId GET /markets/groups/{market_group_id}/ Get item group information
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
MarketApi getMarketsStructuresStructureId GET /markets/structures/{structure_id}/ List orders in a structure
OpportunitiesApi getCharactersCharacterIdOpportunities GET /characters/{character_id}/opportunities/ Get a character's completed tasks
OpportunitiesApi getOpportunitiesGroups GET /opportunities/groups/ Get opportunities groups
OpportunitiesApi getOpportunitiesGroupsGroupId GET /opportunities/groups/{group_id}/ Get opportunities group
OpportunitiesApi getOpportunitiesTasks GET /opportunities/tasks/ Get opportunities tasks
OpportunitiesApi getOpportunitiesTasksTaskId GET /opportunities/tasks/{task_id}/ Get opportunities task
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
RoutesApi getRouteOriginDestination GET /route/{origin}/{destination}/ Get route
SearchApi getCharactersCharacterIdSearch GET /characters/{character_id}/search/ Search on a string
SearchApi getSearch GET /search/ Search on a string
SkillsApi getCharactersCharacterIdAttributes GET /characters/{character_id}/attributes/ Get character attributes
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 getSovereigntyMap GET /sovereignty/map/ List sovereignty of systems
SovereigntyApi getSovereigntyStructures GET /sovereignty/structures/ List sovereignty structures
StatusApi getStatus GET /status/ Retrieve the uptime and player counts
UniverseApi getUniverseBloodlines GET /universe/bloodlines/ Get bloodlines
UniverseApi getUniverseCategories GET /universe/categories/ Get item categories
UniverseApi getUniverseCategoriesCategoryId GET /universe/categories/{category_id}/ Get item category information
UniverseApi getUniverseConstellations GET /universe/constellations/ Get constellations
UniverseApi getUniverseConstellationsConstellationId GET /universe/constellations/{constellation_id}/ Get constellation information
UniverseApi getUniverseFactions GET /universe/factions/ Get factions
UniverseApi getUniverseGraphics GET /universe/graphics/ Get graphics
UniverseApi getUniverseGraphicsGraphicId GET /universe/graphics/{graphic_id}/ Get graphic information
UniverseApi getUniverseGroups GET /universe/groups/ Get item groups
UniverseApi getUniverseGroupsGroupId GET /universe/groups/{group_id}/ Get item group information
UniverseApi getUniverseMoonsMoonId GET /universe/moons/{moon_id}/ Get moon information
UniverseApi getUniversePlanetsPlanetId GET /universe/planets/{planet_id}/ Get planet information
UniverseApi getUniverseRaces GET /universe/races/ Get character races
UniverseApi getUniverseRegions GET /universe/regions/ Get regions
UniverseApi getUniverseRegionsRegionId GET /universe/regions/{region_id}/ Get region information
UniverseApi getUniverseStargatesStargateId GET /universe/stargates/{stargate_id}/ Get stargate information
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 getUniverseSystemJumps GET /universe/system_jumps/ Get system jumps
UniverseApi getUniverseSystemKills GET /universe/system_kills/ Get system kills
UniverseApi getUniverseSystems GET /universe/systems/ Get solar systems
UniverseApi getUniverseSystemsSystemId GET /universe/systems/{system_id}/ Get solar system information
UniverseApi getUniverseTypes GET /universe/types/ Get types
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
UserInterfaceApi postUiAutopilotWaypoint POST /ui/autopilot/waypoint/ Set Autopilot Waypoint
UserInterfaceApi postUiOpenwindowContract POST /ui/openwindow/contract/ Open Contract Window
UserInterfaceApi postUiOpenwindowInformation POST /ui/openwindow/information/ Open Information Window
UserInterfaceApi postUiOpenwindowMarketdetails POST /ui/openwindow/marketdetails/ Open Market Details
UserInterfaceApi postUiOpenwindowNewmail POST /ui/openwindow/newmail/ Open New Mail Window
WalletApi getCharactersCharacterIdWallet GET /characters/{character_id}/wallet/ Get a character's wallet balance
WalletApi getCharactersCharacterIdWalletJournal GET /characters/{character_id}/wallet/journal/ Get character wallet journal
WalletApi getCharactersCharacterIdWalletTransactions GET /characters/{character_id}/wallet/transactions/ Get wallet transactions
WalletApi getCharactersCharacterIdWallets GET /characters/{character_id}/wallets/ List wallets and balances
WalletApi getCharactersCharacterIdWalletsJournal GET /characters/{character_id}/wallets/journal/ Get character wallet journal
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_agents_research.v1: EVE SSO scope esi-characters.read_agents_research.v1
  • esi-characters.read_blueprints.v1: EVE SSO scope esi-characters.read_blueprints.v1
  • esi-characters.read_chat_channels.v1: EVE SSO scope esi-characters.read_chat_channels.v1
  • esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1
  • esi-characters.read_corporation_roles.v1: EVE SSO scope esi-characters.read_corporation_roles.v1
  • esi-characters.read_fatigue.v1: EVE SSO scope esi-characters.read_fatigue.v1
  • esi-characters.read_loyalty.v1: EVE SSO scope esi-characters.read_loyalty.v1
  • esi-characters.read_medals.v1: EVE SSO scope esi-characters.read_medals.v1
  • esi-characters.read_opportunities.v1: EVE SSO scope esi-characters.read_opportunities.v1
  • esi-characters.read_standings.v1: EVE SSO scope esi-characters.read_standings.v1
  • esi-characters.write_contacts.v1: EVE SSO scope esi-characters.write_contacts.v1
  • esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1
  • esi-clones.read_implants.v1: EVE SSO scope esi-clones.read_implants.v1
  • esi-contracts.read_character_contracts.v1: EVE SSO scope esi-contracts.read_character_contracts.v1
  • esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1
  • esi-corporations.read_structures.v1: EVE SSO scope esi-corporations.read_structures.v1
  • esi-corporations.write_structures.v1: EVE SSO scope esi-corporations.write_structures.v1
  • esi-fittings.read_fittings.v1: EVE SSO scope esi-fittings.read_fittings.v1
  • esi-fittings.write_fittings.v1: EVE SSO scope esi-fittings.write_fittings.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-industry.read_character_jobs.v1: EVE SSO scope esi-industry.read_character_jobs.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_online.v1: EVE SSO scope esi-location.read_online.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-markets.read_character_orders.v1: EVE SSO scope esi-markets.read_character_orders.v1
  • esi-markets.structure_markets.v1: EVE SSO scope esi-markets.structure_markets.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-ui.open_window.v1: EVE SSO scope esi-ui.open_window.v1
  • esi-ui.write_waypoint.v1: EVE SSO scope esi-ui.write_waypoint.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

Author

About

Swagger Generated PHP Client for EVE Online ESI API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages