Skip to content

GregorWedlich/orakel-otter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🦦 Orakel Otter 🔮

Your magical helper for Bitcoin exchange rates! 🪙💰

🌟 Features

  • 📊 Fetches current Bitcoin prices in various currencies from the Mempool.space API (read more about the rate limitations here).)
  • 🌍 Supports USD, EUR, GBP, CAD, CHF, AUD, JPY
  • 🔍 Filter by a specific currency or get all available rates

🚀 Quick Start

import { orakelOtter } from "@gw/orakel-otter";

// Fetch all BTC exchange rates
const allRates = await orakelOtter();
console.log(allRates);

// Fetch BTC price for a specific currency
const eurRate = await orakelOtter("EUR");
console.log(eurRate);

📚 API

orakelOtter(currency?: string): Promise<[string, number][]>

currency (optional): The currency code (e.g., "USD", "EUR", "GBP") Return value: An array of tuples with currency code and current BTC price

🛠️ Error Handling

If the specified currency is not found, an error will be thrown.

🙏 Contributing

Feel free to open issues or create pull requests. The Orakel Otter welcomes your help! 🦦❤️

📜 License

MIT

Created with 💖 and 🦦 magic

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published