BIbitbankinc
autoloop

GET /v1/liquidity/params/{offchainAsset}

Changed on

Get the parameters that the daemon's liquidity manager is currently configured with. This may be nil if nothing is configured.

Request

  • Base URL
    https://api.server.test/v1
  • Auth
    none declared

Path parameters

offchainAsset'BTC' | 'LTC'

off-chain asset which autoloop manager will take care. default is BTC.

Response

OK

fee_ppminteger nullable

The parts per million of swap amount that is allowed to be allocated to swap fees. This valie is applied across swap categories and may not be set in conjunction with sweep fee rate, swap fee ppm, routing fee ppm, prepay routing, max prepay and max miner fee.

sweep_fee_rate_sat_per_kvbyteinteger nullable

The limit we place on our estimated sweep cost for a swap in sat/kilo-vByte. If the estimated fee for our sweep tx within the specified confirmation target is above this value, we will not suggest any swaps.

max_swap_fee_ppminteger nullable

The maximum fee paid to the server for facilitating the swap, expressed as parts-per-million of the swap amount.

max_routing_fee_ppminteger nullable
max_prepay_routing_fee_ppminteger nullable
max_prepay_satinteger nullable
max_miner_fee_satinteger nullable
sweep_conf_targetinteger required

The number of blocks from the on-chain HTLC7s confirmation height that it shuold be swept within.

failure_backoff_secinteger required

The amount of time we require to pass since a channel was part of a failed swap due to off chain payment failure until it will be considered for swap suggestions again, expressed in seconds.

autoloopboolean required

Set to true to enable automatic dispatch of swaps. All swaps will be limited to the fee categories set by these parameters,

auto_max_in_flightinteger required

The maximum number of of automatically dispatched swaps that we allow to be in flight at any point in time.

min_swap_amount_loopoutinteger nullable

The minimum off-chain amount for loop out, expressed in satoshis, that the autoloop client will dispatch a swap for.

max_swap_amount_loopoutinteger nullable

The maximum off-chain amount for loop out, expressed in satoshis.

min_swap_amount_loopininteger nullable

The minimum off-chain amount for loop in, expressed in satoshis, that the autoloop client will dispatch a swap for.

max_swap_amount_loopininteger nullable

The maximum off-chain amount for loop in, expressed in satoshis.

onchain_asset'BTC' | 'LTC'
htlc_conf_targetinteger nullable

The conf target we use to estimate the fee for swaptx in loop-in.

Example response

{
  "rules": [
    {
      "pubkey": "03afbba930dc74d6412b71c31f72bfb8d4615121174dd4290cbbf83960961ba9ab",
      "channel_id": "140x10x1"
    }
  ]
}

Changes

  • b52777465feeRevision changes
    • breaking

      added subschema #3 to the ////// response property oneOf list for the response status

    • info

      the path request parameter offchainAsset became optional

  • 2fa641145178Revision changes
    • breaking

      the // response property's maxLength was unset from 33 for the response status

    • breaking

      the // response property's minLength was decreased from 33 to 0 for the response status

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      removed subschema #1 subschema #2 from the // response property oneOf list for the response status