Function PoolsApiAxiosParamCreator

  • PoolsApi - axios parameter creator

    Parameters

    Returns {
        dpool: ((asset, height?, options?) => Promise<RequestArgs>);
        dpools: ((height?, options?) => Promise<RequestArgs>);
        pool: ((asset, height?, options?) => Promise<RequestArgs>);
        pools: ((height?, options?) => Promise<RequestArgs>);
    }

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

      Returns the pool information for the provided derived asset.

      Throws

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

          • asset: string
          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • dpools: ((height?, options?) => Promise<RequestArgs>)

      Returns the pool information for all derived assets.

      Throws

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

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Returns the pool information for the provided asset.

      Throws

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

          • asset: string
          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • pools: ((height?, options?) => Promise<RequestArgs>)

      Returns the pool information for all assets.

      Throws

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

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Generated using TypeDoc