EVE Online Planetary Interaction API

openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Planetary Interaction API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Planetary Interaction
paths:
  /characters/{character_id}/planets/:
    get:
      description: 'Returns a list of all planetary colonies owned by a character.


        ---

        Alternate route: `/dev/characters/{character_id}/planets/`


        Alternate route: `/legacy/characters/{character_id}/planets/`


        Alternate route: `/v1/characters/{character_id}/planets/`


        ---

        This route is cached for up to 600 seconds'
      operationId: get_characters_character_id_planets
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: List of colonies
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    last_update:
                      description: last_update string
                      format: date-time
                      title: get_characters_character_id_planets_last_update
                      type: string
                    num_pins:
                      description: num_pins integer
                      format: int32
                      minimum: 1
                      title: get_characters_character_id_planets_num_pins
                      type: integer
                    owner_id:
                      description: owner_id integer
                      format: int32
                      title: get_characters_character_id_planets_owner_id
                      type: integer
                    planet_id:
                      description: planet_id integer
                      format: int32
                      title: get_characters_character_id_planets_planet_id
                      type: integer
                    planet_type:
                      description: planet_type string
                      enum:
                      - temperate
                      - barren
                      - oceanic
                      - ice
                      - gas
                      - lava
                      - storm
                      - plasma
                      title: get_characters_character_id_planets_planet_type
                      type: string
                    solar_system_id:
                      description: solar_system_id integer
                      format: int32
                      title: get_characters_character_id_planets_solar_system_id
                      type: integer
                    upgrade_level:
                      description: upgrade_level integer
                      format: int32
                      maximum: 5
                      minimum: 0
                      title: get_characters_character_id_planets_upgrade_level
                      type: integer
                  required:
                  - solar_system_id
                  - planet_id
                  - planet_type
                  - owner_id
                  - last_update
                  - upgrade_level
                  - num_pins
                  title: get_characters_character_id_planets_200_ok
                  type: object
                maxItems: 10
                title: get_characters_character_id_planets_ok
                type: array
              examples:
                response:
                  value:
                  - last_update: 2016-11-28 16:42:51+00:00
                    num_pins: 1
                    owner_id: 90000001
                    planet_id: 40023691
                    planet_type: plasma
                    solar_system_id: 30000379
                    upgrade_level: 0
                  - last_update: 2016-11-28 16:41:54+00:00
                    num_pins: 1
                    owner_id: 90000001
                    planet_id: 40023697
                    planet_type: barren
                    solar_system_id: 30000379
                    upgrade_level: 0
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-planets.manage_planets.v1
      summary: EVE Online Get Colonies
      tags:
      - Planetary Interaction
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/planets/{planet_id}/:
    get:
      description: '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}/`

        '
      operationId: get_characters_character_id_planets_planet_id
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - description: Planet id of the target planet
        in: path
        name: planet_id
        required: true
        schema:
          type: integer
          format: int32
        example: 1001
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: Colony layout
          content:
            application/json:
              schema:
                description: 200 ok object
                properties:
                  links:
                    description: links array
                    items:
                      description: link object
                      properties:
                        destination_pin_id:
                          description: destination_pin_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_destination_pin_id
                          type: integer
                        link_level:
                          description: link_level integer
                          format: int32
                          maximum: 10
                          minimum: 0
                          title: get_characters_character_id_planets_planet_id_link_level
                          type: integer
                        source_pin_id:
                          description: source_pin_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_source_pin_id
                          type: integer
                      required:
                      - source_pin_id
                      - destination_pin_id
                      - link_level
                      title: get_characters_character_id_planets_planet_id_link
                      type: object
                    maxItems: 500
                    title: get_characters_character_id_planets_planet_id_links
                    type: array
                  pins:
                    description: pins array
                    items:
                      description: pin object
                      properties:
                        contents:
                          description: contents array
                          items:
                            description: content object
                            properties:
                              amount:
                                description: amount integer
                                format: int64
                                title: get_characters_character_id_planets_planet_id_amount
                                type: integer
                              type_id:
                                description: type_id integer
                                format: int32
                                title: get_characters_character_id_planets_planet_id_content_type_id
                                type: integer
                            required:
                            - type_id
                            - amount
                            title: get_characters_character_id_planets_planet_id_content
                            type: object
                          maxItems: 90
                          title: get_characters_character_id_planets_planet_id_contents
                          type: array
                        expiry_time:
                          description: expiry_time string
                          format: date-time
                          title: get_characters_character_id_planets_planet_id_expiry_time
                          type: string
                        extractor_details:
                          description: extractor_details object
                          properties:
                            cycle_time:
                              description: in seconds
                              format: int32
                              title: get_characters_character_id_planets_planet_id_cycle_time
                              type: integer
                            head_radius:
                              description: head_radius number
                              format: float
                              title: get_characters_character_id_planets_planet_id_head_radius
                              type: number
                            heads:
                              description: heads array
                              items:
                                description: head object
                                properties:
                                  head_id:
                                    description: head_id integer
                                    format: int32
                                    maximum: 9
                                    minimum: 0
                                    title: get_characters_character_id_planets_planet_id_head_id
                                    type: integer
                                  latitude:
                                    description: latitude number
                                    format: float
                                    title: get_characters_character_id_planets_planet_id_head_latitude
                                    type: number
                                  longitude:
                                    description: longitude number
                                    format: float
                                    title: get_characters_character_id_planets_planet_id_head_longitude
                                    type: number
                                required:
                                - head_id
                                - latitude
                                - longitude
                                title: get_characters_character_id_planets_planet_id_head
                                type: object
                              maxItems: 10
                              title: get_characters_character_id_planets_planet_id_heads
                              type: array
                            product_type_id:
                              description: product_type_id integer
                              format: int32
                              title: get_characters_character_id_planets_planet_id_product_type_id
                              type: integer
                            qty_per_cycle:
                              description: qty_per_cycle integer
                              format: int32
                              title: get_characters_character_id_planets_planet_id_qty_per_cycle
                              type: integer
                          required:
                          - heads
                          title: get_characters_character_id_planets_planet_id_extractor_details
                          type: object
                        factory_details:
                          description: factory_details object
                          properties:
                            schematic_id:
                              description: schematic_id integer
                              format: int32
                              title: get_characters_character_id_planets_planet_id_factory_details_schematic_id
                              type: integer
                          required:
                          - schematic_id
                          title: get_characters_character_id_planets_planet_id_factory_details
                          type: object
                        install_time:
                          description: install_time string
                          format: date-time
                          title: get_characters_character_id_planets_planet_id_install_time
                          type: string
                        last_cycle_start:
                          description: last_cycle_start string
                          format: date-time
                          title: get_characters_character_id_planets_planet_id_last_cycle_start
                          type: string
                        latitude:
                          description: latitude number
                          format: float
                          title: get_characters_character_id_planets_planet_id_latitude
                          type: number
                        longitude:
                          description: longitude number
                          format: float
                          title: get_characters_character_id_planets_planet_id_longitude
                          type: number
                        pin_id:
                          description: pin_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_pin_id
                          type: integer
                        schematic_id:
                          description: schematic_id integer
                          format: int32
                          title: get_characters_character_id_planets_planet_id_schematic_id
                          type: integer
                        type_id:
                          description: type_id integer
                          format: int32
                          title: get_characters_character_id_planets_planet_id_type_id
                          type: integer
                      required:
                      - pin_id
                      - type_id
                      - latitude
                      - longitude
                      title: get_characters_character_id_planets_planet_id_pin
                      type: object
                    maxItems: 100
                    title: get_characters_character_id_planets_planet_id_pins
                    type: array
                  routes:
                    description: routes array
                    items:
                      description: route object
                      properties:
                        content_type_id:
                          description: content_type_id integer
                          format: int32
                          title: get_characters_character_id_planets_planet_id_route_content_type_id
                          type: integer
                        destination_pin_id:
                          description: destination_pin_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_route_destination_pin_id
                          type: integer
                        quantity:
                          description: quantity number
                          format: float
                          title: get_characters_character_id_planets_planet_id_quantity
                          type: number
                        route_id:
                          description: route_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_route_id
                          type: integer
                        source_pin_id:
                          description: source_pin_id integer
                          format: int64
                          title: get_characters_character_id_planets_planet_id_route_source_pin_id
                          type: integer
                        waypoints:
                          description: list of pin ID waypoints
                          items:
                            description: waypoint integer
                            format: int64
                            title: get_characters_character_id_planets_planet_id_waypoint
                            type: integer
                          maxItems: 5
                          title: get_characters_character_id_planets_planet_id_waypoints
                          type: array
                      required:
                      - route_id
                      - source_pin_id
                      - destination_pin_id
                      - content_type_id
                      - quantity
                      title: get_characters_character_id_planets_planet_id_route
                      type: object
                    maxItems: 1000
                    title: get_characters_character_id_planets_planet_id_routes
                    type: array
                required:
                - links
                - pins
                - routes
                title: get_characters_character_id_planets_planet_id_ok
                type: object
              examples:
                response:
                  value:
                    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
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '404':
          description: Colony not found
          content:
            application/json:
              schema:
                description: Colony not found
                properties:
                  error:
                    description: error message
                    title: get_characters_character_id_planets_planet_id_error
                    type: string
                title: get_characters_character_id_planets_planet_id_not_found
                type: object
              examples:
                response:
                  value:
                    error: Colony not found
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-planets.manage_planets.v1
      summary: EVE Online Get Colony Layout
      tags:
      - Planetary Interaction
      x-alternate-versions:
      - dev
      - v3
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /corporations/{corporation_id}/customs_offices/:
    get:
      description: 'List customs offices owned by a corporation


        ---

        Alternate route: `/dev/corporations/{corporation_id}/customs_offices/`


        Alternate route: `/legacy/corporations/{corporation_id}/customs_offices/`


        Alternate route: `/v1/corporations/{corporation_id}/customs_offices/`


        ---

        This route is cached for up to 3600 seconds


        ---

        Requires one of the following EVE corporation role(s): Director

        '
      operationId: get_corporations_corporation_id_customs_offices
      parameters:
      - $ref: '#/components/parameters/corporation_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of customs offices and their settings
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            X-Pages:
              description: Maximum page number
              schema:
                type: integer
                format: int32
                default: 1
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    alliance_tax_rate:
                      description: Only present if alliance access is allowed
                      format: float
                      title: get_corporations_corporation_id_customs_offices_alliance_tax_rate
                      type: number
                    allow_access_with_standings:
                      description: standing_level and any standing related tax rate only present when this is true
                      title: get_corporations_corporation_id_customs_offices_allow_access_with_standings
                      type: boolean
                    allow_alliance_access:
                      description: allow_alliance_access boolean
                      title: get_corporations_corporation_id_customs_offices_allow_alliance_access
                      type: boolean
                    bad_standing_tax_rate:
                      description: bad_standing_tax_rate number
                      format: float
                      title: get_corporations_corporation_id_customs_offices_bad_standing_tax_rate
                      type: number
                    corporation_tax_rate:
                      description: corporation_tax_rate number
                      format: float
                      title: get_corporations_corporation_id_customs_offices_corporation_tax_rate
                      type: number
                    excellent_standing_tax_rate:
                      description: Tax rate for entities with excellent level of standing, only present if this level is allowed, same for all other standing related tax rates
                      format: float
                      title: get_corporations_corporation_id_customs_offices_excellent_standing_tax_rate
                      type: number
                    good_standing_tax_rate:
                      description: good_standing_tax_rate number
                      format: float
                      title: get_corporations_corporation_id_customs_offices_good_standing_tax_rate
                      type: number
                    neutral_standing_tax_rate:
                      description: neutral_standing_tax_rate number
                      format: float
                      title: get_corporations_corporation_id_customs_offices_neutral_standing_tax_rate
                      type: number
                    office_id:
                      description: unique ID of this customs office
                      format: int64
                      title: get_corporations_corporation_id_customs_offices_office_id
                      type: integer
                    reinforce_exit_end:
                      description: reinforce_exit_end integer
                      format: int32
                      maximum: 23
                      minimum: 0
                      title: get_corporations_corporation_id_customs_offices_reinforce_exit_end
                      type: integer
                    reinforce_exit_start:
                      description: Together with reinforce_exit_end, marks a 2-hour period where this customs office could exit reinforcement mode during the day after initial attack
                      format: int32
                      maximum: 23
                      minimum: 0
                      title: get_corporations_corporation_id_customs_offices_reinforce_exit_start
                      type: integer
                    standing_level:
                      description: Access is allowed only for entities with this level of standing or better
                      enum:
                      - bad
                      - excellent
                      - good
                      - neutral
                      - terrible
                      title: get_corporations_corporation_id_customs_offices_standing_level
                      type: string
                    system_id:
                      description: ID of the solar system this customs office is located in
                      format: int32
                      title: get_corporations_corporation_id_customs_offices_system_id
                      type: integer
                    terrible_standing_tax_rate:
                      description: terrible_standing_tax_rate number
                      format: float
                      title: get_corporations_corporation_id_customs_offices_terrible_standing_tax_rate
                      type: number
                  required:
                  - office_id
                  - system_id
                  - reinforce_exit_start
                  - reinforce_exit_end
                  - allow_alliance_access
                  - allow_access_with_standings
                  title: get_corporations_corporation_id_customs_offices_200_ok
                  type: object
                maxItems: 1000
                title: get_corporations_corporation_id_customs_offices_ok
                type: array
              examples:
                response:
                  value:
                  - alliance_tax_rate: 0.1
                    allow_access_with_standings: true
                    allow_alliance_access: false
                    corporation_tax_rate: 0.02
                    excellent_standing_tax_rate: 0.05
                    good_standing_tax_rate: 0.2
                    neutral_standing_tax_rate: 0.5
                    office_id: 1000000014530
                    reinforce_exit_end: 1
                    reinforce_exit_start: 23
                    standing_level: neutral
                    system_id: 30003657
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
     

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eve-online/refs/heads/main/openapi/eve-online-planetary-interaction-api-openapi.yml