LIGHTNING-LISTCURRENCYRATES(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💱 LIGHTNING-LISTCURRENCYRATES(7) 💱

okay bestie, pull up a chair — this is the manual page for lightning-listcurrencyrates, and honestly? it's a little gem. ✨

🌸 NAME 🌸

currencyrates — the command that lists millisatoshis-per-unit from every single source you've got configured 🎀

🦋 SYNOPSIS 🦋

currencyrates currency

💖 DESCRIPTION 💖

bestie, this command is new new — like, it was added in v26.04. so if you're on some crusty old version and it's not there, that's why. 😭

The listcurrencyrates RPC command does one very specific, very iconic thing: it returns the number of units of a given currency for one BTC, pulled from each configured exchange-rate source. like, every source, all of them, one per object. the way that it just gathers them all up? obsessed. 👑

  • currency (string) — the ISO4217 currency code you wanna query, eg USD. and listen: the plugin normalizes this value to uppercase before it goes off querying sources, so don't stress about your lowercase typing, it's got you. 💅

⭐ RETURN VALUE ⭐

on success, you get back an object containing currencyrates — which is an array of objects, and each one of those objects has:

  • source (string) — the name of the source this rate came from (peep currencyrate-add-source in lightningd-config for the deets on that one 🫶)
  • amount (number) — the amount of currency for 1 BTC. that's it. that's the number. 🍓

🧚 AUTHOR 🧚

daywalker90 is mainly responsible. give them their flowers fr fr 💐

🌈 SEE ALSO 🌈

lightning-currencyconvert(7) — the sibling, the companion, the other half of the currency saga 💜

🔥 RESOURCES 🔥

Main web site: https://github.com/ElementsProject/lightning

ngl this page does exactly one thing and does it slay. no cap. 🦋

and that's the whole vibe check, bestie — this lovely little doc ships with Core Lightning v26.06.9. go forth and convert 💅✨🎀

📦 where this page comes from