gridsome-source-cryptocompare

gridsome-source-cryptocompare

Install

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

A gridsome source plugin for the Crypto Compare API.

Features

To date the plugin only offers 'Toplist by 24H Volume Subscriptions' data. Plans to addd more API calls are in the pipeline.

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 successfully.

Custom options can be passed to the plugin, this should be done inside gridsome.config.js

module.exports = {
  plugins: [
    {
      use: 'grid-source-crypto-compare',
      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 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