Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InventoriesApi

Hierarchy

  • InventoriesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new InventoriesApi(configuration: Configuration, requestFactory?: InventoriesApiRequestFactory, responseProcessor?: InventoriesApiResponseProcessor): InventoriesApi

Properties

Private api

api: ObservableInventoriesApi

Methods

getAccountCryptoCurrencyInventory

  • For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Retrieves the cryptocurrency assets of an existing account.

    Parameters

    • id: string

      Specifies the unique account ID.

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional contractId: string[]
    • Optional _options: Configuration

    Returns Promise<InventoryListResponse>

getAccountNativeInventory

getAccountNftInventory

  • For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Retrieves the NFT assets of an existing account.

    Parameters

    • id: string

      Specifies the unique account ID.

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional contractId: string[]
    • Optional _options: Configuration

    Returns Promise<InventoryListResponse>

getPlayerCryptoCurrencyInventory

  • For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Get cryptocurrency list of player.

    Parameters

    • id: string

      Specifies the unique player ID (starts with pla_).

    • chainId: number

      Filter by chain id.

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional contract: string[]

      Filter by contract ID (starts with con_).

    • Optional _options: Configuration

    Returns Promise<InventoryListResponse>

getPlayerNativeInventory

  • For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Get native token list of player.

    Parameters

    • id: string

      Specifies the unique player ID (starts with pla_).

    • chainId: number

      Filter by chain id.

    • Optional _options: Configuration

    Returns Promise<InventoryResponse>

getPlayerNftInventory

  • For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Get NFTs list of player.

    Parameters

    • id: string

      Specifies the unique player ID (starts with pla_).

    • chainId: number

      Filter by chain id.

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional contract: string[]

      Filter by contract ID (starts with con_).

    • Optional _options: Configuration

    Returns Promise<InventoryListResponse>

Generated using TypeDoc