Skip to main content
POST
Generate Stock Report

How It Works

This endpoint uses async job processing for generating comprehensive stock reports:
  1. Submit Request: POST the stock symbol to /v1/stock-report
  2. Receive Job ID: Get a job ID and polling URL immediately
  3. Poll for Status: Check /v1/jobs/{job_id} until status is completed
  4. Get Report URLs: The completed job contains URLs to PDF, HTML, and JSON reports
Report generation typically takes 5-10 minutes. Reports include financial analysis, valuation metrics, AI-generated insights, and more.

Request Body

If force is false and a recent report exists (generated within the last 30 days), the cached report URLs will be returned immediately.

Response (202 Accepted)

When the job is created:

Completed Response

When the job completes, GET /v1/jobs/{job_id} returns:

Example: Polling for Results

Error Responses

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Body

application/json

Request body for stock report generation

symbol
string
required

Stock symbol (e.g., AAPL.O for Apple Inc)

Example:

"AAPL.O"

force
boolean
default:false

Force regeneration even if recent report exists

Example:

false

Response

Job created successfully. Poll the check_url for results.

job_id
string

Unique job identifier

status
enum<string>

Initial job status

Available options:
pending
symbol
string

Stock symbol being processed

force
boolean

Whether force regeneration was requested

check_url
string

URL to poll for job status

estimated_duration_seconds
integer

Estimated processing time in seconds

message
string

Human-readable status message