Class WalletClient

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)

BaseEsiClient<typeof walletEndpoints>
- WalletClient

Constructors

constructor

new WalletClient(client: ApiClient): WalletClient
Parameters
- client: ApiClient
Returns WalletClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/WalletClient.ts:12

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterWallet: {
        path: "characters/{characterId}/wallet";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodNumber;
    };
    getCharacterWalletJournal: {
        path: "characters/{characterId}/wallet/journal";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    id: ZodNumber;
                    date: ZodString;
                    ref_type: ZodString;
                    first_party_id: ZodOptional<ZodNumber>;
                    second_party_id: ZodOptional<ZodNumber>;
                    amount: ZodOptional<ZodNumber>;
                    balance: ZodOptional<ZodNumber>;
                    reason: ZodOptional<ZodString>;
                    description: ZodString;
                    context_id: ZodOptional<ZodNumber>;
                    context_id_type: ZodOptional<ZodString>;
                    tax: ZodOptional<ZodNumber>;
                    tax_receiver_id: ZodOptional<ZodNumber>;
                },
                $loose,
            >,
        >;
    };
    getCharacterWalletTransactions: {
        path: "characters/{characterId}/wallet/transactions";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    transaction_id: ZodNumber;
                    date: ZodString;
                    type_id: ZodNumber;
                    location_id: ZodNumber;
                    unit_price: ZodNumber;
                    quantity: ZodNumber;
                    client_id: ZodNumber;
                    is_buy: ZodBoolean;
                    is_personal: ZodBoolean;
                    journal_ref_id: ZodNumber;
                },
                $loose,
            >,
        >;
    };
    getCorporationWallets: {
        path: "corporations/{corporationId}/wallets";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<{ division: ZodNumber; balance: ZodNumber }, $loose>,
        >;
    };
    getCorporationWalletJournal: {
        path: "corporations/{corporationId}/wallets/{division}/journal";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "division"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    id: ZodNumber;
                    date: ZodString;
                    ref_type: ZodString;
                    first_party_id: ZodOptional<ZodNumber>;
                    second_party_id: ZodOptional<ZodNumber>;
                    amount: ZodOptional<ZodNumber>;
                    balance: ZodOptional<ZodNumber>;
                    reason: ZodOptional<ZodString>;
                    description: ZodString;
                    context_id: ZodOptional<ZodNumber>;
                    context_id_type: ZodOptional<ZodString>;
                    tax: ZodOptional<ZodNumber>;
                    tax_receiver_id: ZodOptional<ZodNumber>;
                },
                $loose,
            >,
        >;
    };
    getCorporationWalletTransactions: {
        path: "corporations/{corporationId}/wallets/{division}/transactions";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "division"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    transaction_id: ZodNumber;
                    date: ZodString;
                    type_id: ZodNumber;
                    location_id: ZodNumber;
                    unit_price: ZodNumber;
                    quantity: ZodNumber;
                    client_id: ZodNumber;
                    is_buy: ZodBoolean;
                    journal_ref_id: ZodNumber;
                },
                $loose,
            >,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getCharacterWallet"
        | "getCharacterWalletJournal"
        | "getCharacterWalletTransactions"
        | "getCorporationWallets"
        | "getCorporationWalletJournal"
        | "getCorporationWalletTransactions",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterWallet"
      | "getCharacterWalletJournal"
      | "getCharacterWalletTransactions"
      | "getCorporationWallets"
      | "getCorporationWalletJournal"
      | "getCorporationWalletTransactions"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCharacterWallet"
        | "getCharacterWalletJournal"
        | "getCharacterWalletTransactions"
        | "getCorporationWallets"
        | "getCorporationWalletJournal"
        | "getCorporationWalletTransactions",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterWallet"
      | "getCharacterWalletJournal"
      | "getCharacterWalletTransactions"
      | "getCorporationWallets"
      | "getCorporationWalletJournal"
      | "getCorporationWalletTransactions"
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
Inherited from BaseEsiClient.fetchAllEndpoint
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withMetadata
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withSafeMode
- Defined in src/clients/BaseEsiClient.ts:110

getCharacterWallet

getCharacterWallet(characterId: number): Promise<number>
Retrieves the current ISK balance of a character's wallet.
Parameters
- characterId: number
  The ID of the character
Returns Promise<number>
The character's wallet balance in ISK

Requires
Authentication
- Defined in src/clients/WalletClient.ts:23

getCharacterWalletJournal

getCharacterWalletJournal(
    characterId: number,
): Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
Retrieves the wallet journal entries for a character, showing ISK transactions and their reasons.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
A list of wallet journal entries

Requires
Authentication
- Defined in src/clients/WalletClient.ts:34

getCharacterWalletTransactions

getCharacterWalletTransactions(
    characterId: number,
): Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        is_personal: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
Retrieves the market transaction history for a character's wallet.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        is_personal: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
A list of market buy and sell transactions

Requires
Authentication
- Defined in src/clients/WalletClient.ts:45

getCorporationWallets

getCorporationWallets(
corporationId: number,
): Promise<{ division: number; balance: number }[]>
Retrieves the balances for all wallet divisions of a corporation.
Parameters
- corporationId: number
  The ID of the corporation
Returns Promise<{ division: number; balance: number }[]>
A list of wallet divisions with their balances

Requires
Authentication
- Defined in src/clients/WalletClient.ts:58

getCorporationWalletJournal

getCorporationWalletJournal(
    corporationId: number,
    division: number,
): Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
Retrieves the wallet journal entries for a specific division of a corporation wallet.
Parameters
- corporationId: number
  The ID of the corporation
- division: number
  The wallet division number (1-7)
Returns Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
A list of wallet journal entries for the specified division

Requires
Authentication
- Defined in src/clients/WalletClient.ts:72

getCorporationWalletTransactions

getCorporationWalletTransactions(
    corporationId: number,
    division: number,
): Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
Retrieves the market transaction history for a specific division of a corporation wallet.
Parameters
- corporationId: number
  The ID of the corporation
- division: number
  The wallet division number (1-7)
Returns Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
A list of market buy and sell transactions for the specified division

Requires
Authentication
- Defined in src/clients/WalletClient.ts:87

fetchAllCharacterWalletJournal

fetchAllCharacterWalletJournal(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/WalletClient.ts:94

fetchAllCorporationWalletJournal

fetchAllCorporationWalletJournal(
    corporationId: number,
    division: number,
    concurrency?: number,
): Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- division: number
- Optionalconcurrency: number
Returns Promise<
    {
        id: number;
        date: string;
        ref_type: string;
        first_party_id?: number;
        second_party_id?: number;
        amount?: number;
        balance?: number;
        reason?: string;
        description: string;
        context_id?: number;
        context_id_type?: string;
        tax?: number;
        tax_receiver_id?: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/WalletClient.ts:105

fetchAllCharacterWalletTransactions

fetchAllCharacterWalletTransactions(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        is_personal: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        is_personal: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/WalletClient.ts:117

fetchAllCorporationWalletTransactions

fetchAllCorporationWalletTransactions(
    corporationId: number,
    division: number,
    concurrency?: number,
): Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- division: number
- Optionalconcurrency: number
Returns Promise<
    {
        transaction_id: number;
        date: string;
        type_id: number;
        location_id: number;
        unit_price: number;
        quantity: number;
        client_id: number;
        is_buy: boolean;
        journal_ref_id: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/WalletClient.ts:128

streamCharacterWalletJournal

streamCharacterWalletJournal(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            id: number;
            date: string;
            ref_type: string;
            first_party_id?: number;
            second_party_id?: number;
            amount?: number;
            balance?: number;
            reason?: string;
            description: string;
            context_id?: number;
            context_id_type?: string;
            tax?: number;
            tax_receiver_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            id: number;
            date: string;
            ref_type: string;
            first_party_id?: number;
            second_party_id?: number;
            amount?: number;
            balance?: number;
            reason?: string;
            description: string;
            context_id?: number;
            context_id_type?: string;
            tax?: number;
            tax_receiver_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/WalletClient.ts:140

streamCorporationWalletJournal

streamCorporationWalletJournal(
    corporationId: number,
    division: number,
): AsyncGenerator<
    PageResult<
        {
            id: number;
            date: string;
            ref_type: string;
            first_party_id?: number;
            second_party_id?: number;
            amount?: number;
            balance?: number;
            reason?: string;
            description: string;
            context_id?: number;
            context_id_type?: string;
            tax?: number;
            tax_receiver_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
- division: number
Returns AsyncGenerator<
    PageResult<
        {
            id: number;
            date: string;
            ref_type: string;
            first_party_id?: number;
            second_party_id?: number;
            amount?: number;
            balance?: number;
            reason?: string;
            description: string;
            context_id?: number;
            context_id_type?: string;
            tax?: number;
            tax_receiver_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/WalletClient.ts:149

streamCharacterWalletTransactions

streamCharacterWalletTransactions(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            transaction_id: number;
            date: string;
            type_id: number;
            location_id: number;
            unit_price: number;
            quantity: number;
            client_id: number;
            is_buy: boolean;
            is_personal: boolean;
            journal_ref_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            transaction_id: number;
            date: string;
            type_id: number;
            location_id: number;
            unit_price: number;
            quantity: number;
            client_id: number;
            is_buy: boolean;
            is_personal: boolean;
            journal_ref_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/WalletClient.ts:160

streamCorporationWalletTransactions

streamCorporationWalletTransactions(
    corporationId: number,
    division: number,
): AsyncGenerator<
    PageResult<
        {
            transaction_id: number;
            date: string;
            type_id: number;
            location_id: number;
            unit_price: number;
            quantity: number;
            client_id: number;
            is_buy: boolean;
            journal_ref_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
- division: number
Returns AsyncGenerator<
    PageResult<
        {
            transaction_id: number;
            date: string;
            type_id: number;
            location_id: number;
            unit_price: number;
            quantity: number;
            client_id: number;
            is_buy: boolean;
            journal_ref_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/WalletClient.ts:169

Class WalletClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WalletClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

streamEndpoint

Type Parameters

Parameters

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

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

getCharacterWallet

Parameters

Returns Promise<number>

Requires

getCharacterWalletJournal

Parameters

Requires

getCharacterWalletTransactions

Parameters

Returns Promise< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; is_personal: boolean; journal_ref_id: number; [key: string]: unknown; }[],>

Requires

getCorporationWallets

Parameters

Returns Promise<{ division: number; balance: number }[]>

Requires

getCorporationWalletJournal

Parameters

Requires

getCorporationWalletTransactions

Parameters

Returns Promise< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; journal_ref_id: number; [key: string]: unknown; }[],>

Requires

fetchAllCharacterWalletJournal

Parameters

fetchAllCorporationWalletJournal

Parameters

fetchAllCharacterWalletTransactions

Parameters

Returns Promise< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; is_personal: boolean; journal_ref_id: number; [key: string]: unknown; }[],>

fetchAllCorporationWalletTransactions

Parameters

Returns Promise< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; journal_ref_id: number; [key: string]: unknown; }[],>

streamCharacterWalletJournal

Parameters

streamCorporationWalletJournal

Parameters

streamCharacterWalletTransactions

Parameters

Returns AsyncGenerator< PageResult< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; is_personal: boolean; journal_ref_id: number; [key: string]: unknown; }, >, void, undefined,>

streamCorporationWalletTransactions

Parameters

Returns AsyncGenerator< PageResult< { transaction_id: number; date: string; type_id: number; location_id: number; unit_price: number; quantity: number; client_id: number; is_buy: boolean; journal_ref_id: number; [key: string]: unknown; }, >, void, undefined,>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
is_personal: boolean;
journal_ref_id: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
journal_ref_id: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
is_personal: boolean;
journal_ref_id: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
journal_ref_id: number;
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
is_personal: boolean;
journal_ref_id: number;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
transaction_id: number;
date: string;
type_id: number;
location_id: number;
unit_price: number;
quantity: number;
client_id: number;
is_buy: boolean;
journal_ref_id: number;
[key: string]: unknown;
},
>,
void,
undefined,
>