core-lightning/doc/schemas/getroute.request.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": [
    "id",
    "amount_msat",
    "riskfactor"
  ],
  "properties": {
    "id": {
      "type": "pubkey",
      "description": "node pubkey to find the best route for the payment"
    },
    "amount_msat": {
      "type": "msat",
      "description": "amount to send. It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*. The 0 value is special: it ignores any *htlc_minimum_msat* setting on channels, and simply returns a possible route (if any) which is useful for simple probing"
    },
    "riskfactor": {
      "type": "u64",
      "description": "a non-negative floating-point field controls this tradeoff; it is the annual cost of your funds being stuck (as a percentage).\tFor example, if you thought the convenience of keeping your funds liquid (not stuck) was worth 20% per annum interest, *riskfactor* would be 20.\tIf you didn't care about risk, *riskfactor* would be zero"
    },
    "cltv": {
      "type": "u32",
      "description": "cltv-blocks to spare. Default is 9"
    },
    "fromid": {
      "type": "pubkey",
      "description": "the node to start the route from. Default is this node"
    },
    "fuzzpercent": {
      "type": "u32",
      "description": "used to distort fees to provide some randomization to the route generated, but it was not properly implemented and is ignored"
    },
    "exclude": {
      "type": "array",
      "description": "a JSON array of short-channel-id/direction (e.g. ['564334x877x1/0', '564195x1292x0/1' ]) or node-id which should be excluded from consideration for routing. The default is not to exclude any channels or nodes. Note if the source or destination is excluded, the command result is undefined",
      "items": {
        "type": "string"
      }
    },
    "maxhops": {
      "type": "u32",
      "description": "the maximum number of channels to return. Default is 20"
    }
  }
}