Class ImmutableX

imxConfig

assetApi

balanceApi

collectionApi

depositsApi

encodingApi

exchangeApi

metadataApi

metadataRefreshesApi

mintsApi

nftCheckoutPrimaryApi

ordersApi

primarySalesApi

projectsApi

tokensApi

tradesApi

transfersApi

usersApi

withdrawalsApi

workflows

getDeposit

• getDeposit(request): Promise<x.Deposit>

• Get details of a Deposit with the given ID

  Parameters

  • request: DepositsApiGetDepositRequest

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

  Returns Promise<x.Deposit>

  a promise that resolves with the requested Deposit

  Throws

  IMXError

listDeposits

• listDeposits(request?): Promise<ListDepositsResponse>

• Get a list of Deposits

  Parameters

  • Optionalrequest: DepositsApiListDepositsRequest

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

  Returns Promise<ListDepositsResponse>

  a promise that resolves with the requested list of Deposits

  Throws

  IMXError

getUser

• getUser(ethAddress): Promise<GetUsersApiResponse>

• 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

  Throws

  IMXError

getAsset

• getAsset(request): Promise<Asset>

• Get details of an Asset

  Parameters

  • request: AssetsApiGetAssetRequest

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

  Returns Promise<Asset>

  a promise that resolves with the requested Asset

  Throws

  IMXError

listAssets

• listAssets(request?): Promise<ListAssetsResponse>

• Get a list of Assets

  Parameters

  • Optionalrequest: AssetsApiListAssetsRequest

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

  Returns Promise<ListAssetsResponse>

  a promise that resolves with the requested list of Assets

  Throws

  IMXError

createCollection

• createCollection(ethSigner, request): Promise<x.Collection>

• Create a Collection

  Parameters

  • ethSigner: EthSigner

    the L1 signer
  • request: CreateCollectionRequest

    the request object to be provided in the API request

  Returns Promise<x.Collection>

  a promise that resolves with the created Collection

  Throws

  IMXError

getCollection

• getCollection(request): Promise<x.Collection>

• Get details of a Collection at the given address

  Parameters

  • request: CollectionsApiGetCollectionRequest

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

  Returns Promise<x.Collection>

  a promise that resolves with the requested Collection

  Throws

  IMXError

listCollectionFilters

• listCollectionFilters(request): Promise<CollectionFilter[]>

• Get a list of Collection filters

  Parameters

  • request: CollectionsApiListCollectionFiltersRequest

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

  Returns Promise<CollectionFilter[]>

  a promise that resolves with the requested list of Collection Filters

  Throws

  IMXError

listCollections

• listCollections(request?): Promise<ListCollectionsResponse>

• Get a list of Collections

  Parameters

  • Optionalrequest: CollectionsApiListCollectionsRequest

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

  Returns Promise<ListCollectionsResponse>

  a promise that resolves with the requested list of Collections

  Throws

  IMXError

updateCollection

• updateCollection(ethSigner, collectionAddress, request): Promise<x.Collection>

• 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

  Throws

  IMXError

addMetadataSchemaToCollection

• addMetadataSchemaToCollection(ethSigner, collectionAddress, request): Promise<SuccessResponse>

• Add metadata schema to Collection

  Parameters

  • ethSigner: EthSigner

    the L1 signer
  • collectionAddress: string

    the Collection contract address
  • request: AddMetadataSchemaToCollectionRequest

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

  Returns Promise<SuccessResponse>

  a promise that resolves with the SuccessResponse if successful

  Throws

  IMXError

getMetadataSchema

• getMetadataSchema(request): Promise<MetadataSchemaProperty[]>

• Get Metadata schema

  Parameters

  • request: MetadataApiGetMetadataSchemaRequest

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

  Returns Promise<MetadataSchemaProperty[]>

  a promise that resolves with the requested Metadata schema

  Throws

  IMXError

updateMetadataSchemaByName

• updateMetadataSchemaByName(ethSigner, collectionAddress, name, request): Promise<SuccessResponse>

• 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

  Throws

  IMXError

listMetadataRefreshes

• listMetadataRefreshes(ethSigner, collectionAddress?, pageSize?, cursor?): Promise<GetMetadataRefreshes>

• 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

  Throws

  IMXError

getMetadataRefreshErrors

• getMetadataRefreshErrors(ethSigner, refreshId, pageSize?, cursor?): Promise<GetMetadataRefreshErrorsResponse>

• 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

  Throws

  IMXError

getMetadataRefreshResults

• getMetadataRefreshResults(ethSigner, refreshId): Promise<GetMetadataRefreshResponse>

• 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

  Throws

  IMXError

createMetadataRefresh

• createMetadataRefresh(ethSigner, request): Promise<CreateMetadataRefreshResponse>

• Request a metadata refresh

  Parameters

  • ethSigner: EthSigner

    the L1 signer
  • request: CreateMetadataRefreshRequest

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

  Returns Promise<CreateMetadataRefreshResponse>

  a promise that resolves with the requested metadata refresh

  Throws

  IMXError

getProject

• getProject(ethSigner, id): Promise<Project>

• 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

  Throws

  IMXError

getBalance

• getBalance(request): Promise<Balance>

• Get the token Balances of the User

  Parameters

  • request: BalancesApiGetBalanceRequest

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

  Returns Promise<Balance>

  a promise that resolves with the requested Balance

  Throws

  IMXError

listBalances

• listBalances(request): Promise<ListBalancesResponse>

• Get a list of Balances for given User

  Parameters

  • request: BalancesApiListBalancesRequest

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

  Returns Promise<ListBalancesResponse>

  a promise that resolves with the requested list of Balances

  Throws

  IMXError

getMint

• getMint(request): Promise<x.Mint[]>

• 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

  Throws

  IMXError

listMints

• listMints(request?): Promise<ListMintsResponse>

• Get a list of Mints

  Parameters

  • Optionalrequest: MintsApiListMintsRequest

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

  Returns Promise<ListMintsResponse>

  a promise that resolves with the requested list of Mints

  Throws

  IMXError

mint

• mint(ethSigner, request): Promise<MintTokensResponse>

• Mint tokens in a batch with fees

  Parameters

  • ethSigner: EthSigner

    the L1 signer
  • request: UnsignedMintRequest

    the request object to be provided in the API request

  Returns Promise<MintTokensResponse>

  a promise that resolves with the minted tokens

  Throws

  IMXError

listWithdrawals

• listWithdrawals(request?): Promise<ListWithdrawalsResponse>

• Get a list of Withdrawals

  Parameters

  • Optionalrequest: WithdrawalsApiListWithdrawalsRequest

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

  Returns Promise<ListWithdrawalsResponse>

  a promise that resolves with the requested list of Withdrawals

  Throws

  IMXError

getWithdrawal

• getWithdrawal(request): Promise<x.Withdrawal>

• Get details of Withdrawal with the given ID

  Parameters

  • request: WithdrawalsApiGetWithdrawalRequest

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

  Returns Promise<x.Withdrawal>

  a promise that resolves with the requested Withdrawal

  Throws

  IMXError

getOrder

• getOrder(request): Promise<OrderV3>

• Get details of an Order with the given ID

  Parameters

  • request: OrdersApiGetOrderV3Request

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

  Returns Promise<OrderV3>

  a promise that resolves with the requested Order

  Throws

  IMXError

listOrders

• listOrders(request?): Promise<ListOrdersResponseV3>

• Get a list of Orders

  Parameters

  • Optionalrequest: OrdersApiListOrdersV3Request

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

  Returns Promise<ListOrdersResponseV3>

  a promise that resolves with the requested list of Orders

  Throws

  IMXError

getTrade

• getTrade(request): Promise<x.Trade>

• Get details of a Trade with the given ID

  Parameters

  • request: TradesApiGetTradeV3Request

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

  Returns Promise<x.Trade>

  a promise that resolves with the requested Trade

  Throws

  IMXError

listTrades

• listTrades(request?): Promise<ListTradesResponse>

• Get a list of Trades

  Parameters

  • Optionalrequest: TradesApiListTradesV3Request

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

  Returns Promise<ListTradesResponse>

  a promise that resolves with the requested list of Trades

  Throws

  IMXError

getToken

• getToken(request): Promise<TokenDetails>

• Get details of a Token

  Parameters

  • request: TokensApiGetTokenRequest

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

  Returns Promise<TokenDetails>

  a promise that resolves with the requested Token

  Throws

  IMXError

listTokens

• listTokens(request?): Promise<ListTokensResponse>

• Get a list of Tokens

  Parameters

  • Optionalrequest: TokensApiListTokensRequest

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

  Returns Promise<ListTokensResponse>

  a promise that resolves with the requested list of Tokens

  Throws

  IMXError

getTransfer

• getTransfer(request): Promise<x.Transfer>

• Get details of a Transfer with the given ID

  Parameters

  • request: TransfersApiGetTransferRequest

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

  Returns Promise<x.Transfer>

  a promise that resolves with the requested Transfer

  Throws

  IMXError

listTransfers

• listTransfers(request?): Promise<ListTransfersResponse>

• Get a list of Transfers

  Parameters

  • Optionalrequest: TransfersApiListTransfersRequest

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

  Returns Promise<ListTransfersResponse>

  a promise that resolves with the requested list of Transfers

  Throws

  IMXError

createExchange

• createExchange(request): Promise<ExchangeCreateExchangeAndURLResponse>

• Create a new Exchange transaction

  Parameters

  • request: ExchangesApiCreateExchangeRequest

    the request object to be provided in the API request

  Returns Promise<ExchangeCreateExchangeAndURLResponse>

  a promise that resolves with the created Exchange Transaction

  Throws

  IMXError

getExchange

• getExchange(request): Promise<Exchange>

• Get an Exchange transaction

  Parameters

  • request: ExchangesApiGetExchangeRequest

    the request object to be provided in the API request

  Returns Promise<Exchange>

  a promise that resolves with the Exchange Transaction

  Throws

  IMXError

getExchanges

• getExchanges(request): Promise<GetTransactionsResponse>

• Get Exchange transactions

  Parameters

  • request: ExchangesApiGetExchangesRequest

    the request object to be provided in the API request

  Returns Promise<GetTransactionsResponse>

  a promise that resolves with Exchange Transactions

  Throws

  IMXError

exchangeTransfer

• exchangeTransfer(walletConnection, request): Promise<CreateTransferResponseV1>

• Create a new Transfer request

  Parameters

  • walletConnection: ImxClientWalletConnection

    the pair of Eth/Stark signers
  • request: UnsignedExchangeTransferRequest

    the request object to be provided in the API request

  Returns Promise<CreateTransferResponseV1>

  a promise that resolves with the created Exchange Transfer

  Throws

  IMXError

createNftPrimary

• createNftPrimary(request): Promise<NftprimarytransactionCreateResponse>

• Create a new nft primary transaction

  Parameters

  • request: NftCheckoutPrimaryApiCreateNftPrimaryRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionCreateResponse>

  a promise that resolves with the created nft primary Transaction

  Throws

  IMXError

getCurrenciesNFTCheckoutPrimary

• getCurrenciesNFTCheckoutPrimary(request): Promise<CurrencyWithLimits>

• Get nft primary supported currencies and their limits

  Parameters

  • request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest

    the request object to be provided in the API request

  Returns Promise<CurrencyWithLimits>

  a promise that resolves with nft primary Currencies

  Throws

  IMXError

getNftPrimaryTransaction

• getNftPrimaryTransaction(request): Promise<NftprimarytransactionGetResponse>

• Get nft primary transaction by transaction id

  Parameters

  • request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionGetResponse>

  a promise that resolves with nft primary transaction

  Throws

  IMXError

getNftPrimaryTransactions

• getNftPrimaryTransactions(request): Promise<NftprimarytransactionListTransactionsResponse>

• Get list of nft primary transactions

  Parameters

  • request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionListTransactionsResponse>

  a promise that resolves with nft primary transaction

  Throws

  IMXError

createPrimarySale

• createPrimarySale(walletConnection, request): Promise<CreatePrimarySaleResponse>

• Create a PrimarySale

  Parameters

  • walletConnection: ImxClientWalletConnection

    the pair of L1/L2 signers
  • request: PrimarySalesApiSignableCreatePrimarySaleRequest

    the request object to be provided in the API request

  Returns Promise<CreatePrimarySaleResponse>

  a promise that resolves with the created Trade

  Throws

  IMXError

acceptPrimarySale

• acceptPrimarySale(ethSigner, primarySaleId): Promise<AcceptPrimarySaleResponse>

• Accept a PrimarySale

  Parameters

  • ethSigner: EthSigner

    eth signer matching the 'studio_ether_key' of the primary sale
  • primarySaleId: number

    id of the primary sale accepting

  Returns Promise<AcceptPrimarySaleResponse>

  a promise that resolves with the created Trade

  Throws

  IMXError

rejectPrimarySale

• rejectPrimarySale(ethSigner, primarySaleId): Promise<RejectPrimarySaleResponse>

• Reject a PrimarySale

  Parameters

  • ethSigner: EthSigner

    eth signer matching the 'studio_ether_key' of the primary sale
  • primarySaleId: number

    id of the primary sale to be rejected

  Returns Promise<RejectPrimarySaleResponse>

  a promise that resolves with the rejected PrimarySale

  Throws

  IMXError