EVE Swagger Interface
  1. Planetary Interaction
EVE Swagger Interface
  • Alliance
    • List all alliances
      GET
    • Get alliance information
      GET
    • List alliance's corporations
      GET
    • Get alliance icon
      GET
  • Contacts
    • Get alliance contacts
      GET
    • Get alliance contact labels
      GET
    • Delete contacts
      DELETE
    • Get contacts
      GET
    • Add contacts
      POST
    • Edit contacts
      PUT
    • Get contact labels
      GET
    • Get corporation contacts
      GET
    • Get corporation contact labels
      GET
  • Character
    • Character affiliation
      POST
    • Get character's public information
      GET
    • Get agents research
      GET
    • Get blueprints
      GET
    • Get corporation history
      GET
    • Calculate a CSPA charge cost
      POST
    • Get jump fatigue
      GET
    • Get medals
      GET
    • Get character notifications
      GET
    • Get new contact notifications
      GET
    • Get character portraits
      GET
    • Get character corporation roles
      GET
    • Get standings
      GET
    • Yearly aggregate stats
      GET
    • Get character corporation titles
      GET
  • Assets
    • Get character assets
    • Get character asset locations
    • Get character asset names
    • Get corporation assets
    • Get corporation asset locations
    • Get corporation asset names
  • Skills
    • Get character attributes
    • Get character's skill queue
    • Get character skills
  • Bookmarks
    • List bookmarks
    • List bookmark folders
    • List corporation bookmarks
    • List corporation bookmark folders
  • Calendar
    • List calendar event summaries
    • Get an event
    • Respond to an event
    • Get attendees
  • Clones
    • Get clones
    • Get active implants
  • Contracts
    • Get contracts
    • Get contract bids
    • Get contract items
    • Get public contract bids
    • Get public contract items
    • Get public contracts
    • Get corporation contracts
    • Get corporation contract bids
    • Get corporation contract items
  • Fittings
    • Get fittings
    • Create fitting
    • Delete fitting
  • Fleets
    • Get character fleet info
    • Get fleet information
    • Update fleet
    • Get fleet members
    • Create fleet invitation
    • Kick fleet member
    • Move fleet member
    • Delete fleet squad
    • Rename fleet squad
    • Get fleet wings
    • Create fleet wing
    • Delete fleet wing
    • Rename fleet wing
    • Create fleet squad
  • Faction Warfare
    • Overview of a character involved in faction warfare
    • Overview of a corporation involved in faction warfare
    • List of the top factions in faction warfare
    • List of the top pilots in faction warfare
    • List of the top corporations in faction warfare
    • An overview of statistics about factions involved in faction warfare
    • Ownership of faction warfare systems
    • Data about which NPC factions are at war
  • Industry
    • List character industry jobs
    • Character mining ledger
    • Moon extraction timers
    • Corporation mining observers
    • Observed corporation mining
    • List corporation industry jobs
    • List industry facilities
    • List solar system cost indices
  • Killmails
    • Get a character's recent kills and losses
    • Get a corporation's recent kills and losses
    • Get a single killmail
  • Location
    • Get character location
    • Get character online
    • Get current ship
  • Loyalty
    • Get loyalty points
    • List loyalty store offers
  • Mail
    • Return mail headers
    • Send a new mail
    • Get mail labels and unread counts
    • Create a mail label
    • Delete a mail label
    • Return mailing list subscriptions
    • Delete a mail
    • Return a mail
    • Update metadata about a mail
  • Opportunities
    • Get a character's completed tasks
    • Get opportunities groups
    • Get opportunities group
    • Get opportunities tasks
    • Get opportunities task
  • Market
    • List open orders from a character
    • List historical orders by a character
    • List open orders from a corporation
    • List historical orders from a corporation
    • Get item groups
    • Get item group information
    • List market prices
    • List orders in a structure
    • List historical market statistics in a region
    • List orders in a region
    • List type IDs relevant to a market
  • Planetary Interaction
    • Get colonies
      GET
    • Get colony layout
      GET
    • List corporation customs offices
      GET
    • Get schematic information
      GET
  • Search
    • Search on a string
    • Search on a string
  • Wallet
    • Get a character's wallet balance
    • Get character wallet journal
    • Get wallet transactions
    • Returns a corporation's wallet balance
    • Get corporation wallet journal
    • Get corporation wallet transactions
  • Corporation
    • Get npc corporations
    • Get corporation information
    • Get alliance history
    • Get corporation blueprints
    • Get all corporation ALSC logs
    • Get corporation divisions
    • Get corporation facilities
    • Get corporation icon
    • Get corporation medals
    • Get corporation issued medals
    • Get corporation members
    • Get corporation member limit
    • Get corporation's members' titles
    • Track corporation members
    • Get corporation member roles
    • Get corporation member roles history
    • Get corporation shareholders
    • Get corporation standings
    • Get corporation starbases (POSes)
    • Get starbase (POS) detail
    • Get corporation structures
    • Get corporation titles
  • Dogma
    • Get attributes
    • Get attribute information
    • Get dynamic item information
    • Get effects
    • Get effect information
  • Incursions
    • List incursions
  • Insurance
    • List insurance levels
  • Routes
    • Get route
  • Sovereignty
    • List sovereignty campaigns
    • List sovereignty of systems
    • List sovereignty structures
  • Status
    • Retrieve the uptime and player counts
  • User Interface
    • Set Autopilot Waypoint
    • Open Contract Window
    • Open Information Window
    • Open Market Details
    • Open New Mail Window
  • Universe
    • Get ancestries
    • Get asteroid belt information
    • Get bloodlines
    • Get item categories
    • Get item category information
    • Get constellations
    • Get constellation information
    • Get factions
    • Get graphics
    • Get graphic information
    • Get item groups
    • Get item group information
    • Bulk names to IDs
    • Get moon information
    • Get names and categories for a set of ID's
    • Get planet information
    • Get character races
    • Get regions
    • Get region information
    • Get stargate information
    • Get star information
    • Get station information
    • List all public structures
    • Get structure information
    • Get system jumps
    • Get system kills
    • Get solar systems
    • Get solar system information
    • Get types
    • Get type information
  • Wars
    • List wars
    • Get war information
    • List kills for a war
  1. Planetary Interaction

Get colony layout

GET
/characters/{character_id}/planets/{planet_id}/
Planetary Interaction
Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.

Alternate route: /dev/characters/{character_id}/planets/{planet_id}/
Alternate route: /v3/characters/{character_id}/planets/{planet_id}/

This route is cached for up to 600 seconds
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://esi.evetech.net/latest/characters//planets//'
Response Response Example
200 - response
{
  "links": [
    {
      "destination_pin_id": 1000000017022,
      "link_level": 0,
      "source_pin_id": 1000000017021
    }
  ],
  "pins": [
    {
      "latitude": 1.55087844973,
      "longitude": 0.717145933308,
      "pin_id": 1000000017021,
      "type_id": 2254
    },
    {
      "latitude": 1.53360639935,
      "longitude": 0.709775584394,
      "pin_id": 1000000017022,
      "type_id": 2256
    }
  ],
  "routes": [
    {
      "content_type_id": 2393,
      "destination_pin_id": 1000000017030,
      "quantity": 20,
      "route_id": 4,
      "source_pin_id": 1000000017029
    }
  ]
}

Request

Path Params
character_id
integer 
required
An EVE character ID
planet_id
integer 
required
Planet id of the target planet
Query Params
datasource
string 
optional
The server name you would like data from
token
string 
optional
Access token to use if unable to set a header
Header Params
If-None-Match
string 
optional
ETag from a previous request. A 304 will be returned if this matches the current ETag

Responses

🟢200Colony layout
application/json
Body
200 ok object
links
array[object (get_characters_character_id_planets_planet_id_link) {3}] 
get_characters_character_id_planets_planet_id_links
required
links array
<= 500 items
destination_pin_id
integer <int64>
get_characters_character_id_planets_planet_id_destination_pin_id
required
destination_pin_id integer
link_level
integer <int32>
get_characters_character_id_planets_planet_id_link_level
required
link_level integer
>= 0<= 10
source_pin_id
integer <int64>
get_characters_character_id_planets_planet_id_source_pin_id
required
source_pin_id integer
pins
array[object (get_characters_character_id_planets_planet_id_pin) {11}] 
get_characters_character_id_planets_planet_id_pins
required
pins array
<= 100 items
contents
array[object (get_characters_character_id_planets_planet_id_content) {2}] 
get_characters_character_id_planets_planet_id_contents
optional
contents array
<= 90 items
expiry_time
string <date-time>
get_characters_character_id_planets_planet_id_expiry_time
optional
expiry_time string
extractor_details
object 
get_characters_character_id_planets_planet_id_extractor_details
optional
extractor_details object
factory_details
object 
get_characters_character_id_planets_planet_id_factory_details
optional
factory_details object
install_time
string <date-time>
get_characters_character_id_planets_planet_id_install_time
optional
install_time string
last_cycle_start
string <date-time>
get_characters_character_id_planets_planet_id_last_cycle_start
optional
last_cycle_start string
latitude
number <float>
get_characters_character_id_planets_planet_id_latitude
required
latitude number
longitude
number <float>
get_characters_character_id_planets_planet_id_longitude
required
longitude number
pin_id
integer <int64>
get_characters_character_id_planets_planet_id_pin_id
required
pin_id integer
schematic_id
integer <int32>
get_characters_character_id_planets_planet_id_schematic_id
optional
schematic_id integer
type_id
integer <int32>
get_characters_character_id_planets_planet_id_type_id
required
type_id integer
routes
array[object (get_characters_character_id_planets_planet_id_route) {6}] 
get_characters_character_id_planets_planet_id_routes
required
routes array
<= 1000 items
content_type_id
integer <int32>
get_characters_character_id_planets_planet_id_route_content_type_id
required
content_type_id integer
destination_pin_id
integer <int64>
get_characters_character_id_planets_planet_id_route_destination_pin_id
required
destination_pin_id integer
quantity
number <float>
get_characters_character_id_planets_planet_id_quantity
required
quantity number
route_id
integer <int64>
get_characters_character_id_planets_planet_id_route_id
required
route_id integer
source_pin_id
integer <int64>
get_characters_character_id_planets_planet_id_route_source_pin_id
required
source_pin_id integer
waypoints
array[integer <int64>]
get_characters_character_id_planets_planet_id_waypoints
optional
list of pin ID waypoints
<= 5 items
🔵304Not modified
🟠400Bad request
🟠401Unauthorized
🟠403Forbidden
🟠404Colony not found
🟠420Error limited
🔴500Internal server error
🔴503Service unavailable
🔴504Gateway timeout
Modified at 2023-08-15 09:13:25
Previous
Get colonies
Next
List corporation customs offices
Built with