Class IMXClient

Hierarchy (view full)

Constructors

Properties

imxConfig: ImxConfiguration
assetApi: AssetsApi
balanceApi: BalancesApi
collectionApi: CollectionsApi
depositsApi: DepositsApi
encodingApi: EncodingApi
exchangeApi: ExchangesApi
metadataApi: MetadataApi
metadataRefreshesApi: MetadataRefreshesApi
mintsApi: MintsApi
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi
ordersApi: OrdersApi
projectsApi: ProjectsApi
tokensApi: TokensApi
tradesApi: TradesApi
transfersApi: TransfersApi
usersApi: UsersApi
withdrawalsApi: WithdrawalsApi
workflows: Workflows

Methods

  • Get details of a Deposit with the given ID

    Parameters

    Returns Promise<x.Deposit>

    a promise that resolves with the requested Deposit

    IMXError

  • Get Stark keys for a registered User

    Parameters

    • ethAddress: string

      the eth address of the User

    Returns Promise<GetUsersApiResponse>

    a promise that resolves with the requested User

    IMXError

  • Get details of an Asset

    Parameters

    Returns Promise<Asset>

    a promise that resolves with the requested Asset

    IMXError

  • Get a list of Assets

    Parameters

    Returns Promise<ListAssetsResponse>

    a promise that resolves with the requested list of Assets

    IMXError

  • Create a Collection

    Parameters

    Returns Promise<x.Collection>

    a promise that resolves with the created Collection

    IMXError

  • Get details of a Collection at the given address

    Parameters

    Returns Promise<x.Collection>

    a promise that resolves with the requested Collection

    IMXError

  • Update a Collection

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • collectionAddress: string

      the Collection contract address

    • request: UpdateCollectionRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<x.Collection>

    a promise that resolves with the updated Collection

    IMXError

  • Add metadata schema to Collection

    Parameters

    Returns Promise<SuccessResponse>

    a promise that resolves with the SuccessResponse if successful

    IMXError

  • Update metadata schema by name

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • collectionAddress: string

      the Collection contract address

    • name: string

      the Metadata schema name

    • request: MetadataSchemaRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<SuccessResponse>

    a promise that resolves with the SuccessResponse

    IMXError

  • Get a list of metadata refreshes

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • OptionalcollectionAddress: string

      the Collection contract address

    • OptionalpageSize: number

      the page size of the result

    • Optionalcursor: string

      the cursor

    Returns Promise<GetMetadataRefreshes>

    a promise that resolves with the requested metadata refreshes

    IMXError

  • Get a list of metadata refresh errors

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • refreshId: string

      the metadata refresh ID

    • OptionalpageSize: number

      the page size of the result

    • Optionalcursor: string

      the cursor

    Returns Promise<GetMetadataRefreshErrorsResponse>

    a promise that resolves with the requested metadata refresh errors

    IMXError

  • Get a list of metadata refresh results

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • refreshId: string

      the metadata refresh ID

    Returns Promise<GetMetadataRefreshResponse>

    a promise that resolves with the requested metadata refresh results

    IMXError

  • Get a Project

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • id: string

      the Project ID

    Returns Promise<Project>

    a promise that resolves with the requested Project

    IMXError

  • Get the token Balances of the User

    Parameters

    Returns Promise<Balance>

    a promise that resolves with the requested Balance

    IMXError

  • Get details of a Mint with the given ID

    Parameters

    • request: MintsApiGetMintRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<x.Mint[]>

    a promise that resolves with the requested Mint

    IMXError

  • Get a list of Mints

    Parameters

    Returns Promise<ListMintsResponse>

    a promise that resolves with the requested list of Mints

    IMXError

  • Mint tokens in a batch with fees

    Parameters

    Returns Promise<MintTokensResponse>

    a promise that resolves with the minted tokens

    IMXError

  • Get details of Withdrawal with the given ID

    Parameters

    Returns Promise<x.Withdrawal>

    a promise that resolves with the requested Withdrawal

    IMXError

  • Get details of an Order with the given ID

    Parameters

    Returns Promise<OrderV3>

    a promise that resolves with the requested Order

    IMXError

  • Get details of a Trade with the given ID

    Parameters

    Returns Promise<x.Trade>

    a promise that resolves with the requested Trade

    IMXError

  • Get a list of Trades

    Parameters

    Returns Promise<ListTradesResponse>

    a promise that resolves with the requested list of Trades

    IMXError

  • Get details of a Token

    Parameters

    Returns Promise<TokenDetails>

    a promise that resolves with the requested Token

    IMXError

  • Get a list of Tokens

    Parameters

    Returns Promise<ListTokensResponse>

    a promise that resolves with the requested list of Tokens

    IMXError

  • Get details of a Transfer with the given ID

    Parameters

    Returns Promise<x.Transfer>

    a promise that resolves with the requested Transfer

    IMXError

  • Get an Exchange transaction

    Parameters

    Returns Promise<Exchange>

    a promise that resolves with the Exchange Transaction

    IMXError