Function PoolsApiFp

  • PoolsApiFp(configuration?): {
        pool(asset, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Pool>)>;
        pools(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolsResponse>)>;
    }

  • PoolsApi - functional programming interface

    Parameters

    Returns {
        pool(asset, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Pool>)>;
        pools(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolsResponse>)>;
    }

    • pool:function
      • pool(asset, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Pool>)>

      • Returns the pool information for the provided asset.

        Parameters

        • asset: string
        • Optional height: number

          optional block height, defaults to current tip

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

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

        Throws

    • pools:function

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc