Help & Documentation

Welcome to the help center. Guides, quick answers, API references and troubleshooting for the realtime financial-reports scoring system. Use the table of contents on the left to jump to a section.

Getting started

1. Create an account and subscribe to a plan that includes realtime ingestion.
2. Connect a data source: FMP / broker feed / CSV upload. See Data ingestion below.
3. Enable automatic scoring in Settings → Pipelines and set your alert thresholds.
4. Use Latest Reports and Realtime to monitor live activity.

Account & access

Account management and permissions.

• Profile & account: click the avatar on the topbar → Profile & account.
• Team access: invite teammates from Settings → Team. Grant role: Viewer / Analyst / Admin.
• API keys: generate keys in Settings → API. Keep keys secret and rotate periodically.

Data ingestion (API / CSV)

Feed reports using three methods: API POST, CSV upload, or connector. Example JSON payload for the API:

POST /api/v1/reports/ingest
Authorization: Bearer <API_KEY>
Content-Type: application/json

{
  "symbol":"AAPL",
  "report_date":"2025-11-10",
  "type":"qtr",
  "income": { "revenue": 1000000, "net_income": 120000 },
  "eps": 1.45,
  "consensus": { "revenue": 980000, "eps": 1.32 }
}
        

For CSV uploads use the Reports → Upload page. Required columns: symbol,report_date,field,value.

Scoring methodology (overview)

• Revenue (40%) — vs consensus & prior period.
• EPS surprise (30%) — normalized for one-off items.
• Guidance (20%) — changes to forward guidance.
• Quality & adjustments (10%) — unusual items, revisions, cash-flow signals.

See the Education section for the full mathematical breakdown and examples.

Integration & webhooks

You can configure webhooks to receive score updates when new reports are ingested. Example:

POST /webhook/your-endpoint
{
  "symbol":"AAPL",
  "report_date":"2025-11-10",
  "score": 87,
  "details": { "revenue_delta": 0.04, "eps_surprise": 0.12 }
}
        

FAQ