{"id":13830390,"url":"https://github.com/matteodanelli/MMM-cryptocurrency","last_synced_at":"2025-07-09T11:32:59.995Z","repository":{"id":20818231,"uuid":"90557998","full_name":"matteodanelli/MMM-cryptocurrency","owner":"matteodanelli","description":"A MagicMirror module for crypto currencies value.","archived":false,"fork":false,"pushed_at":"2022-08-08T07:28:20.000Z","size":1805,"stargazers_count":94,"open_issues_count":15,"forks_count":42,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-08-04T10:03:01.677Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matteodanelli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-07T19:56:01.000Z","updated_at":"2024-04-23T12:41:44.000Z","dependencies_parsed_at":"2022-07-29T01:39:01.255Z","dependency_job_id":null,"html_url":"https://github.com/matteodanelli/MMM-cryptocurrency","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matteodanelli%2FMMM-cryptocurrency","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matteodanelli%2FMMM-cryptocurrency/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matteodanelli%2FMMM-cryptocurrency/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matteodanelli%2FMMM-cryptocurrency/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matteodanelli","download_url":"https://codeload.github.com/matteodanelli/MMM-cryptocurrency/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539388,"owners_count":17485317,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:00:59.425Z","updated_at":"2024-11-20T11:30:44.519Z","avatar_url":"https://github.com/matteodanelli.png","language":"JavaScript","funding_links":[],"categories":["Finance"],"sub_categories":[],"readme":"# MMM-cryptocurrency\nA \u003ca href=\"https://github.com/MichMich/MagicMirror\"\u003eMagicMirror\u003c/a\u003e module used to get real-time values of crypto currencies.\n\n## Installation\n1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/matteodanelli/MMM-cryptocurrency.git`.\n2. Add the module inside `config.js` placing it where you prefer ;)\n\n\n## Config\n\n\n|Option|Description|\n|---|---|\n|`apikey`|MANDATORY: API key from [CoinMarketCap](https://pro.coinmarketcap.com/).\u003cbr\u003e**Type:** `string`|\n|`apiDelay`|Frequency, in minutes, to updata data values\u003cbr\u003e**Type:** `number` \u003cbr\u003e **Default** \u003ci\u003e5\u003c/i\u003e |\n|`currency`|One or more currencies you want to display.\u003cbr\u003e**Type:** `array`\u003cbr\u003e**Options:** `bitcoin, ethereum, xrp, dash, bitcoin-gold, litecoin, iota, ethereum-classic, nem, stratis, bitcoin-cash, cardano, solana, neo, poken, bnb`\u003cbr\u003e**Default:** \u003ci\u003e['bitcoin']\u003c/i\u003e|\n|`conversion`|The currency used to convert crypto currency value.\u003cbr\u003e**Type:** `string`\u003cbr\u003e**Options:** `AUD, BRL, CAD, CHF, CNY, EUR, GBP, HKD, IDR, INR, JPY, KRW, MXN, RUB`\u003cbr\u003e**Default:** \u003ci\u003eUSD\u003c/i\u003e|\n|`displayLongNames`| Option that show full name of the currency or the shortest version. (eg. Bitcoin/BTC ). \u003cbr\u003e **Type** `boolean` \u003cbr\u003e **Default** \u003ci\u003efalse\u003c/i\u003e |\n|`displayType`| Sets the display of the module. \u003cbr\u003e**Type:** `string`\u003cbr\u003e**Options:** `detail, logo, logoWithChanges`\u003cbr/\u003e**Default:** \u003ci\u003edetail\u003c/i\u003e\n|`logoHeaderText`| Defines the headline text if `displayType: logo` is set.\u003cbr/\u003e**Type:** `string`\u003cbr\u003e**Default:** \u003ci\u003eCrypto currency\u003c/i\u003e\n|`headers`| Possibility to show currency change in the last hour, day or week. \u003cbr\u003e **Type** One of the following: `change1h, change24h, change7d` \u003cbr\u003e **Default** \u003ci\u003eNone. All optionals.\u003c/i\u003e |\n|`significantDigits`|Total digits to use for rounding the price (including before and after decimal point).\u003cbr\u003e **Type** `number` \u003cbr\u003e **Default** \u003ci\u003enone\u003c/i\u003e |\n|`minimumFractionDigits`|Minimum number of digits after the decimal point in the price.\u003cbr\u003e **Type** `number` \u003cbr\u003e **Default** \u003ci\u003e2\u003c/i\u003e |\n|`maximumFractionDigits`|Maximum number of digits after the decimal point in the price.\u003cbr\u003e **Type** `number` \u003cbr\u003e **Default** \u003ci\u003e5\u003c/i\u003e |\n|`showGraphs`| Possibility to show currency graph over the last week in `displayType: logo`. \u003cbr\u003e **Type:** `boolean` \u003cbr\u003e **Default** \u003ci\u003efalse\u003c/i\u003e |\n|`coloredLogos`| Toggles white or colored logos `displayType: logo`. \u003cbr\u003e **Type:** `boolean` \u003cbr\u003e **Default** \u003ci\u003etrue\u003c/i\u003e |\n|`fontSize`| Dimension of price text. You can specify pixel values, em values or keywords.\u003cbr\u003e **Type:** `string` \u003cbr\u003e**Options:** `xx-small`, `x-small`, `small`, `medium`, `large`, `x-large`, `xx-large` \u003cbr\u003e **Default** \u003ci\u003exx-large\u003c/i\u003e |\n\nHere is an example of an entry in `config.js`\n```\n{\n\tmodule: \"MMM-cryptocurrency\",\n\tposition: \"top_right\",\n\tconfig: {\n\t\tapikey: '1234-5678-9009-8765-4321',\n\t\tcurrency: ['ethereum', 'bitcoin'],\n\t\tconversion: 'EUR',\n\t\theaders: ['change24h', 'change1h', 'change7d'],\n\t\tdisplayType: 'logoWithChanges',\n\t\tshowGraphs: true\n\t}\n}\n```\n\n## Screenshots\n#### Display type: details\n![Screenshot of detail mode](/MMM-cryptocurrency.png?raw=true \"Example screenshot\")\n\n#### Display type: logo\n![Screenshot with logo](/logoView.png?raw=true \"displayType: 'logo'\")\n\n#### Display type: logoWithChanges\n![Screenshot with logo and Changes](/logoWithChangesView.png?raw=true \"displayType: 'logoWithChanges'\")\n\n#### Display type: logo + significantDigits=5\n![Screenshot with logo and 5 significant digits](/logoViewWithSignificantDigits.png?raw=true \"displayType: 'logo', significantDigits: 5\")\n\n#### Display type: logo + showGraphs\n![Screenshot with logo and graphs](/logoViewWithGraphs.png?raw=true \"displayType: 'logo', showGraphs: 'true'\")\n\n#### Display type: logoWithChanges + showGraphs\n![Screenshot with logo changes and graphs](/logoWithChangesAndGraphView.png?raw=true \"displayType: 'logoWithChanges', showGraphs: 'true'\")\n\n#### Display type: logo + coloredLogos + showGraphs\n![Screenshot with logo](/logoColoredGraph.png?raw=true \"displayType: 'logo', showGraphs: 'true', coloredLogos: true\")\n\n## Cryptocurrency Logo\n\nLogo provided only for the following currencies:\n- Bitcoin, Bitcoin cash, Bitcoin gold, Bitcoin SV\n- Ethereum, Ethereum classic\n- Basic Attention Token\n- Binance Coin\n- Cardano\n- Crypto.com Coin\n- Dash\n- Dogecoin\n- Eos\n- Iota\n- Lisk\n- Litecoin\n- Monero\n- Nano\n- Nem\n- Neo\n- Polkadot\n- Poken\n- Ripple\n- Shiba Inu\n- Solana\n- Stellar\n- Stratis\n- SwissBorg\n- The graph\n- Tron\n- XRP\n\nFeel free to ask for support of your favorite currency. Else, just implement it (eg: to add Litecoin logo):\n- Add `'litecoin'` to the currency module config\n- Create the logo (png, 50x50px)\n- Name the file `litecoin.png`\n- Put it in the `/public/` `black-white/` and `colored` directory of the module\n- Restart MagicMirror\n\n## Notes\nData provided by \u003ca href=\"https://coinmarketcap.com/\"\u003ecoinmarketcap.com\u003c/a\u003e.\n- Endpoints update every 5 minutes.\n- Currently you can only display currencies listed within top-25 on coinmarketcap.com.\n- `significantDigits` only has a visible effect when set to 4 or more. It is useful for showing low-value coins (such as Ripple) at a higher resolution, rounding to more digits after the decimal point than the minimal 2. Rounding always keeps at least two digits after the decimal.\n\n## Feedback\nIt's my first module here after that I built a MagicMirror. I'm so proud of it and I have found a lot of interesting modules, including one similar to this, based on Bitcoin only \u003ca href=\"https://github.com/valmassoi/MMM-bitcoin\"\u003eMMM-bitcoin\u003c/a\u003e.\n\u003cbr\u003eI am open to work on this project and to expand it to add other interesting features, and a bit of cool style too.\n\u003cbr\u003eLeave me some feedback in the forum. Thank you!\n\n## Contributors\n- \u003ca href=\"https://github.com/Klizzy/MMM-cryptocurrency\"\u003eKlizzy\u003c/a\u003e for translations and multiple currencies.\n- \u003ca href=\"https://github.com/olexs/MMM-cryptocurrency\"\u003eolexs\u003c/a\u003e for currencies graphs and significant digits.\n- \u003ca href=\"https://github.com/mattdy/MMM-cryptocurrency\"\u003emattdy\u003c/a\u003e for minimum/maximum fraction length on pricing, and refactor for new API\n\n\nThe MIT License (MIT)\n=====================\n\nCopyright © 2021 Matteo Danelli\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the “Software”), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\n**The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability,\nfitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability,\nwhether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatteodanelli%2FMMM-cryptocurrency","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatteodanelli%2FMMM-cryptocurrency","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatteodanelli%2FMMM-cryptocurrency/lists"}