EVE Online Market API

The Market API from EVE Online — 22 operation(s) for market.

OpenAPI Specification

eve-online-market-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Market API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Market
paths:
  /characters/{character_id}/orders/:
    get:
      description: 'List open market orders placed by a character


        ---

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


        Alternate route: `/v2/characters/{character_id}/orders/`


        ---

        This route is cached for up to 1200 seconds'
      operationId: get_characters_character_id_orders
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: Open market orders placed by a character
          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:
                    duration:
                      description: Number of days for which order is valid (starting from the issued date). An order expires at time issued + duration
                      format: int32
                      title: get_characters_character_id_orders_duration
                      type: integer
                    escrow:
                      description: For buy orders, the amount of ISK in escrow
                      format: double
                      title: get_characters_character_id_orders_escrow
                      type: number
                    is_buy_order:
                      description: True if the order is a bid (buy) order
                      title: get_characters_character_id_orders_is_buy_order
                      type: boolean
                    is_corporation:
                      description: Signifies whether the buy/sell order was placed on behalf of a corporation.
                      title: get_characters_character_id_orders_is_corporation
                      type: boolean
                    issued:
                      description: Date and time when this order was issued
                      format: date-time
                      title: get_characters_character_id_orders_issued
                      type: string
                    location_id:
                      description: ID of the location where order was placed
                      format: int64
                      title: get_characters_character_id_orders_location_id
                      type: integer
                    min_volume:
                      description: For buy orders, the minimum quantity that will be accepted in a matching sell order
                      format: int32
                      title: get_characters_character_id_orders_min_volume
                      type: integer
                    order_id:
                      description: Unique order ID
                      format: int64
                      title: get_characters_character_id_orders_order_id
                      type: integer
                    price:
                      description: Cost per unit for this order
                      format: double
                      title: get_characters_character_id_orders_price
                      type: number
                    range:
                      description: Valid order range, numbers are ranges in jumps
                      enum:
                      - '1'
                      - '10'
                      - '2'
                      - '20'
                      - '3'
                      - '30'
                      - '4'
                      - '40'
                      - '5'
                      - region
                      - solarsystem
                      - station
                      title: get_characters_character_id_orders_range
                      type: string
                    region_id:
                      description: ID of the region where order was placed
                      format: int32
                      title: get_characters_character_id_orders_region_id
                      type: integer
                    type_id:
                      description: The type ID of the item transacted in this order
                      format: int32
                      title: get_characters_character_id_orders_type_id
                      type: integer
                    volume_remain:
                      description: Quantity of items still required or offered
                      format: int32
                      title: get_characters_character_id_orders_volume_remain
                      type: integer
                    volume_total:
                      description: Quantity of items required or offered at time order was placed
                      format: int32
                      title: get_characters_character_id_orders_volume_total
                      type: integer
                  required:
                  - is_corporation
                  - duration
                  - order_id
                  - type_id
                  - region_id
                  - location_id
                  - range
                  - price
                  - volume_total
                  - volume_remain
                  - issued
                  title: get_characters_character_id_orders_200_ok
                  type: object
                maxItems: 305
                title: get_characters_character_id_orders_ok
                type: array
              examples:
                response:
                  value:
                  - duration: 30
                    escrow: 45.6
                    is_buy_order: true
                    is_corporation: false
                    issued: 2016-09-03 05:12:25+00:00
                    location_id: 456
                    min_volume: 1
                    order_id: 123
                    price: 33.3
                    range: station
                    region_id: 123
                    type_id: 456
                    volume_remain: 4422
                    volume_total: 123456
        '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-markets.read_character_orders.v1
      summary: EVE Online List Open Orders from a Character
      tags:
      - Market
      x-alternate-versions:
      - dev
      - v2
      x-cached-seconds: 1200
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/orders/history/:
    get:
      description: 'List cancelled and expired market orders placed by a character up to 90 days in the past.


        ---

        Alternate route: `/dev/characters/{character_id}/orders/history/`


        Alternate route: `/legacy/characters/{character_id}/orders/history/`


        Alternate route: `/v1/characters/{character_id}/orders/history/`


        ---

        This route is cached for up to 3600 seconds'
      operationId: get_characters_character_id_orders_history
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: Expired and cancelled market orders placed by a character
          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:
                    duration:
                      description: Number of days the order was valid for (starting from the issued date). An order expires at time issued + duration
                      format: int32
                      title: get_characters_character_id_orders_history_duration
                      type: integer
                    escrow:
                      description: For buy orders, the amount of ISK in escrow
                      format: double
                      title: get_characters_character_id_orders_history_escrow
                      type: number
                    is_buy_order:
                      description: True if the order is a bid (buy) order
                      title: get_characters_character_id_orders_history_is_buy_order
                      type: boolean
                    is_corporation:
                      description: Signifies whether the buy/sell order was placed on behalf of a corporation.
                      title: get_characters_character_id_orders_history_is_corporation
                      type: boolean
                    issued:
                      description: Date and time when this order was issued
                      format: date-time
                      title: get_characters_character_id_orders_history_issued
                      type: string
                    location_id:
                      description: ID of the location where order was placed
                      format: int64
                      title: get_characters_character_id_orders_history_location_id
                      type: integer
                    min_volume:
                      description: For buy orders, the minimum quantity that will be accepted in a matching sell order
                      format: int32
                      title: get_characters_character_id_orders_history_min_volume
                      type: integer
                    order_id:
                      description: Unique order ID
                      format: int64
                      title: get_characters_character_id_orders_history_order_id
                      type: integer
                    price:
                      description: Cost per unit for this order
                      format: double
                      title: get_characters_character_id_orders_history_price
                      type: number
                    range:
                      description: Valid order range, numbers are ranges in jumps
                      enum:
                      - '1'
                      - '10'
                      - '2'
                      - '20'
                      - '3'
                      - '30'
                      - '4'
                      - '40'
                      - '5'
                      - region
                      - solarsystem
                      - station
                      title: get_characters_character_id_orders_history_range
                      type: string
                    region_id:
                      description: ID of the region where order was placed
                      format: int32
                      title: get_characters_character_id_orders_history_region_id
                      type: integer
                    state:
                      description: Current order state
                      enum:
                      - cancelled
                      - expired
                      title: get_characters_character_id_orders_history_state
                      type: string
                    type_id:
                      description: The type ID of the item transacted in this order
                      format: int32
                      title: get_characters_character_id_orders_history_type_id
                      type: integer
                    volume_remain:
                      description: Quantity of items still required or offered
                      format: int32
                      title: get_characters_character_id_orders_history_volume_remain
                      type: integer
                    volume_total:
                      description: Quantity of items required or offered at time order was placed
                      format: int32
                      title: get_characters_character_id_orders_history_volume_total
                      type: integer
                  required:
                  - is_corporation
                  - duration
                  - state
                  - order_id
                  - type_id
                  - region_id
                  - location_id
                  - range
                  - price
                  - volume_total
                  - volume_remain
                  - issued
                  title: get_characters_character_id_orders_history_200_ok
                  type: object
                maxItems: 1000
                title: get_characters_character_id_orders_history_ok
                type: array
              examples:
                response:
                  value:
                  - duration: 30
                    escrow: 45.6
                    is_buy_order: true
                    is_corporation: false
                    issued: 2016-09-03 05:12:25+00:00
                    location_id: 456
                    min_volume: 1
                    order_id: 123
                    price: 33.3
                    range: station
                    region_id: 123
                    state: expired
                    type_id: 456
                    volume_remain: 4422
                    volume_total: 123456
        '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-markets.read_character_orders.v1
      summary: EVE Online List Historical Orders by a Character
      tags:
      - Market
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 3600
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /corporations/{corporation_id}/orders/:
    get:
      description: 'List open market orders placed on behalf of a corporation


        ---

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


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


        Alternate route: `/v2/corporations/{corporation_id}/orders/`


        Alternate route: `/v3/corporations/{corporation_id}/orders/`


        ---

        This route is cached for up to 1200 seconds


        ---

        Requires one of the following EVE corporation role(s): Accountant, Trader

        '
      operationId: get_corporations_corporation_id_orders
      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 open market orders
          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:
                    duration:
                      description: Number of days for which order is valid (starting from the issued date). An order expires at time issued + duration
                      format: int32
                      title: get_corporations_corporation_id_orders_duration
                      type: integer
                    escrow:
                      description: For buy orders, the amount of ISK in escrow
                      format: double
                      title: get_corporations_corporation_id_orders_escrow
                      type: number
                    is_buy_order:
                      description: True if the order is a bid (buy) order
                      title: get_corporations_corporation_id_orders_is_buy_order
                      type: boolean
                    issued:
                      description: Date and time when this order was issued
                      format: date-time
                      title: get_corporations_corporation_id_orders_issued
                      type: string
                    issued_by:
                      description: The character who issued this order
                      format: int32
                      title: get_corporations_corporation_id_orders_issued_by
                      type: integer
                    location_id:
                      description: ID of the location where order was placed
                      format: int64
                      title: get_corporations_corporation_id_orders_location_id
                      type: integer
                    min_volume:
                      description: For buy orders, the minimum quantity that will be accepted in a matching sell order
                      format: int32
                      title: get_corporations_corporation_id_orders_min_volume
                      type: integer
                    order_id:
                      description: Unique order ID
                      format: int64
                      title: get_corporations_corporation_id_orders_order_id
                      type: integer
                    price:
                      description: Cost per unit for this order
                      format: double
                      title: get_corporations_corporation_id_orders_price
                      type: number
                    range:
                      description: Valid order range, numbers are ranges in jumps
                      enum:
                      - '1'
                      - '10'
                      - '2'
                      - '20'
                      - '3'
                      - '30'
                      - '4'
                      - '40'
                      - '5'
                      - region
                      - solarsystem
                      - station
                      title: get_corporations_corporation_id_orders_range
                      type: string
                    region_id:
                      description: ID of the region where order was placed
                      format: int32
                      title: get_corporations_corporation_id_orders_region_id
                      type: integer
                    type_id:
                      description: The type ID of the item transacted in this order
                      format: int32
                      title: get_corporations_corporation_id_orders_type_id
                      type: integer
                    volume_remain:
                      description: Quantity of items still required or offered
                      format: int32
                      title: get_corporations_corporation_id_orders_volume_remain
                      type: integer
                    volume_total:
                      description: Quantity of items required or offered at time order was placed
                      format: int32
                      title: get_corporations_corporation_id_orders_volume_total
                      type: integer
                    wallet_division:
                      description: The corporation wallet division used for this order.
                      format: int32
                      maximum: 7
                      minimum: 1
                      title: get_corporations_corporation_id_orders_wallet_division
                      type: integer
                  required:
                  - duration
                  - wallet_division
                  - order_id
                  - type_id
                  - region_id
                  - location_id
                  - range
                  - price
                  - volume_total
                  - volume_remain
                  - issued
                  - issued_by
                  title: get_corporations_corporation_id_orders_200_ok
                  type: object
                maxItems: 1000
                title: get_corporations_corporation_id_orders_ok
                type: array
              examples:
                response:
                  value:
                  - duration: 30
                    escrow: 45.6
                    is_buy_order: true
                    issued: 2016-09-03 05:12:25+00:00
                    issued_by: 2112625428
                    location_id: 456
                    min_volume: 1
                    order_id: 123
                    price: 33.3
                    range: station
                    region_id: 123
                    type_id: 456
                    volume_remain: 4422
                    volume_total: 123456
                    wallet_division: 1
        '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-markets.read_corporation_orders.v1
      summary: EVE Online List Open Orders from a Corporation
      tags:
      - Market
      x-alternate-versions:
      - dev
      - legacy
      - v2
      - v3
      x-cached-seconds: 1200
      x-required-roles:
      - Accountant
      - Trader
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /corporations/{corporation_id}/orders/history/:
    get:
      description: 'List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.


        ---

        Alternate route: `/dev/corporations/{corporation_id}/orders/history/`


        Alternate route: `/legacy/corporations/{corporation_id}/orders/history/`


        Alternate route: `/v1/corporations/{corporation_id}/orders/history/`


        Alternate route: `/v2/corporations/{corporation_id}/orders/history/`


        ---

        This route is cached for up to 3600 seconds


        ---

        Requires one of the following EVE corporation role(s): Accountant, Trader

        '
      operationId: get_corporations_corporation_id_orders_history
      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: Expired and cancelled market orders placed on behalf of a corporation
          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:
          

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