https://github.com/lionsharecapital/lionshare-api

Realtime cryptocurrency API
https://github.com/lionsharecapital/lionshare-api

bitcoin ethereum koa nodejs websockets

Last synced: 15 days ago
JSON representation

Realtime cryptocurrency API

• Host: GitHub
• URL: https://github.com/lionsharecapital/lionshare-api
• Owner: lionsharecapital
• Created: 2017-01-22T07:37:02.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-11T04:12:48.000Z (almost 7 years ago)
• Last Synced: 2024-10-14T01:22:19.480Z (about 1 month ago)
• Topics: bitcoin, ethereum, koa, nodejs, websockets
• Language: JavaScript
• Size: 104 KB
• Stars: 263
• Watchers: 13
• Forks: 48
• Open Issues: 55
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# api.lionshare.capital

API that powers [Lionshare](https://lionshare.capital) by providing both historical (REST)

and realtime time (websocket) cryptocurrency market data. The data is sourced

from [GDAX](https://gdax.com), [Poloniex](https://poloniex.com/), and

[Coinmarketcap](https://coinmarketcap.com/).

Build with Node, Koa 2, `uws` and Redis.

## API Endpoints

### Prices 

`GET https://api.lionshare.capital/api/prices`

#### Params

- `period: hour | day | week | month | year`

Returns historic prices for supported digital currencies

> Example response:

```

{

  "data": {

    "BTC": [924.2, 924.63, 923.82, 923.02, 924.82, ...],

    "ETH": [10.74, 10.8, 10.79, 10.82, 10.82, 10.84, 10.78, ...],

    "LTC": [3.88, 3.86, 3.85, 3.85, 3.86, 3.86, 3.84, ...]

    ...

  }

}

```

### Markets

`GET https://api.lionshare.capital/api/markets`

Returns market capitalization data

> Example response:

```

{

  "data": {

    "BTC": 14718750986, 

    "ETH": 943628626,

    "LTC": 188560718,

    ...

  }

}

```

## Development

Redis is required for caching and a valid connection URL should be set to `REDIS_URL`

environment variable before running the development server. `.env` is loaded on

startup. Make sure that you have `redis` installed and running (`redis-server`)

for local development.

```

yarn

yarn dev

```

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/lionsharecapital/lionshare-api)

## License

MIT