BoxLang 🚀 A New JVM Dynamic Language Learn More...

FinnHub

v1.0.2 Modules

FinnHub CFML API wrapper

Wraps the FinnHub API for easy CFML usage using the Hyper ColdBox module.

Getting Started

  1. Install this module - box install FinnHub
  2. Configure FinnHub API secrets using .env
  3. OR configure FinnHub API via ColdBox moduleSettings

Environment Variable Configuration

FinnHub can mainly be configured using environment variables:

  • FINNHUB_API_KEY - Required API key for authenticating with the FinnHub API
  • FINNUHB_API_URL - base URL of the FinnHub API.

You'll need to either use commandbox-dotenv to automatically populate environment variables from the .env file on server start, or manually read this file to populate environment variables inside your application.

# .env file
# FinnHub API Credentials
FINNHUB_API_KEY=
FINNHUB_API_URL=https://finnhub.io/api/v1

ColdBox Module Configuration via ModuleSettings

Set this in config/ColdBox.cfc in the configure() method:

moduleSettings.finnHub = {
    apiKey : "blablasecret",
    apiURL : "my.url"
};

v1.0.2

21 Jul 2021 — 14:26: 34 UTC

other

  • *: 🐛 FIX: Correct github username in box.json (5524805)
  • *: 🐛 FIX: Fix debugging for semantic release (a527418)
  • *: 👌 IMPROVE: More GA release debugging (f6c6bf8)
  • *: 🐛 FIX: More GA debugging (2d763fe)
  • *: 👌 IMPROVE: Add debugging for semantic release (822d72f)
  • *: 🐛 FIX: Correct main "release" GA workflow (c5a071d)
  • *: Merge pull request #1 from michaelborn/feat/githubActions (88cd30c)
  • *: 👌 IMPROVE: Improve GA release workflow (60d556d)
  • *: 👌 IMPROVE: Drop Adobe@2016 support (0345920)
  • *: 🐛 FIX: Correct .env variables in GA builds (2b6946e)
  • *: 🐛 FIX: Correct tests server start and result location (b6a7ed9)
  • *: 🐛 FIX: Correct GA secrets (6d1515c)
  • *: 🐛 FIX: More GA fixes (fec19b5)
  • *: 🐛 FIX: Correct box.json installation in GA (15675ed)
  • *: 🐛 FIX: Corrected testbox results path in github actions (dc73fc3)
  • *: fix: Correct github actions workflow syntax (347f46d)
  • *: Initial commit (8d14846)

$ box install finnhub

No collaborators yet.
 
  • {{ getFullDate("2021-07-21T13:48:07Z") }}
  • {{ getFullDate("2021-07-21T14:26:38Z") }}
  • 1,482
  • 1