Skip to content

Access

Run it on your own machine.

Infrastructure runs in Docker; the API, workers and frontend run natively. Whatever you leave blank in the environment file disables its connector cleanly, and the panels it would have fed say which key is missing rather than breaking.

SRCConnector boardSCHEMATIC · NO DATA
MKTEquity indices——
FXCross rates——
RTSSovereign curves——
CMDTCommodity complexes——
CRYDigital assets——
MACMacro series——

Getting started

Six commands, in order.

  1. 1infrastructure
    docker compose up -d postgres redis
  2. 2python environment
    py -3.11 -m venv .venv && .venv\Scripts\activate
  3. 3dependencies
    pip install -r requirements-torch-cpu.txt
    pip install -r requirements-dev.txt
  4. 4configuration
    cp .env.example .env    # blanks disable their connector cleanly
  5. 5migrations
    alembic upgrade head
  6. 6frontend
    cd frontend && npm install && npm run dev    # :3100

Ports

Deliberately not the defaults.

The same machine may also run god-engine's stack, and a silent connection to the wrong database is the worst available failure mode.

Postgres5433not 5432
Redis6380not 6379
API8110not 8000
Frontend3100not 3000

Environment

What each key unlocks, and what it costs.

FRED_API_KEY

Rates, Macro and parts of Cockpit

free · instant
SEC_CONTACT

Filings — a contact string for the fair-use user agent

free
POLYGON_API_KEY

Intraday equity coverage

paid · optional
FINNHUB_API_KEY

Supplementary equity and filing data

paid · optional
TWELVEDATA_API_KEY

Intraday FX and equities

paid · optional

Model weights

Fetched, verified, then moved into place.

Never in git

The weights file is gitignored and never enters git-lfs. It is fetched, verified and placed by a script.

Verified, then renamed

Size and sha256 must match the recorded checksums before the file is moved into place.

Vendored layer is read-only

A modified file under temporal/ fails CI. Product behaviour belongs in wft/forecast/.

Own migration lineage

World Finance Terminal keeps its own alembic history from 0001 rather than sharing a sibling project’s.

Documentation in the repository

  • docs/API_KEYS.mdwhich keys unlock which sections
  • docs/RUNBOOK.mdoperating the stack day to day
  • docs/AWS_DEPLOY.mddeployment
  • docs/FORECAST_BENCHMARK.mdbenchmark method behind the record
  • docs/STATUS.mdwhat is bound today