Function DefaultApiAxiosParamCreator

  • DefaultApi - axios parameter creator

    Parameters

    Returns {
        getActions: ((address?, txid?, asset?, type?, affiliate?, limit?, offset?, nextPageToken?, timestamp?, height?, prevPageToken?, fromTimestamp?, fromHeight?, options?) => Promise<RequestArgs>);
        getBalance: ((address, timestamp?, height?, options?) => Promise<RequestArgs>);
        getBorrowerDetail: ((address, options?) => Promise<RequestArgs>);
        getBorrowersAddresses: ((asset?, options?) => Promise<RequestArgs>);
        getChurns: ((options?) => Promise<RequestArgs>);
        getDepthHistory: ((pool, interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
        getEarningsHistory: ((interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
        getHealth: ((options?) => Promise<RequestArgs>);
        getKnownPools: ((options?) => Promise<RequestArgs>);
        getLiquidityHistory: ((pool?, interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
        getMemberDetail: ((address, showSavers?, options?) => Promise<RequestArgs>);
        getMembersAdresses: ((pool?, options?) => Promise<RequestArgs>);
        getNetworkData: ((options?) => Promise<RequestArgs>);
        getNodes: ((options?) => Promise<RequestArgs>);
        getPool: ((asset, period?, options?) => Promise<RequestArgs>);
        getPoolStats: ((asset, period?, options?) => Promise<RequestArgs>);
        getPools: ((status?, period?, options?) => Promise<RequestArgs>);
        getSaverDetail: ((address, options?) => Promise<RequestArgs>);
        getSaversHistory: ((pool, interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
        getStats: ((options?) => Promise<RequestArgs>);
        getSwapHistory: ((pool?, interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
        getTHORNameDetail: ((name, options?) => Promise<RequestArgs>);
        getTHORNamesByAddress: ((address, options?) => Promise<RequestArgs>);
        getTHORNamesOwnerByAddress: ((address, options?) => Promise<RequestArgs>);
        getTVLHistory: ((interval?, count?, to?, from?, options?) => Promise<RequestArgs>);
    }

    • getActions: ((address?, txid?, asset?, type?, affiliate?, limit?, offset?, nextPageToken?, timestamp?, height?, prevPageToken?, fromTimestamp?, fromHeight?, options?) => Promise<RequestArgs>)

      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.

      Summary

      Actions List

      Throws

        • (address?, txid?, asset?, type?, affiliate?, limit?, offset?, nextPageToken?, timestamp?, height?, prevPageToken?, fromTimestamp?, fromHeight?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getBalance: ((address, timestamp?, height?, options?) => Promise<RequestArgs>)

      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.

      Summary

      Current balance for an address

      Throws

        • (address, timestamp?, height?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getBorrowerDetail: ((address, options?) => Promise<RequestArgs>)

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

      Summary

      Borrower Details

      Throws

        • (address, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getBorrowersAddresses: ((asset?, options?) => Promise<RequestArgs>)

      Returns an array containing the addresses for all borrowers. Addresses are only shown once.

      Summary

      Borrowers List

      Throws

        • (asset?, options?): Promise<RequestArgs>
        • Parameters

          • Optional asset: string

            Return only borrowers getting loan against this asset as collateral.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getChurns: ((options?) => Promise<RequestArgs>)

      Returns block height and timestamp for each churn.

      Summary

      Churns List

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDepthHistory: ((pool, interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Depth and Price History

      Throws

        • (pool, interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getEarningsHistory: ((interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Earnings History

      Throws

        • (interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getHealth: ((options?) => Promise<RequestArgs>)

      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.

      Summary

      Health Info

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getKnownPools: ((options?) => Promise<RequestArgs>)

      Returns an object with known pools and their statuses

      Summary

      Known Pools List

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getLiquidityHistory: ((pool?, interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Liquidity Changes History

      Throws

        • (pool?, interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getMemberDetail: ((address, showSavers?, options?) => Promise<RequestArgs>)

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

      Summary

      Member Details

      Throws

        • (address, showSavers?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getMembersAdresses: ((pool?, options?) => Promise<RequestArgs>)

      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.

      Summary

      Members List

      Throws

        • (pool?, options?): Promise<RequestArgs>
        • Parameters

          • Optional pool: string

            Return only members present in the pool.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getNetworkData: ((options?) => Promise<RequestArgs>)

      Returns an object containing Network data

      Summary

      Network Data

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getNodes: ((options?) => Promise<RequestArgs>)

      Returns a list of Node public keys and adresses.

      Summary

      Nodes List

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPool: ((asset, period?, options?) => Promise<RequestArgs>)

      Returns details of the pool: depths, price, 24h volume, APY.

      Summary

      Details of a Pool

      Throws

        • (asset, period?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getPoolStats: ((asset, period?, options?) => Promise<RequestArgs>)

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

      Summary

      Pool Statistics

      Throws

        • (asset, period?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getPools: ((status?, period?, options?) => Promise<RequestArgs>)

      Returns an array containing details for a set of pools

      Summary

      Pools List

      Throws

        • (status?, period?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getSaverDetail: ((address, options?) => Promise<RequestArgs>)

      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 (',')

      Summary

      Saver Details

      Throws

        • (address, options?): Promise<RequestArgs>
        • Parameters

          • address: string

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

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getSaversHistory: ((pool, interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Savers Units and Depth History

      Throws

        • (pool, interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getStats: ((options?) => Promise<RequestArgs>)

      Returns an object containing global stats for all pools and all transactions

      Summary

      Global Stats

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getSwapHistory: ((pool?, interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Swaps History

      Throws

        • (pool?, interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getTHORNameDetail: ((name, options?) => Promise<RequestArgs>)

      Returns an array of chains and their addresses associated with the given THORName

      Summary

      THORName Details

      Throws

        • (name, options?): Promise<RequestArgs>
        • Parameters

          • name: string

            a THORName

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getTHORNamesByAddress: ((address, options?) => Promise<RequestArgs>)

      Returns an array of THORNames associated with the given address

      Summary

      Gives a list of THORNames by reverse lookup

      Throws

        • (address, options?): Promise<RequestArgs>
        • Parameters

          • address: string

            Address to match THORNames against.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getTHORNamesOwnerByAddress: ((address, options?) => Promise<RequestArgs>)

      Returns an array of THORNames owned by the address. The address is not necessarily an associated address for those thornames.

      Summary

      THORName owner

      Throws

        • (address, options?): Promise<RequestArgs>
        • Parameters

          • address: string

            Address which owns a THORName.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getTVLHistory: ((interval?, count?, to?, from?, options?) => Promise<RequestArgs>)

      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

      Summary

      Total Value Locked History

      Throws

        • (interval?, count?, to?, from?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    Export

Generated using TypeDoc