Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xasos/coins
Cryptocurrency Price REST API
https://github.com/xasos/coins
Last synced: 2 months ago
JSON representation
Cryptocurrency Price REST API
- Host: GitHub
- URL: https://github.com/xasos/coins
- Owner: xasos
- License: mit
- Created: 2014-09-16T00:46:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-01-27T15:15:54.000Z (almost 7 years ago)
- Last Synced: 2024-10-31T06:41:58.977Z (2 months ago)
- Language: JavaScript
- Homepage: http://coins-api.herokuapp.com
- Size: 485 KB
- Stars: 7
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coins
[![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image]
Cryptocurrency Price REST API written in Node.js. Data is scraped from [CoinMarketCap](http://coinmarketcap.com/).
*Note: This is an unofficial API and is __not__ supported or controlled by CoinMarketCap itself. Any questions, comments, feedback or feature requests should be directed to [xasos](http://github.com/xasos) or via an [issue](https://github.com/xasos/Coins/issues) in this repo.*
## Usage
**Base URL:** http://coins-api.herokuapp.com
**Output:** JSON
### Get All Coin Prices
Get price information about all coins.
#### `GET /coins`
Example Query:
```
http://coins-api.herokuapp.com/coins
```
Response:
```json
{
"name": "bitcoin",
"position": "1",
"price": "356.51",
"marketCap": "4847623128",
"ticker": "BTC",
"volume": "29824000",
"delta24hr": "2.37",
"timestamp": 1418325595612,
"currency": "usd"
},
{
"name": "ripple",
"position": "2",
"price": "0.016374",
"marketCap": "505654484",
"ticker": "XRP",
"volume": "1620910",
"delta24hr": "6.48",
"timestamp": 1418325595612,
"currency": "usd"
},
...
...
```
### Get Individual Coin Prices
Get information about individual coins.
#### `GET /coins/:ticker`
Example Query:
```
http://coins-api.herokuapp.com/coins/btc
```
Response:
```json
{
"name": "bitcoin",
"position": "1",
"price": "356.51",
"marketCap": "4847623128",
"ticker": "BTC",
"volume": "29824000",
"delta24hr": "2.37",
"timestamp": 1418325595612,
"currency": "usd"
}
```
### Get Price in Other Currencies
#### `GET /coins/:ticker/price/:currency`
Example Query:
```
http://coins-api.herokuapp.com/coins/btc/price/chf
```
Response:
```json
{
"price": "368.25",
"currency": "chf"
}
```
## Run Locally
```sh
$ npm install
$ node app.js
```
## Deploy to Heroku
```sh
$ npm install
$ heroku create
$ (git add, git commit)
$ git push heroku master
```
## Credits
All the data was scraped from [CoinMarketCap](http://coinmarketcap.com/). The currency converter uses the [The Free Currency Converter API](http://www.freecurrencyconverterapi.com/). Additionally, this API documentation is modeled off the wonderful API documentation for [Hook](https://github.com/karan/Hook) by @karan.
## License
[MIT License](LICENSE)
[travis-url]: https://travis-ci.org/xasos/Coins
[travis-image]: https://travis-ci.org/xasos/Coins.svg?branch=master
[daviddm-url]: https://david-dm.org/xasos/Coins.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/xasos/Coins