Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "api"

Index

Functions

Functions

account

  • account(options: AccountServiceRequest): Promise<APIResponse>

  • Makes a request to the AccountService API. The Account API retrieves information for various accounts which have interacted with the protocol. For more details, see the Venus API documentation.

    example
    (async function() {
  const account = await Venus.api.account({
    "addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307",
    "network": "testnet"
  });

  let sxpBorrowBalance = 0;
  if (Object.isExtensible(account) && account.accounts) {
    account.accounts.forEach((acc) => {
      acc.tokens.forEach((tok) => {
        if (tok.symbol === Venus.vSXP) {
          sxpBorrowBalance = +tok.borrow_balance_underlying.value;
        }
      });
    });
  }

  console.log('sxpBorrowBalance', sxpBorrowBalance);
})().catch(console.error);

    Parameters

    • options: AccountServiceRequest

      A JavaScript object of API request parameters.

    Returns Promise<APIResponse>

    Returns the HTTP response body or error.

governance

  • governance(options: GovernanceServiceRequest, endpoint: string): Promise<APIResponse>

  • Makes a request to the GovernanceService API. The Governance Service includes three endpoints to retrieve information about COMP accounts. For more details, see the Venus API documentation.

    example
    (async function() {
  const proposal = await Venus.api.governance(
    { "proposal_ids": [ 20 ] }, 'proposals'
  );

  console.log('proposal', proposal); // JavaScript Object
})().catch(console.error);

    Parameters

    • options: GovernanceServiceRequest

      A JavaScript object of API request parameters.

    • endpoint: string

      A string of the name of the corresponding governance service endpoint. Valid values are proposals, voteReceipts, or accounts.

    Returns Promise<APIResponse>

    Returns the HTTP response body or error.

marketHistory

  • marketHistory(options: MarketHistoryServiceRequest): Promise<APIResponse>

  • Makes a request to the MarketHistoryService API. The market history service retrieves information about a market. For more details, see the Venus API documentation.

    example
    (async function() {
  const vUsdcMarketData = await Venus.api.marketHistory({
    "asset": Venus.util.getAddress(Venus.vUSDC),
    "min_block_timestamp": 1559339900,
    "max_block_timestamp": 1598320674,
    "num_buckets": 10,
  });

  console.log('vUsdcMarketData', vUsdcMarketData); // JavaScript Object
})().catch(console.error);

    Parameters

    • options: MarketHistoryServiceRequest

      A JavaScript object of API request parameters.

    Returns Promise<APIResponse>

    Returns the HTTP response body or error.

vToken

  • vToken(options: CTokenServiceRequest): Promise<APIResponse>

  • Makes a request to the CTokenService API. The vToken API retrieves information about vToken contract interaction. For more details, see the Venus API documentation.

    example
    (async function() {
  const vSxpData = await Venus.api.vToken({
    "addresses": Venus.util.getAddress(Venus.vSXP)
  });

  console.log('vSxpData', vSxpData); // JavaScript Object
})().catch(console.error);

    Parameters

    • options: CTokenServiceRequest

      A JavaScript object of API request parameters.

    Returns Promise<APIResponse>

    Returns the HTTP response body or error.