Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 4.47 KB

README.md

File metadata and controls

68 lines (46 loc) · 4.47 KB
Raw

FINNHUB

2.7.20 v3

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

Known Issues

CACHE_MAX_AGE interaction with Heartbeat messages

If CACHE_MAX_AGE is set below a current heartbeat interval (60000ms), the extended cache TTL feature for out-of-market-hours that relies on heartbeats will not work.

Environment Variables

Required? Name Description Type Options Default
API_ENDPOINT The HTTP URL to retrieve data from string https://finnhub.io/api/v1
✅ API_KEY A Finnhub API key string
WS_API_ENDPOINT The WS URL to retrieve data from string wss://ws.finnhub.io
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 60
all-in-one 300 limit is for market data, not fundamental data

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string commodities, commodity-quote, common, equity-quote, forex-quote, forex, quote, stock quote

Quote Endpoint

Supported names for this endpoint are: commodities, commodity-quote, common, equity-quote, forex, forex-quote, quote, stock.

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
exchange The exchange to fetch data for string
endpointName Is set automatically based on request endpoint alias/name. Providing a custom value has no effect string

Example

Request:

{
  "data": {
    "endpoint": "quote",
    "base": "EUR",
    "quote": "USD"
  }
}

MIT License