GET /v1/liquidity/params/:offchainAsset — nloop-server-openapi-definition

autoloop

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

get/v1/liquidity/params/{offchainAsset}

Path parameters

offchainAsset'BTC' | 'LTC'

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

Response

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

Changed in 4 of the 50 revisions of this API.106

Jan 26, 2022b52777465fee11See the full diff
- ▲
  added subschema #3 to the rules/items/channel_id/oneOf[ShortChannelId]/ response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  the path request parameter offchainAsset became optional
  request-parameter-became-optional
Jan 26, 20222fa64114517851See the full diff
- ▲
  the rules/items/pubkey response property's maxLength was unset from 33 for the response status 200
  response-property-max-length-unset
- ▲
  the rules/items/pubkey response property's minLength was decreased from 33 to 0 for the response status 200
  response-property-min-length-decreased
- ▲
  added PubKey to the rules/items/pubkey response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  added ShortChannelId to the rules/items/channel_id response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  the rules/items/pubkey response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  removed subschema #1 subschema #2 from the rules/items/channel_id response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 24, 20222f51ef5daa6d11See the full diff
- ▲
  response property rules/items/channel_id list-of-types was widened by adding types integer to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  the rules/items/channel_id response's property pattern (\d{3})x(\d{3})x(\d{2}) was removed for the status 200
  response-property-pattern-removed
Jan 19, 2022ebc31c9ff35833See the full diff
- ▲
  the path request parameter offchainAsset became required
  request-parameter-became-required
- ▲
  the rules/items/channel_id response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the rules/items/pubkey response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ○
  removed PubKey from the rules/items/pubkey response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  removed ShortChannelId from the rules/items/channel_id response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  the rules/items/channel_id response's property pattern (\d{3})x(\d{3})x(\d{2}) was added for the status 200
  response-property-pattern-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history