Function PoolsApiFactory

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

• dpool:function

  • dpool(asset, height?, options?): 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: any

      Override http request option.

    Returns AxiosPromise<DerivedPool>

    Throws

• dpools:function

  • dpools(height?, options?): AxiosPromise<DerivedPoolsResponse>

  • Returns the pool information for all derived assets.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<DerivedPoolsResponse>

    Throws

• pool:function

  • pool(asset, height?, options?): 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: any

      Override http request option.

    Returns AxiosPromise<Pool>

    Throws

• pools:function

  • pools(height?, options?): AxiosPromise<PoolsResponse>

  • Returns the pool information for all assets.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<PoolsResponse>

    Throws