Function PoolsApiFp

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

• dpool:function

  • dpool(asset, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<DerivedPool>)>

  • Returns the pool information for the provided derived 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<DerivedPool>)>

    Throws

• dpools:function

  • dpools(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<DerivedPoolsResponse>)>

  • Returns the pool information for all derived assets.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Throws

• 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

  • pools(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<PoolsResponse>)>

  • Returns the pool information for all assets.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Throws