Create Briefing
Create a new briefing with topic, tickers, and schedule in a single call.
Create a new briefing schedule with topic, tickers, and delivery timing in a single API call. The briefing will be automatically generated and delivered via email at the scheduled time.Documentation Index
Fetch the complete documentation index at: https://docs.linqalpha.com/llms.txt
Use this file to discover all available pages before exploring further.
Stock Selection
You can specify stocks in two ways:stock_ids(recommended) — Internal stock UUIDs. Use the Map Tickers endpoint to convert ticker symbols to stock IDs first.tickers— Ticker symbols (e.g.["AAPL", "MSFT"]). Automatically resolved to stock IDs via the ticker mapping service. If resolution fails, the request will return an error.
stock_ids and tickers are provided, stock_ids takes priority.
Scheduled Time Format
Thescheduled_time field must be in 12-hour AM/PM format:
"9:00 AM","3:30 PM","12:00 PM"
Timezone
Must be a valid IANA timezone identifier. Common examples:| Region | Timezone |
|---|---|
| Korea | Asia/Seoul |
| Hong Kong | Asia/Hong_Kong |
| China | Asia/Shanghai |
| Singapore | Asia/Singapore |
| Taiwan | Asia/Taipei |
| Japan | Asia/Tokyo |
| India | Asia/Calcutta |
| Indonesia | Asia/Jakarta |
| Malaysia | Asia/Kuala_Lumpur |
| Australia | Australia/Sydney |
| UK | Europe/London |
| US East | America/New_York |
| US West | America/Los_Angeles |
| US Central | America/Chicago |
| UTC | UTC |
Language
Supported values:English, Spanish, French, German, Italian, Portuguese, Dutch, Hindi, Japanese, Chinese, Finnish, Korean, Polish, Russian, Turkish, Ukrainian, Vietnamese. Pass null for auto-detection.
Authentication
For platform API keys, you can optionally passorganization_id, user_id, and user_email in the request body to specify which user the briefing is created for.Authorizations
Body
Briefing instructions/topic
Time in h:mm AM/PM format. Examples: '9:00 AM', '3:30 PM'
IANA timezone identifier (e.g. America/New_York, Asia/Seoul, Europe/London)
Internal stock UUIDs (preferred). Use /v1/map_tickers to convert ticker symbols.
Ticker symbols (e.g. AAPL, 9988.HK). Auto-resolved to stock_ids.
Output language (null = auto-detect)
English, Spanish, French, German, Italian, Portuguese, Dutch, Hindi, Japanese, Chinese, Finnish, Korean, Polish, Russian, Turkish, Ukrainian, Vietnamese daily, weekly, monthly Day of week for weekly frequency (0=Sun, 1=Mon, ..., 6=Sat)
0 <= x <= 6Day of month for monthly frequency
1 <= x <= 31Custom briefing title (auto-generated if omitted)
Data source: tfs_only (news+filings), rms_only (uploaded documents), both
tfs_only, rms_only, both Attach briefing as PDF to delivery email
Enable/disable the schedule
RMS source configurations for storage-based briefing
Link to watchlist group for dynamic ticker sync
Use briefing title as fixed email subject
Organization ID for platform API keys
User ID for platform API keys
User email for platform API keys