gridsome-source-cryptocompare


![License]()
!Hackage-Deps
!GitHub issues

A gridsome source plugin for the CryptoCompare API.

Install

- yarn add gridsome-source-cryptocompare
- npm install gridsome-source-cryptocompare

Features

To date the plugin only offers _'Toplist by 24H Volume Subscriptions'_. Plans to addd more API calls are in the pipeline.
- Price _(the plugin only supports single tsyms ATM)_
- Historical Data
- Pair Mapping
- News Articles

Basic usage

When your the project has successfully built a success message will appear to indicate that the API has connected and results have been returned from the API.


Custom options can be passed to the plugin, this should be done inside __gridsome.config.js__

``js
module.exports = {
plugins: [
{
use: 'grid-source-cryptocompare',
options: {
apiKey: 'your-api-key',
limit: 20,
currency: 'EUR',
}
}
]
}
`


Options

#### apiKey:
- Type: string
- Default: not-set
- Required: false

_refer to the CryptoCompare API docs for more information about API keys:_
https://min-api.cryptocompare.com/documentation

#### limit:
- Type: number
- Default: 10
- Required: false

The number of coins to return in the toplist, default 10, min 10, max 100.

#### page:
- Type: number
- Default: 0
- Required: false

The pagination for the request. 0 would return coins 0-50, 1 returns coins 50-100

#### currency:
- Type: string
- Default: 'GPB'
- Required: true

The currency symbol to convert into

#### ascending:
- Type: boolean
- Default: true
- Required: false

#### sign:
- Type: boolean
- Default: false
- Required: false`

If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts

Was this plugin useful?

If you found this plugin _useful_,
please ⭐️the project to show your appreciation!


In the spirit of open-source, share this project with others in the community who might find it useful 😀