Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InjectiveAccountsRPC

InjectiveAccountsRPC defines API of Exchange Accounts provider.

Hierarchy

  • InjectiveAccountsRPC

Implemented by

Index

Methods

Methods

OrderStates

  • List order states by order hashes

    Parameters

    • request: { derivativeOrderHashes?: string[]; spotOrderHashes?: string[] }
      • Optional derivativeOrderHashes?: string[]
      • Optional spotOrderHashes?: string[]
    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.OrderStatesResponse>

Portfolio

  • Provide the account's portfolio value in USD.

    Parameters

    • request: { accountAddress?: string }
      • Optional accountAddress?: string

        Account address

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.PortfolioResponse>

Rewards

  • Provide historical trading rewards

    Parameters

    • request: { accountAddress?: string; epoch?: string }
      • Optional accountAddress?: string

        Account address for the rewards distribution

      • Optional epoch?: string

        The distribution epoch sequence number. -1 for latest.

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.RewardsResponse>

StreamSubaccountBalance

  • StreamSubaccountBalance streams new balance changes for a specified subaccount and denoms. If no denoms are provided, all denom changes are streamed.

    Parameters

    • request: { denoms?: string[]; subaccountId?: string }
      • Optional denoms?: string[]

        Filter balances by denoms. If not set, the balances of all the denoms for the subaccount are provided.

      • Optional subaccountId?: string

        SubaccountId of the trader we want to get the trades from

    • Optional metadata: BrowserHeaders

    Returns Observable<internal.StreamSubaccountBalanceResponse>

SubaccountBalanceEndpoint

  • Gets a balance for specific coin denom

    Parameters

    • request: { denom?: string; subaccountId?: string }
      • Optional denom?: string

        Specify denom to get balance

      • Optional subaccountId?: string

        SubaccountId of the trader we want to get the trades from

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.SubaccountBalanceEndpointResponse>

SubaccountBalancesList

  • List subaccount balances for the provided denoms.

    Parameters

    • request: { denoms?: string[]; subaccountId?: string }
      • Optional denoms?: string[]

        Filter balances by denoms. If not set, the balances of all the denoms for the subaccount are provided.

      • Optional subaccountId?: string

        SubaccountId of the trader we want to get the trades from

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.SubaccountBalancesListResponse>

SubaccountHistory

  • Get subaccount's deposits and withdrawals history

    Parameters

    • request: { denom?: string; endTime?: string; limit?: number; skip?: string; subaccountId?: string; transferTypes?: string[] }
      • Optional denom?: string

        Filter history by denom

      • Optional endTime?: string

        Upper bound of account transfer history's executedAt

      • Optional limit?: number

        Limit is used to specify the maximum number of items to be returned

      • Optional skip?: string

        Skip will skip the first n item from the result

      • Optional subaccountId?: string

        SubaccountId of the trader we want to get the history from

      • Optional transferTypes?: string[]

        Filter history by transfer type

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.SubaccountHistoryResponse>

SubaccountOrderSummary

  • Get subaccount's orders summary

    Parameters

    • request: { marketId?: string; orderDirection?: string; subaccountId?: string }
      • Optional marketId?: string

        MarketId is limiting order summary to specific market only

      • Optional orderDirection?: string

        Filter by direction of the orders

      • Optional subaccountId?: string

        SubaccountId of the trader we want to get the summary from

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.SubaccountOrderSummaryResponse>

SubaccountsList

  • List all subaccounts IDs of an account address

    Parameters

    • request: { accountAddress?: string }
      • Optional accountAddress?: string

        Account address, the subaccounts owner

    • Optional metadata: BrowserHeaders

    Returns internal.Promise<internal.SubaccountsListResponse>

Generated using TypeDoc