• DefaultApi - functional programming interface

    Parameters

    Returns {
        getActions(address?, txid?, asset?, type?, affiliate?, limit?, offset?, nextPageToken?, timestamp?, height?, prevPageToken?, fromTimestamp?, fromHeight?, options?): Promise<((axios?, basePath?) => AxiosPromise<GetActions200Response>)>;
        getBalance(address, timestamp?, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Balance>)>;
        getBorrowerDetail(address, options?): Promise<((axios?, basePath?) => AxiosPromise<BorrowerDetails>)>;
        getBorrowersAddresses(asset?, options?): Promise<((axios?, basePath?) => AxiosPromise<Borrowers>)>;
        getChurns(options?): Promise<((axios?, basePath?) => AxiosPromise<Churns>)>;
        getDepthHistory(pool, interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<DepthHistory>)>;
        getEarningsHistory(interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<EarningsHistory>)>;
        getHealth(options?): Promise<((axios?, basePath?) => AxiosPromise<Health>)>;
        getKnownPools(options?): Promise<((axios?, basePath?) => AxiosPromise<KnownPools>)>;
        getLiquidityHistory(pool?, interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<LiquidityHistory>)>;
        getMemberDetail(address, showSavers?, options?): Promise<((axios?, basePath?) => AxiosPromise<MemberDetails>)>;
        getMembersAdresses(pool?, options?): Promise<((axios?, basePath?) => AxiosPromise<Members>)>;
        getNetworkData(options?): Promise<((axios?, basePath?) => AxiosPromise<Network>)>;
        getNodes(options?): Promise<((axios?, basePath?) => AxiosPromise<Nodes>)>;
        getPool(asset, period?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolDetail>)>;
        getPoolStats(asset, period?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolStatsDetail>)>;
        getPools(status?, period?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolDetails>)>;
        getSaverDetail(address, options?): Promise<((axios?, basePath?) => AxiosPromise<SaverDetails>)>;
        getSaversHistory(pool, interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<SaversHistory>)>;
        getStats(options?): Promise<((axios?, basePath?) => AxiosPromise<StatsData>)>;
        getSwapHistory(pool?, interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<SwapHistory>)>;
        getTHORNameDetail(name, options?): Promise<((axios?, basePath?) => AxiosPromise<THORNameDetails>)>;
        getTHORNamesByAddress(address, options?): Promise<((axios?, basePath?) => AxiosPromise<ReverseTHORNames>)>;
        getTHORNamesOwnerByAddress(address, options?): Promise<((axios?, basePath?) => AxiosPromise<ReverseTHORNames>)>;
        getTVLHistory(interval?, count?, to?, from?, options?): Promise<((axios?, basePath?) => AxiosPromise<TVLHistory>)>;
    }

    • getActions:function
      • List actions along with their related transactions. An action is generated by one or more inbound transactions with the intended action set in the transaction memo. The action may result in one or more outbound transactions. Results are paginated by sets of 50. Filters may be applied to query actions.

        Parameters

        • Optional address: string

          Comma separated list. Address of sender or recipient of any in/out transaction related to the action.

        • Optional txid: string

          ID of any in/out tx related to the action

        • Optional asset: string

          Comma separated list. Any asset that is part of the action (CHAIN.SYMBOL) Additionally, synth, nosynth, and norune filters can be used for swap, add/withdraw actions.

        • Optional type: string

          One or more comma separated unique types of action (swap, addLiquidity, withdraw, donate, refund, switch)

        • Optional affiliate: string

          Comma separated list. Affiliate address of the action (swap, refund)

        • Optional limit: number

          number of actions returned, default is 50

        • Optional offset: number

          pagination offset, default is 0

        • Optional nextPageToken: number

          if this is given, the actions for the next page will be given

        • Optional timestamp: number

          if this is given, the actions older than the timestamp will be given

        • Optional height: number

          if this is given, the actions older than the height will be given

        • Optional prevPageToken: number

          if this is given, the actions for the previous page will be given

        • Optional fromTimestamp: number

          if this is given, the actions newer than the timestamp will be given

        • Optional fromHeight: number

          if this is given, the actions newer than the height will be given

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<GetActions200Response>)>

        Summary

        Actions List

        Throws

    • getBalance:function
      • Returns all coin amounts of the given address at the specified timestamp or height, or at the latest process block if neither is provided. (Only one of timestamp or height can be specified, not both.) This endpoint is enabled only if the midgard startup config allows it.

        Parameters

        • address: string

          Rune address.

        • Optional timestamp: number

          Unix timestamp as seconds since 1970 (if provided, height must not be provided)

        • Optional height: number

          Block height (if provided, timestamp must not be provided)

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<Balance>)>

        Summary

        Current balance for an address

        Throws

    • getBorrowerDetail:function
      • Returns an array of statistics for all the open loans associated with a given borrower address.

        Parameters

        • address: string

          Address to match borrower, an asset address is given. Query can also be multiple addresses should be seperated by comma (&#39;,&#39;)

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<BorrowerDetails>)>

        Summary

        Borrower Details

        Throws

    • getBorrowersAddresses:function
      • Returns an array containing the addresses for all borrowers. Addresses are only shown once.

        Parameters

        • Optional asset: string

          Return only borrowers getting loan against this asset as collateral.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<Borrowers>)>

        Summary

        Borrowers List

        Throws

    • getChurns:function
    • getDepthHistory:function
      • Returns the asset and rune depths and price. The values report the state at the end of each interval. History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • pool: string

          Return stats for this single pool.

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400].

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now.

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<DepthHistory>)>

        Summary

        Depth and Price History

        Throws

    • getEarningsHistory:function
      • Returns earnings data for the specified interval. History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400].

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now.

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<EarningsHistory>)>

        Summary

        Earnings History

        Throws

    • getHealth:function
      • Returns an object containing the health response of the API. Meaning of heights: lastThorNode - Latest block as reported by ThorNode. lastFetched - Latest block fetched from ThorNode. lastCommitted - Latest block committed to the DB but not fully processed yet. lastAggregated - Latest block fully processed and aggregated. genesisInfo - The genesis height Midgard bootstrapped with.

        Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<Health>)>

        Summary

        Health Info

        Throws

    • getKnownPools:function
    • getLiquidityHistory:function
      • Returns withdrawals and deposits for given time interval. If pool is not specified returns for all pools History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • Optional pool: string

          Return stats for given pool. Returns sum of all pools if missing

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400]

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<LiquidityHistory>)>

        Summary

        Liquidity Changes History

        Throws

    • getMemberDetail:function
      • Returns an array of statistics for all the liquidity providers associated with a given member address.

        Parameters

        • address: string

          Address to match liquidity providers. Either a rune or an asset address may be given. Query can also be multiple addresses should be seperated by comma (&#39;,&#39;)

        • Optional showSavers: boolean

          A flag to show saver vault membership details, the default is false.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<MemberDetails>)>

        Summary

        Member Details

        Throws

    • getMembersAdresses:function
      • Returns an array containing the addresses for all pool members. Addresses are only shown once. If there's both a RUNE address and an asset address for a member, only the RUNE address will be shown.

        Parameters

        • Optional pool: string

          Return only members present in the pool.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<Members>)>

        Summary

        Members List

        Throws

    • getNetworkData:function
    • getNodes:function
    • getPool:function
      • Returns details of the pool: depths, price, 24h volume, APY.

        Parameters

        • asset: string

          pool name

        • Optional period: "1h" | "24h" | "7d" | "14d" | "30d" | "90d" | "100d" | "180d" | "365d" | "all"

          Specifies the base interval from which APY is extrapolated. Default is 30d.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PoolDetail>)>

        Summary

        Details of a Pool

        Throws

    • getPoolStats:function
      • Statistics about the pool. The description of the fields have pointers about the corresponding v2/history location. Visit the history endpoint for drilldowns.

        Parameters

        • asset: string

          pool name

        • Optional period: "1h" | "24h" | "7d" | "14d" | "30d" | "90d" | "100d" | "180d" | "365d" | "all"

          Restricts aggregation type fields to the last period only. Default is 30d.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PoolStatsDetail>)>

        Summary

        Pool Statistics

        Throws

    • getPools:function
      • Returns an array containing details for a set of pools

        Parameters

        • Optional status: "available" | "staged" | "suspended"

          Filter for only pools with this status

        • Optional period: "1h" | "24h" | "7d" | "14d" | "30d" | "90d" | "100d" | "180d" | "365d" | "all"

          Specifies the base interval from which annualPercentageRate and poolAPY is extrapolated. Default is 14d.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PoolDetails>)>

        Summary

        Pools List

        Throws

    • getSaverDetail:function
      • Returns an array of statistics for all the savers associated with a given member address. Query can also be multiple addresses should be seperated by comma (',')

        Parameters

        • address: string

          Address to match the saver. an asset address should be given.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<SaverDetails>)>

        Summary

        Saver Details

        Throws

    • getSaversHistory:function
      • Returns savers depths and units. The values report the state at the end of each interval. History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • pool: string

          Return stats for this single pool.

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400].

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now.

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<SaversHistory>)>

        Summary

        Savers Units and Depth History

        Throws

    • getStats:function
    • getSwapHistory:function
      • Returns swap count, volume, fees, slip in specified interval. If pool is not specified returns for all pools History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • Optional pool: string

          Return history given pool. Returns sum of all pools if missing.

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400].

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now.

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<SwapHistory>)>

        Summary

        Swaps History

        Throws

    • getTHORNameDetail:function
    • getTHORNamesByAddress:function
    • getTHORNamesOwnerByAddress:function
      • Returns an array of THORNames owned by the address. The address is not necessarily an associated address for those thornames.

        Parameters

        • address: string

          Address which owns a THORName.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<ReverseTHORNames>)>

        Summary

        THORName owner

        Throws

    • getTVLHistory:function
      • Returns total pool depths, total bonds, and total value locked in specified interval. Total Value Locked = Total Bonds + 2 * Total Pool Depths History endpoint has two modes: * With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries. * Without Interval parameter a single From..To search is performed with exact timestamps. * Interval: possible values: 5min, hour, day, week, month, quarter, year. * count: [1..400]. Defines number of intervals. Don't provide if Interval is missing. * from/to: optional int, unix second. Possible usages with interval. * last 10 days: ?interval=day&count=10 * last 10 days before to: ?interval=day&count=10&to=1608825600 * next 10 days after from: ?interval=day&count=10&from=1606780800 * Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600 Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query. Possible configurations without interval: * exact search for one time frame: ?from=1606780899&to=1608825600 * one time frame until now: ?from=1606780899 * from chain start until now: no query parameters

        Parameters

        • Optional interval: "5min" | "hour" | "day" | "week" | "month" | "quarter" | "year"

          Interval of calculations

        • Optional count: number

          Number of intervals to return. Should be between [1..400].

        • Optional to: number

          End time of the query as unix timestamp. If only count is given, defaults to now.

        • Optional from: number

          Start time of the query as unix timestamp

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<TVLHistory>)>

        Summary

        Total Value Locked History

        Throws

    Export

Generated using TypeDoc