Class MarketEndpoint

Access the Market API endpoints

Index

Constructors

Methods

auctionhouse bazaar get lookup timestamp withId withPropertyTypeId

Constructors

constructor

new MarketEndpoint(requester: Requester): MarketEndpoint
Parameters
- requester: Requester
Returns MarketEndpoint
- Defined in src/generated/endpoints/market.ts:29

Methods

auctionhouse

auctionhouse(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
        to?: number;
    },
): Promise<PaginatedResponse<AuctionHouseResponse> & AuctionHouseResponse>
Get auction house listings
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<AuctionHouseResponse> & AuctionHouseResponse>
- Defined in src/generated/endpoints/market.ts:42

bazaar

bazaar(
    params?: {
        cat?: MarketSpecializedBazaarCategoryEnum;
        timestamp?: string | number;
    },
): Promise<BazaarResponse>
Get bazaar directory
Parameters
- Optionalparams: { cat?: MarketSpecializedBazaarCategoryEnum; timestamp?: string | number }
  Optional query parameters
Returns Promise<BazaarResponse>
- Defined in src/generated/endpoints/market.ts:64

get

get(
    params?: {
        bonus?: WeaponBonusEnum;
        cat?: MarketSpecializedBazaarCategoryEnum;
        id?: number;
        legacy?: string[];
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
    },
): Promise<MarketResponse>
Get any Market selection
Parameters
- Optionalparams: {
      bonus?: WeaponBonusEnum;
      cat?: MarketSpecializedBazaarCategoryEnum;
      id?: number;
      legacy?: string[];
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<MarketResponse>
- Defined in src/generated/endpoints/market.ts:108

lookup

lookup(params?: { timestamp?: string | number }): Promise<MarketLookupResponse>
Get all available market selections
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<MarketLookupResponse>
- Defined in src/generated/endpoints/market.ts:80

timestamp

timestamp(params?: { timestamp?: string | number }): Promise<TimestampResponse>
Get current server time
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<TimestampResponse>
- Defined in src/generated/endpoints/market.ts:94

withId

withId(id: string | number): MarketIdContext
Parameters
- id: string | number
  The ID for this context
Returns MarketIdContext
- Defined in src/generated/endpoints/market.ts:34

withPropertyTypeId

withPropertyTypeId(propertyTypeId: string | number): MarketPropertyTypeIdContext
Parameters
- propertyTypeId: string | number
  The ID for this context
Returns MarketPropertyTypeIdContext
- Defined in src/generated/endpoints/market.ts:135