{"id":13583150,"url":"https://github.com/coinranking/exchanges","last_synced_at":"2025-05-13T13:23:32.320Z","repository":{"id":36700158,"uuid":"200013020","full_name":"coinranking/exchanges","owner":"coinranking","description":"An open source JavaScript library for fetching tickers from cryptocurrency exchanges","archived":false,"fork":false,"pushed_at":"2024-06-17T10:25:50.000Z","size":22816,"stargazers_count":123,"open_issues_count":8,"forks_count":54,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-24T22:20:59.881Z","etag":null,"topics":["altcoin","binance","bitcoin","coin","coinbase","coinranking","crypto","cryptocurrencies","cryptocurrency","decentralized","dex","ethereum","exchanges","library","markets","ohlc","prices","tickers","trading","volume"],"latest_commit_sha":null,"homepage":"https://coinranking.com","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/coinranking.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-08-01T08:46:13.000Z","updated_at":"2025-03-30T20:16:33.000Z","dependencies_parsed_at":"2023-01-17T04:15:51.713Z","dependency_job_id":"2fe26d7b-9bc5-4844-8db7-d255cb8ece1c","html_url":"https://github.com/coinranking/exchanges","commit_stats":{"total_commits":1100,"total_committers":18,"mean_commits":"61.111111111111114","dds":0.7936363636363637,"last_synced_commit":"85aa8b2fcfb46d404238f33de724b348e54c4670"},"previous_names":[],"tags_count":244,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinranking%2Fexchanges","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinranking%2Fexchanges/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinranking%2Fexchanges/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinranking%2Fexchanges/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coinranking","download_url":"https://codeload.github.com/coinranking/exchanges/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253948758,"owners_count":21989014,"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":["altcoin","binance","bitcoin","coin","coinbase","coinranking","crypto","cryptocurrencies","cryptocurrency","decentralized","dex","ethereum","exchanges","library","markets","ohlc","prices","tickers","trading","volume"],"created_at":"2024-08-01T15:03:17.265Z","updated_at":"2025-05-13T13:23:32.291Z","avatar_url":"https://github.com/coinranking.png","language":"JavaScript","readme":"[![code-style](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg?style=shield)](https://github.com/airbnb/javascript)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=shield)](http://commitizen.github.io/cz-cli/)\n[![npm (scoped)](https://img.shields.io/npm/v/@coinranking/exchanges)](https://www.npmjs.com/package/@coinranking/exchanges)\n[![codecov](https://img.shields.io/codecov/c/github/coinranking/exchanges/master.svg?style=shield)](https://codecov.io/gh/coinranking/exchanges)\n\n\n# Exchanges 📉📈\n\nA JavaScript library for getting up to date cryptocurrency exchange tickers.\n\n![](exchange.webp)\n\n## Getting started\n\n1. Node.js 14.0 or higher is required\n2. Install using [NPM](https://www.npmjs.com/package/@coinranking/exchanges)\n\n## Installation\n\nCoinranking Exchanges is a [Node.js](https://nodejs.org/) module available through the [npm registry](https://www.npmjs.com/package/@coinranking/exchanges).\n\nBefore installing, [download and install Node.js](https://nodejs.org/en/download/).\nNode.js 14.0 or higher is required.\n\nInstallation is done using the npm install command:\n\n```shell\nnpm i @coinranking/exchanges\n```\n\n## Usage\n\nList all supported drivers\n\n```JavaScript\nconst exchanges = require('@coinranking/exchanges');\n\nconsole.log(exchanges.list());\n```\n\nGet the tickers of a specific exchange\n\n```JavaScript\nconst { Binance } = require('@coinranking/exchanges');\n\nconst driver = new Binance();\n\ndriver\n  .fetchTickers()\n  .then((tickers) =\u003e {\n    console.log(tickers);\n  });\n```\n\n## Development\n\n### Getting started\n\nInstall dependencies\n\n```shell\nnpm install\n```\n\n### Usage\n\n#### List all supported drivers\n\n```shell\nnode lib/cli.js list\n```\n\n#### Get the tickers of a specific exchange\n\n```shell\nnode lib/cli.js tickers [name of the exchange]\n```\n\n##### Flags\n\n| Name      | Flag                    | Description\n| ----------| ------------------------| ---\n| Record    | `-R`, `--record`        | Record the requests, and save them as fixtures.\n| API Key   | `-k`, `--key`           | For passing down an API key when the driver requires one. When used in combination with the `-R` flag the key will be masked in the fixtures.\n\n### Documentation\n\nSee the [documentation](DOCUMENTATION.md) for more information.\n\n## Contributing\n\nBug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.\n\n### Adding an exchange\n\n1. Add a new driver (see the [examples](#examples))\n2. Add the driver alphabetically to drivers/index.js\n3. Add a new fixture (use the record option of the CLI 'tickers' command)\n\nSingle API calls are highly preferred.\nWhen adding an exchange be aware of the base and quote.\nA driver should at least support `base`, `quote`, `close` and `baseVolume` or `quoteVolume`. And optionally `open`, `high`, `low`, `ask`, `bid`, `baseName`, `baseReference`, `quoteName` and `quoteReference`.\n\n### Listing requirements\n\nBefore we approve your pull request, we’d like to review the exchange and check if it meets our [listing requirements](https://support.coinranking.com/article/71-what-are-the-requirements-for-listing-an-exchange).\n\nTicking off all the boxes? Cool! Send us your listing request at [info@coinranking.com](mailto:info@coinranking.com) and include your daily trading volume + a link to your platform. We will then review your exchange ASAP.\n\n### Examples\n- [Driver basis:](examples/basicdriver.js) Shows the basic setup of a driver, which can be used as the starting point\nfor new ones.\n- [Driver with API key:](examples/apikeydriver.js) Shows how to set up a driver that uses an API which requires a key.\n\n### Conventions\n\n1. [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)\n2. [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)\n\n## Links\n\n### Reach out to us\n\n- [Telegram](https://t.me/CoinrankingOfficial)\n- [Forum](https://community.coinranking.com/c/developers/20)\n- [Twitter](https://twitter.com/coinranking)\n- [info@coinranking.com](mailto:info@coinranking.com)\n\n### Other\n\n- [Coinranking API](https://coinranking.com/page/cryptocurrency-api)\n- [API docs](https://docs.coinranking.com/)\n- [Supplies library](https://github.com/coinranking/supplies)\n\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinranking%2Fexchanges","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoinranking%2Fexchanges","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinranking%2Fexchanges/lists"}