@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class MarketClient

    The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

    Hierarchy (View Summary)

    Index
    constructor
    api _client _endpoints
    streamEndpoint fetchAllEndpoint withMetadata withSafeMode getCharacterOrders getCharacterOrderHistory getCorporationOrders getCorporationOrderHistory getMarketHistory getMarketOrders getMarketTypes getMarketGroups getMarketGroupInformation getMarketPrices getMarketOrdersInStructure fetchAllMarketOrders fetchAllMarketTypes fetchAllCharacterOrderHistory fetchAllCorporationOrders fetchAllCorporationOrderHistory fetchAllMarketOrdersInStructure streamMarketOrders streamMarketTypes streamCharacterOrderHistory streamCorporationOrders streamCorporationOrderHistory streamMarketOrdersInStructure
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getCharacterOrders: {
            path: "characters/{characterId}/orders/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodOptional<ZodNumber>;
                        price: ZodNumber;
                        is_buy_order: ZodOptional<ZodBoolean>;
                        is_corporation: ZodBoolean;
                        region_id: ZodNumber;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                        escrow: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getCharacterOrderHistory: {
            path: "characters/{characterId}/orders/history/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodOptional<ZodNumber>;
                        price: ZodNumber;
                        is_buy_order: ZodOptional<ZodBoolean>;
                        is_corporation: ZodBoolean;
                        region_id: ZodNumber;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                        state: ZodType<
                            string & {}
                            | "cancelled"
                            | "expired",
                            unknown,
                            $ZodTypeInternals<string & {} | "cancelled" | "expired", unknown>,
                        >;
                        escrow: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationOrders: {
            path: "corporations/{corporationId}/orders/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodOptional<ZodNumber>;
                        price: ZodNumber;
                        is_buy_order: ZodOptional<ZodBoolean>;
                        issued_by: ZodNumber;
                        region_id: ZodNumber;
                        wallet_division: ZodNumber;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                        escrow: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationOrderHistory: {
            path: "corporations/{corporationId}/orders/history/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodOptional<ZodNumber>;
                        price: ZodNumber;
                        is_buy_order: ZodOptional<ZodBoolean>;
                        issued_by: ZodOptional<ZodNumber>;
                        region_id: ZodNumber;
                        wallet_division: ZodNumber;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                        state: ZodType<
                            string & {}
                            | "cancelled"
                            | "expired",
                            unknown,
                            $ZodTypeInternals<string & {} | "cancelled" | "expired", unknown>,
                        >;
                        escrow: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getMarketGroups: {
            path: "markets/groups/";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<ZodNumber>;
        };
        getMarketGroupInformation: {
            path: "markets/groups/{marketGroupId}/";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["marketGroupId"];
            responseSchema: ZodObject<
                {
                    market_group_id: ZodNumber;
                    name: ZodString;
                    description: ZodString;
                    types: ZodArray<ZodNumber>;
                    parent_group_id: ZodOptional<ZodNumber>;
                },
                $loose,
            >;
        };
        getMarketPrices: {
            path: "markets/prices/";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<
                ZodObject<
                    {
                        type_id: ZodNumber;
                        average_price: ZodOptional<ZodNumber>;
                        adjusted_price: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getMarketOrdersInStructure: {
            path: "markets/structures/{structureId}/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["structureId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodNumber;
                        price: ZodNumber;
                        is_buy_order: ZodBoolean;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                    },
                    $loose,
                >,
            >;
        };
        getMarketHistory: {
            path: "markets/{regionId}/history/";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["regionId"];
            queryParams: { typeId: "type_id" };
            responseSchema: ZodArray<
                ZodObject<
                    {
                        date: ZodString;
                        order_count: ZodNumber;
                        volume: ZodNumber;
                        highest: ZodNumber;
                        average: ZodNumber;
                        lowest: ZodNumber;
                    },
                    $loose,
                >,
            >;
        };
        getMarketOrders: {
            path: "markets/{regionId}/orders/";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["regionId"];
            queryParams: { orderType: "order_type" };
            responseSchema: ZodArray<
                ZodObject<
                    {
                        order_id: ZodNumber;
                        type_id: ZodNumber;
                        location_id: ZodNumber;
                        volume_total: ZodNumber;
                        volume_remain: ZodNumber;
                        min_volume: ZodNumber;
                        price: ZodNumber;
                        is_buy_order: ZodBoolean;
                        system_id: ZodNumber;
                        duration: ZodNumber;
                        issued: ZodString;
                        range: ZodString;
                    },
                    $loose,
                >,
            >;
        };
        getMarketTypes: {
            path: "markets/{regionId}/types/";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["regionId"];
            responseSchema: ZodArray<ZodNumber>;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCharacterOrders"
            | "getCharacterOrderHistory"
            | "getCorporationOrders"
            | "getCorporationOrderHistory"
            | "getMarketGroups"
            | "getMarketGroupInformation"
            | "getMarketPrices"
            | "getMarketOrdersInStructure"
            | "getMarketHistory"
            | "getMarketOrders"
            | "getMarketTypes"
      • ...args: unknown[]

      Returns AsyncGenerator<PageResult<R>, void, undefined>

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCharacterOrders"
            | "getCharacterOrderHistory"
            | "getCorporationOrders"
            | "getCorporationOrderHistory"
            | "getMarketGroups"
            | "getMarketGroupInformation"
            | "getMarketPrices"
            | "getMarketOrdersInStructure"
            | "getMarketHistory"
            | "getMarketOrders"
            | "getMarketTypes"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves all active market orders placed by a character.

      Parameters

      • characterId: number

        The ID of the character whose orders to fetch

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              is_corporation: boolean;
              region_id: number;
              duration: number;
              issued: string;
              range: string;
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

      A list of the character's open market orders

      Authentication

    • Retrieves the history of expired and cancelled market orders for a character.

      Parameters

      • characterId: number

        The ID of the character whose order history to fetch

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              is_corporation: boolean;
              region_id: number;
              duration: number;
              issued: string;
              range: string;
              state: string & {}
              | "cancelled"
              | "expired";
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

      A list of the character's historical market orders

      Authentication

    • Retrieves all active market orders placed by members of a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation whose orders to fetch

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              issued_by: number;
              region_id: number;
              wallet_division: number;
              duration: number;
              issued: string;
              range: string;
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

      A list of the corporation's open market orders

      Authentication

    • Retrieves the history of expired and cancelled market orders for a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation whose order history to fetch

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              issued_by?: number;
              region_id: number;
              wallet_division: number;
              duration: number;
              issued: string;
              range: string;
              state: string & {}
              | "cancelled"
              | "expired";
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

      A list of the corporation's historical market orders

      Authentication

    • Retrieves the daily price and volume history for a specific item type in a region.

      Parameters

      • regionId: number

        The ID of the region to fetch market history for

      • typeId: number

        The type ID of the item to get history for

      Returns Promise<
          {
              date: string;
              order_count: number;
              volume: number;
              highest: number;
              average: number;
              lowest: number;
              [key: string]: unknown;
          }[],
      >

      A list of daily market history entries with price and volume data

    • Retrieves all active market orders in a region for all item types.

      Parameters

      • regionId: number

        The ID of the region to fetch orders for

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume: number;
              price: number;
              is_buy_order: boolean;
              system_id: number;
              duration: number;
              issued: string;
              range: string;
              [key: string]: unknown;
          }[],
      >

      A list of all active market orders in the region

    • Retrieves the list of type IDs that have active market orders in a region.

      Parameters

      • regionId: number

        The ID of the region to check for active types

      Returns Promise<number[]>

      A list of type IDs with active orders in the region

    • Retrieves the list of all market group IDs used to categorize items on the market.

      Returns Promise<number[]>

      A list of all market group IDs

    • Retrieves detailed information about a specific market group, including its name, description, and contained types.

      Parameters

      • marketGroupId: number

        The ID of the market group to look up

      Returns Promise<
          {
              market_group_id: number;
              name: string;
              description: string;
              types: number[];
              parent_group_id?: number;
              [key: string]: unknown;
          },
      >

      The market group details including name, description, types, and optional parent group

    • Retrieves the global average and adjusted prices for all tradeable item types.

      Returns Promise<
          {
              type_id: number;
              average_price?: number;
              adjusted_price?: number;
              [key: string]: unknown;
          }[],
      >

      A list of item types with their average and adjusted market prices

    • Retrieves all active market orders listed in a specific player-owned structure.

      Parameters

      • structureId: number

        The ID of the structure to fetch orders for

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume: number;
              price: number;
              is_buy_order: boolean;
              duration: number;
              issued: string;
              range: string;
              [key: string]: unknown;
          }[],
      >

      A list of active market orders in the structure

      Authentication

    • Parameters

      • regionId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume: number;
              price: number;
              is_buy_order: boolean;
              system_id: number;
              duration: number;
              issued: string;
              range: string;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • regionId: number
      • Optionalconcurrency: number

      Returns Promise<number[]>

    • Parameters

      • characterId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              is_corporation: boolean;
              region_id: number;
              duration: number;
              issued: string;
              range: string;
              state: string & {}
              | "cancelled"
              | "expired";
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              issued_by: number;
              region_id: number;
              wallet_division: number;
              duration: number;
              issued: string;
              range: string;
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume?: number;
              price: number;
              is_buy_order?: boolean;
              issued_by?: number;
              region_id: number;
              wallet_division: number;
              duration: number;
              issued: string;
              range: string;
              state: string & {}
              | "cancelled"
              | "expired";
              escrow?: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • structureId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              order_id: number;
              type_id: number;
              location_id: number;
              volume_total: number;
              volume_remain: number;
              min_volume: number;
              price: number;
              is_buy_order: boolean;
              duration: number;
              issued: string;
              range: string;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • regionId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  order_id: number;
                  type_id: number;
                  location_id: number;
                  volume_total: number;
                  volume_remain: number;
                  min_volume: number;
                  price: number;
                  is_buy_order: boolean;
                  system_id: number;
                  duration: number;
                  issued: string;
                  range: string;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • characterId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  order_id: number;
                  type_id: number;
                  location_id: number;
                  volume_total: number;
                  volume_remain: number;
                  min_volume?: number;
                  price: number;
                  is_buy_order?: boolean;
                  is_corporation: boolean;
                  region_id: number;
                  duration: number;
                  issued: string;
                  range: string;
                  state: string & {}
                  | "cancelled"
                  | "expired";
                  escrow?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  order_id: number;
                  type_id: number;
                  location_id: number;
                  volume_total: number;
                  volume_remain: number;
                  min_volume?: number;
                  price: number;
                  is_buy_order?: boolean;
                  issued_by: number;
                  region_id: number;
                  wallet_division: number;
                  duration: number;
                  issued: string;
                  range: string;
                  escrow?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  order_id: number;
                  type_id: number;
                  location_id: number;
                  volume_total: number;
                  volume_remain: number;
                  min_volume?: number;
                  price: number;
                  is_buy_order?: boolean;
                  issued_by?: number;
                  region_id: number;
                  wallet_division: number;
                  duration: number;
                  issued: string;
                  range: string;
                  state: string & {}
                  | "cancelled"
                  | "expired";
                  escrow?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • structureId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  order_id: number;
                  type_id: number;
                  location_id: number;
                  volume_total: number;
                  volume_remain: number;
                  min_volume: number;
                  price: number;
                  is_buy_order: boolean;
                  duration: number;
                  issued: string;
                  range: string;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods