Skip to content

Latest commit

 

History

History
259 lines (188 loc) · 10.6 KB

README.md

File metadata and controls

259 lines (188 loc) · 10.6 KB
Raw

COINPAPRIKA

2.1.10 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required? Name Description Type Options Default
API_ENDPOINT The HTTP URL to retrieve data from string
API_KEY An API key for Coinpaprika string
WS_API_ENDPOINT The WS API endpoint for Coinpaprika string wss://streaming.coinpaprika.com/ticks
WS_ENABLED Whether data should be returned from websocket or not boolean false

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
free 10 69.44 50k/mo for free
pro 10 347.22 250k/mo for pro
business 10 1388.888 1mil/mo for business
enterprise 10 unlimited per month

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string coins, crypto-vwap, crypto, dominance, globalmarketcap, marketcap, price, volume, vwap crypto

Crypto Endpoint

Supported names for this endpoint are: crypto, price.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string
coinid The coin ID (optional to use in place of base) string
resultPath The path to the result within the asset quote in the provider response (only for REST) string market_cap, price, volume_24h

Example

Request:

{
  "data": {
    "endpoint": "crypto",
    "base": "AAAA",
    "coinid": "eth-ethereum",
    "quote": "USD",
    "resultPath": "price"
  }
}
Additional Examples

Request:

{
  "data": {
    "endpoint": "crypto",
    "base": "ETH",
    "quote": "USD",
    "resultPath": "volume_24h"
  }
}

Globalmarketcap Endpoint

Supported names for this endpoint are: dominance, globalmarketcap.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ market quote, to The symbol of the currency to convert to string
resultPath The path to the result within the asset quote in the provider response string _dominance_percentage, market_cap_

Example

Request:

{
  "data": {
    "endpoint": "globalmarketcap",
    "market": "USD",
    "resultPath": "market_cap_"
  }
}

Coins Endpoint

coins is the only supported name for this endpoint.

Input Params

There are no input parameters for this endpoint.

Example

Request:

{
  "data": {
    "endpoint": "coins"
  }
}

Vwap Endpoint

Supported names for this endpoint are: crypto-vwap, vwap.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
hours Number of hours to get VWAP for number 24
coinid The coin ID (optional to use in place of base) string

Example

Request:

{
  "data": {
    "endpoint": "vwap",
    "base": "ETH",
    "hours": 24
  }
}

Volume Endpoint

volume is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string
coinid The coin ID (optional to use in place of base) string
resultPath The path to the result within the asset quote in the provider response (only for REST) string market_cap, price, volume_24h

Example

Request:

{
  "data": {
    "endpoint": "volume",
    "base": "AAAA",
    "coinid": "eth-ethereum",
    "quote": "USD",
    "resultPath": "price"
  }
}
Additional Examples

Request:

{
  "data": {
    "endpoint": "volume",
    "base": "ETH",
    "quote": "USD",
    "resultPath": "volume_24h"
  }
}

Marketcap Endpoint

marketcap is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string
coinid The coin ID (optional to use in place of base) string
resultPath The path to the result within the asset quote in the provider response (only for REST) string market_cap, price, volume_24h

Example

Request:

{
  "data": {
    "endpoint": "marketcap",
    "base": "AAAA",
    "coinid": "eth-ethereum",
    "quote": "USD",
    "resultPath": "price"
  }
}
Additional Examples

Request:

{
  "data": {
    "endpoint": "marketcap",
    "base": "ETH",
    "quote": "USD",
    "resultPath": "volume_24h"
  }
}

MIT License