poe-js-sdk/dist/client/trade-client.d.ts

TypeScript SDK for the Path of Exile API

import { TradeSearchQuery, TradeSearchResponse, TradeFetchResponse, Realm } from '../types';
export interface TradeClientConfig {
    poesessid: string;
    userAgent?: string;
    baseURL?: string;
}
/**
 * UNOFFICIAL Trade API Client.
 *
 * WARNING: This uses website trade endpoints that are not part of the official PoE API.
 * They may change or break without notice. Requires a valid `POESESSID` cookie.
 *
 * - Set a compliant `User-Agent` (same format as official API)
 * - Respect rate limits and be considerate with usage
 */
export declare class TradeClient {
    private client;
    constructor(config: TradeClientConfig);
    /**
     * Search for items using trade search query
     * @param league League name (e.g., 'Standard', 'Hardcore')
     * @param query Trade search query
     * @param realm Realm ('pc', 'xbox', 'sony', 'poe2')
     * @see https://www.pathofexile.com/trade/search
     */
    search(league: string, query: TradeSearchQuery, realm?: Realm): Promise<TradeSearchResponse>;
    /**
     * Fetch item details by result IDs
     * @param resultIds Array of result IDs from search response
     * @param queryId Query ID from search response
     * @param realm Realm ('pc', 'xbox', 'sony', 'poe2')
     * @see https://www.pathofexile.com/trade/fetch
     */
    fetch(resultIds: string[], queryId: string): Promise<TradeFetchResponse>;
    /**
     * Search and fetch items in one call
     * @param league League name
     * @param query Trade search query
     * @param limit Maximum number of items to fetch (default: 10)
     * @param realm Realm ('pc', 'xbox', 'sony', 'poe2')
     */
    searchAndFetch(league: string, query: TradeSearchQuery, limit?: number, realm?: Realm): Promise<{
        search: TradeSearchResponse;
        items: TradeFetchResponse;
    }>;
    /**
     * Get whisper message for an item
     * @param itemId Item ID
     * @param queryId Query ID
     * @param realm Realm ('pc', 'xbox', 'sony', 'poe2')
     * @see https://www.pathofexile.com/trade/whisper
     */
    getWhisper(itemId: string, queryId: string): Promise<{
        whisper: string;
    }>;
}
//# sourceMappingURL=trade-client.d.ts.map