Hierarchy

Constructors

Properties

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

Methods

  • Get details of a Deposit with the given ID

    Parameters

    Returns Promise<Deposit>

    a promise that resolves with the requested Deposit

    Throws

    index.IMXError

  • Get a list of Deposits

    Parameters

    Returns Promise<ListDepositsResponse>

    a promise that resolves with the requested list of Deposits

    Throws

    index.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

    Throws

    index.IMXError

  • Get details of an Asset

    Parameters

    Returns Promise<Asset>

    a promise that resolves with the requested Asset

    Throws

    index.IMXError

  • Get a list of Assets

    Parameters

    Returns Promise<ListAssetsResponse>

    a promise that resolves with the requested list of Assets

    Throws

    index.IMXError

  • Create a Collection

    Parameters

    Returns Promise<Collection>

    a promise that resolves with the created Collection

    Throws

    index.IMXError

  • Get details of a Collection at the given address

    Parameters

    Returns Promise<Collection>

    a promise that resolves with the requested Collection

    Throws

    index.IMXError

  • Get a list of Collection filters

    Parameters

    Returns Promise<CollectionFilter[]>

    a promise that resolves with the requested list of Collection Filters

    Throws

    index.IMXError

  • Get a list of Collections

    Parameters

    Returns Promise<ListCollectionsResponse>

    a promise that resolves with the requested list of Collections

    Throws

    index.IMXError

  • Update a Collection

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • collectionAddress: string

      the Collection contract address

    • request: x.UpdateCollectionRequest

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

    Returns Promise<Collection>

    a promise that resolves with the updated Collection

    Throws

    index.IMXError

  • Add metadata schema to Collection

    Parameters

    Returns Promise<SuccessResponse>

    a promise that resolves with the SuccessResponse if successful

    Throws

    index.IMXError

  • Get Metadata schema

    Parameters

    Returns Promise<MetadataSchemaProperty[]>

    a promise that resolves with the requested Metadata schema

    Throws

    index.IMXError

  • Update metadata schema by name

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • collectionAddress: string

      the Collection contract address

    • name: string

      the Metadata schema name

    • request: x.MetadataSchemaRequest

      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

    index.IMXError

  • Get a list of metadata refreshes

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • Optional collectionAddress: string

      the Collection contract address

    • Optional pageSize: number

      the page size of the result

    • Optional cursor: string

      the cursor

    Returns Promise<GetMetadataRefreshes>

    a promise that resolves with the requested metadata refreshes

    Throws

    index.IMXError

  • Get a list of metadata refresh errors

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • refreshId: string

      the metadata refresh ID

    • Optional pageSize: number

      the page size of the result

    • Optional cursor: string

      the cursor

    Returns Promise<GetMetadataRefreshErrorsResponse>

    a promise that resolves with the requested metadata refresh errors

    Throws

    index.IMXError

  • Get a list of metadata refresh results

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • refreshId: string

      the metadata refresh ID

    Returns Promise<GetMetadataRefreshResponse>

    a promise that resolves with the requested metadata refresh results

    Throws

    index.IMXError

  • Request a metadata refresh

    Parameters

    Returns Promise<CreateMetadataRefreshResponse>

    a promise that resolves with the requested metadata refresh

    Throws

    index.IMXError

  • Get a Project

    Parameters

    • ethSigner: x.EthSigner

      the L1 signer

    • id: string

      the Project ID

    Returns Promise<Project>

    a promise that resolves with the requested Project

    Throws

    index.IMXError

  • Get the token Balances of the User

    Parameters

    Returns Promise<Balance>

    a promise that resolves with the requested Balance

    Throws

    index.IMXError

  • Get a list of Balances for given User

    Parameters

    Returns Promise<ListBalancesResponse>

    a promise that resolves with the requested list of Balances

    Throws

    index.IMXError

  • Get details of a Mint with the given ID

    Parameters

    Returns Promise<Mint[]>

    a promise that resolves with the requested Mint

    Throws

    index.IMXError

  • Get a list of Mints

    Parameters

    Returns Promise<ListMintsResponse>

    a promise that resolves with the requested list of Mints

    Throws

    index.IMXError

  • Mint tokens in a batch with fees

    Parameters

    Returns Promise<x.MintTokensResponse>

    a promise that resolves with the minted tokens

    Throws

    index.IMXError

  • Get a list of Withdrawals

    Parameters

    Returns Promise<ListWithdrawalsResponse>

    a promise that resolves with the requested list of Withdrawals

    Throws

    index.IMXError

  • Get details of Withdrawal with the given ID

    Parameters

    Returns Promise<Withdrawal>

    a promise that resolves with the requested Withdrawal

    Throws

    index.IMXError

  • Get details of an Order with the given ID

    Parameters

    Returns Promise<OrderV3>

    a promise that resolves with the requested Order

    Throws

    index.IMXError

  • Get a list of Orders

    Parameters

    Returns Promise<ListOrdersResponseV3>

    a promise that resolves with the requested list of Orders

    Throws

    index.IMXError

  • Get details of a Trade with the given ID

    Parameters

    Returns Promise<Trade>

    a promise that resolves with the requested Trade

    Throws

    index.IMXError

  • Get a list of Trades

    Parameters

    Returns Promise<ListTradesResponse>

    a promise that resolves with the requested list of Trades

    Throws

    index.IMXError

  • Get details of a Token

    Parameters

    Returns Promise<TokenDetails>

    a promise that resolves with the requested Token

    Throws

    index.IMXError

  • Get a list of Tokens

    Parameters

    Returns Promise<ListTokensResponse>

    a promise that resolves with the requested list of Tokens

    Throws

    index.IMXError

  • Get details of a Transfer with the given ID

    Parameters

    Returns Promise<Transfer>

    a promise that resolves with the requested Transfer

    Throws

    index.IMXError

  • Get a list of Transfers

    Parameters

    Returns Promise<ListTransfersResponse>

    a promise that resolves with the requested list of Transfers

    Throws

    index.IMXError

  • Create a new Exchange transaction

    Parameters

    Returns Promise<ExchangeCreateExchangeAndURLResponse>

    a promise that resolves with the created Exchange Transaction

    Throws

    index.IMXError

  • Get an Exchange transaction

    Parameters

    Returns Promise<Exchange>

    a promise that resolves with the Exchange Transaction

    Throws

    index.IMXError

  • Get Exchange transactions

    Parameters

    Returns Promise<GetTransactionsResponse>

    a promise that resolves with Exchange Transactions

    Throws

    index.IMXError

  • Create a new nft primary transaction

    Parameters

    Returns Promise<NftprimarytransactionCreateResponse>

    a promise that resolves with the created nft primary Transaction

    Throws

    index.IMXError

  • Get nft primary transaction by transaction id

    Parameters

    Returns Promise<NftprimarytransactionGetResponse>

    a promise that resolves with nft primary transaction

    Throws

    index.IMXError

  • Get list of nft primary transactions

    Parameters

    Returns Promise<NftprimarytransactionListTransactionsResponse>

    a promise that resolves with nft primary transaction

    Throws

    index.IMXError

Generated using TypeDoc