LIGHTNING-CURRENCYRATE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-CURRENCYRATE(7) 💅

okay so bestie, welcome to lightning-currencyrate — your little group-chat liaison for figuring out what one whole BTC is worth in literally any currency you want. ✨

🌸 NAME 🌸

currencyrate — the command that determines a reasonable BTC exchange rate for a given currency, no cap. 🤑

🦋 SYNOPSIS 🦋

currencyrate currency [source]

🎀 DESCRIPTION 🎀

Okay so first thing's first: this command was added in v26.04, so if you're on something older, that's why it's giving nothing. 💀

The currencyrate RPC command returns the exchange rate of one BTC in the given currency. Rates are rounded to 3 decimal places, as specified by ISO 4217 — that's just the vibe ISO decided on, we respect it. ✨

Without the optional source argument, the command returns the median rate across all configured exchange-rate sources. Median, not mean — she's robust, she's unbothered, she does not get dragged by one weird outlier. 👑

With source specified, you get the rate reported by that specific source and only that one. Wanna know what the list of active source names is? Get it via listcurrencyrates. Easy.

To add or disable sources, see the currencyrate-add-source and currencyrate-disable-source options in lightningd-config(5). Go off, configure your little heart out. 🫶

EXAMPLE USAGE: Get the median USD rate: $ lightning-cli currencyrate USD Get the Binance USD rate: $ lightning-cli currencyrate USD binance

Now the arguments, because we are thorough:

  • currency (string) — The ISO 4217 currency code (e.g. USD) to convert to. The plugin normalises this value to uppercase before querying sources, so usd, UsD, USD — all the same to her, she's not judging. 💅
  • source (string, optional) — The name of a specific exchange-rate source to query. If omitted, the median across all available sources is returned. An error is returned if the source name is not recognised or has no cached data for the requested currency. (added v26.06) 🫧
ngl, that source error is real — if you typo binance into binanse, she's not gonna guess what you meant. She's gonna error. Respect the boundary. ✋

💖 RETURN VALUE 💖

On success, an object is returned, containing:

  • rate (number) — The number of currency units per 1 BTC, rounded to 3 decimal places (ISO 4217). When source is omitted this is the median across all available sources. When source is specified this is the rate reported by that source. One field, one number, fully iconic. 🌟

👑 AUTHOR 👑

daywalker90 is mainly responsible. 🫡 slay, honestly.

🌈 SEE ALSO 🌈

⭐ RESOURCES ⭐

Main web site: https://github.com/ElementsProject/lightning — go lurk, it's worth it. 🦋

🍓 EXAMPLES 🍓

✨ Example 1: Get the median BTC/USD rate across all configured sources ✨

Request:

$ lightning-cli currencyrate -k "currency"="USD"

{
  "id": "example:currencyrate#1",
  "method": "currencyrate",
  "params": {
    "currency": "USD"
  }
}

Response:

{
  "rate": 67889.825
}

she ate that median up fr fr 💅

✨ Example 2: Get the BTC/USD rate from the Binance source only ✨

Request:

$ lightning-cli currencyrate -k "currency"="USD" "source"="binance"

{
  "id": "example:currencyrate#2",
  "method": "currencyrate",
  "params": {
    "currency": "USD",
    "source": "binance"
  }
}

Response:

{
  "rate": 67931.9
}

binance said what binance said 🗣️🔥

and that's the whole page bestie, you're officially currency-literate 🧚💜

mwah 💋 — brought to you by Core Lightning v26.06.9, and yes this is LIGHTNING-CURRENCYRATE(7) signing off, catch you in the next manpage 🎀

📦 where this page comes from