ExchangeRate

frcli: Get fiat prices for btc.

Example request: http://localhost:8466/v1/faraday/exchangerate

Source: faraday.proto

gRPC

rpc ExchangeRate (ExchangeRateRequest) returns (ExchangeRateResponse);

REST

HTTP Method	Path
GET	/v1/faraday/exchangerate

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:8465'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
const TLS_PATH = 'FARADAY_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('faraday.proto', loaderOptions);
const frdrpc = grpc.loadPackageDefinition(packageDefinition).frdrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new frdrpc.FaradayServer(GRPC_HOST, creds);
let request = {
  timestamps: <uint64>,
  granularity: <Granularity>,
  fiat_backend: <FiatBackend>,
  custom_prices: <BitcoinPrice>,
};
client.exchangeRate(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "rates": <ExchangeRate>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the faraday.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import faraday_pb2 as frdrpc, faraday_pb2_grpc as faradaystub

GRPC_HOST = 'localhost:8465'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = faradaystub.FaradayServerStub(channel)
request = frdrpc.ExchangeRateRequest(
  timestamps=<uint64>,
  granularity=<Granularity>,
  fiat_backend=<FiatBackend>,
  custom_prices=<BitcoinPrice>,
)
response = stub.ExchangeRate(request)
print(response)
# {
#    "rates": <ExchangeRate>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8082'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/faraday/exchangerate`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "rates": <array>, // <ExchangeRate> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8082'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/faraday/exchangerate'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "rates": <ExchangeRate>,
# }

Shell

# There is no CLI command for this RPC

Messages

frdrpc.ExchangeRateRequest

Source: faraday.proto

Field	gRPC Type	REST Type	REST Placement
timestamps A set of timestamps for which we want the bitcoin price.	uint64[]	array	query
granularity The level of granularity at which we want the bitcoin price to be quoted. Nested REST Parameters granularity: string in query	Granularity	string	query
fiat_backend The api to be used for fiat related queries. Nested REST Parameters fiat_backend: string in query	FiatBackend	string	query
custom_prices Custom price points to use if the CUSTOM FiatBackend option is set.	BitcoinPrice[]	array	unknown

frdrpc.ExchangeRateResponse

Source: faraday.proto

Field	gRPC Type	REST Type
rates Rates contains a set of exchange rates for the set of timestamps	ExchangeRate[]	array

Nested Messages

frdrpc.BitcoinPrice

Field	gRPC Type	REST Type
price The price of 1 BTC, expressed in USD.	string	string
price_timestamp The timestamp for this price price provided.	uint64	string
currency The currency that the price is denoted in.	string	string

frdrpc.ExchangeRate

Field	gRPC Type	REST Type
timestamp timestamp is the timestamp of the original request made.	uint64	string
btc_price Price is the bitcoin price approximation for the timestamp queried. Note that this value has its own timestamp because we are not guaranteed to get price points for the exact timestamp that was queried.	BitcoinPrice	object

Enums

frdrpc.FiatBackend

Name	Number
UNKNOWN_FIATBACKEND	0
COINCAP Use the CoinCap API for fiat price information. This API is reached through the following URL: https://api.coincap.io/v2/assets/bitcoin/history	1
COINDESK Use the CoinDesk API for fiat price information. This API is reached through the following URL: https://api.coindesk.com/v1/bpi/historical/close.json	2
CUSTOM Use custom price data provided in a CSV file for fiat price information.	3
COINGECKO Use the CoinGecko API for fiat price information. This API is reached through the following URL: https://api.coingecko.com/api/v3/coins/bitcoin/market_chart	4

frdrpc.Granularity

Name	Number
UNKNOWN_GRANULARITY	0
MINUTE	1
FIVE_MINUTES	2
FIFTEEN_MINUTES	3
THIRTY_MINUTES	4
HOUR	5
SIX_HOURS	6
TWELVE_HOURS	7
DAY	8