School project · Delayed data · Not financial adviceTerms
Skip to content
SINGULARITYTERMINALOpen the terminal
API reference

Every route this server exposes

Read live from /openapi.json each time you load this page, so it cannot drift from the software.

This document

Title
Project Singularity Phase 8
Version
8.0.0
Paths
288
Operations
306
Groups
89

Counted from the document this page just fetched. Reload to re-count.

Nothing on this page is hardcoded. The list below is the running server's own schema, grouped by the first two path segments. If a route is added or removed, this page changes on the next reload without anyone editing it.

Page routes are registered with `include_in_schema=False` and therefore do not appear here — this is the machine-readable surface, not the site map.

Raw /openapi.jsonOpenAPI schema/redoc

Before you call anything

A published API with issued keys and per-key quotas is on the roadmap and is not yet built. Until it ships there is no key to request and no documented rate limit to design against.

Routes under /api/user/ and /api/auth/ are per-account and require a session cookie. Everything else reads public market data and answers unauthenticated.

A route can answer HTTP 200 and still be telling you a source was unavailable. Read the body: this app reports an explicit unavailable state rather than substituting a plausible number, and the two look identical to a status-code check.

Routes

/

1
GET
/
Landing Root

/about

1
GET
/about
About Page

/account

1
GET
/account
Account Page

/api/account

17
GET
/api/account/csrf
Csrf Token
GET
/api/account/me
Whoami
GET
/api/account/operator/audit
Operator Audit
limit (query)
GET
/api/account/operator/features
Operator Features
POST
/api/account/operator/features
Operator Set Feature
POST
/api/account/operator/issue
Issue Custom Id
GET
/api/account/operator/register
Operator Register
GET
/api/account/operator/requests
Operator Request Ledger
POST
/api/account/operator/revoke
Operator Revoke
POST
/api/account/operator/tier
Set Tier
GET
/api/account/profile
Read Profile
POST
/api/account/profile
Write Profile
GET
/api/account/profile/questions
Profile Questions
GET
/api/account/recommendations
Recommendations
POST
/api/account/reset/complete
Reset Complete
POST
/api/account/reset/request
Reset Request
GET
/api/account/tiers
List Tiers

/api/activity

7
POST
/api/activity/events
Activity Events
GET
/api/activity/lock
Activity Read Lock
POST
/api/activity/lock
Activity Write Lock
GET
/api/activity/recommendation
Activity Recommendation
selected (query)size (query)
POST
/api/activity/reset
Activity Reset
GET
/api/activity/schema
Activity Schema
GET
/api/activity/summary
Activity Summary

/api/alerts

20
GET
/api/alerts/channels
Alerts Channels
GET
/api/alerts/deliveries
Alerts Deliveries
kind (query)limit (query)
GET
/api/alerts/digest
Alerts Digest
day (query)
POST
/api/alerts/digest/send
Alerts Digest Send
day (query)
GET
/api/alerts/events
Alerts Events
since_id (query)limit (query)unacknowledged_only (query)
POST
/api/alerts/events/ack
Alerts Ack
GET
/api/alerts/metrics
Alerts Metrics
POST
/api/alerts/mrep/send
Alerts Mrep Send
GET
/api/alerts/mrep/status
Alerts Mrep Status
POST
/api/alerts/parse
Alerts Parse
GET
/api/alerts/prefs
Alerts Get Prefs
POST
/api/alerts/prefs
Alerts Save Prefs
GET
/api/alerts/rules
Alerts List Rules
POST
/api/alerts/rules
Alerts Create Rule
DELETE
/api/alerts/rules/{rule_id}
Alerts Delete Rule
rule_id (path)
PATCH
/api/alerts/rules/{rule_id}
Alerts Update Rule
rule_id (path)
POST
/api/alerts/rules/{rule_id}/test
Alerts Test Rule
rule_id (path)
GET
/api/alerts/scheduler
Alerts Scheduler Status
POST
/api/alerts/scheduler/run
Alerts Scheduler Run
force (query)
POST
/api/alerts/series
Alerts Series

/api/allq

1
GET
/api/allq/{ticker}
Allq
ticker (path)

/api/anr

1
GET
/api/anr/{ticker}
Analyst Recommendations
ticker (path)

/api/assets

13
GET
/api/assets/argument/{symbol}
Argument
symbol (path)asset_class (query)
GET
/api/assets/classes
List Classes
GET
/api/assets/crypto-options/{currency}
Crypto Options
currency (path)
GET
/api/assets/crypto-sector
Crypto Sector
GET
/api/assets/crypto/{symbol}
Crypto
symbol (path)coingecko_id (query)
GET
/api/assets/fx/{base}/{quote}
Fx
base (path)quote (path)
GET
/api/assets/holidays/{country}
Holidays
country (path)year (query)
GET
/api/assets/indicators/{ticker}
Indicators
ticker (path)range (query)interval (query)select (query)
GET
/api/assets/inflation
Inflation
series (query)
GET
/api/assets/options/{symbol}
Listed Options
symbol (path)
GET
/api/assets/rates
Rates
GET
/api/assets/resolve
Resolve
q (query)
GET
/api/assets/short-volume/{symbol}
Short Volume
symbol (path)

/api/auth

15
POST
/api/auth/delete
Auth Delete Account
POST
/api/auth/developer-login
Auth Developer Login
POST
/api/auth/developer-logout
Auth Developer Logout
GET
/api/auth/export
Auth Export
GET
/api/auth/history
Auth History
GET
/api/auth/limits
Auth Limits
POST
/api/auth/login
Auth Login
POST
/api/auth/logout
Auth Logout
GET
/api/auth/me
Auth Me
POST
/api/auth/password
Auth Change Password
POST
/api/auth/profile
Auth Profile
POST
/api/auth/register
Auth Register
GET
/api/auth/sessions
Auth Sessions
POST
/api/auth/sessions/revoke
Auth Revoke Session
GET
/api/auth/status
Auth Status

/api/benchmark

1
GET
/api/benchmark/{ticker}
Benchmark Set
ticker (path)

/api/beta

1
GET
/api/beta/{ticker}
Beta
ticker (path)benchmark (query)range_name (query)

/api/bi

1
GET
/api/bi
Bi
node (query)limit (query)offset (query)q (query)sources (query)categories (query)forms (query)start_date (query)end_date (query)sort (query)

/api/billing

1
POST
/api/billing/webhook
Billing Webhook

/api/bmc

4
GET
/api/bmc/certificate
Bmc Certificate
name (query)
GET
/api/bmc/course
Bmc Course
GET
/api/bmc/lesson/{module_id}
Bmc Lesson
module_id (path)
POST
/api/bmc/quiz/validate
Bmc Quiz Validate

/api/brc

2
GET
/api/brc/firms
Brc Firms
q (query)
GET
/api/brc/search
Brc Search
firm (query)analyst (query)ticker (query)keyword (query)

/api/calendar

1
GET
/api/calendar
Events Calendar
start (query)end (query)types (query)tickers (query)

/api/cf

5
GET
/api/cf/{ticker}
Company Filings
ticker (path)
GET
/api/cf/document
Company Filing Document
url (query)offset (query)limit (query)q (query)
GET
/api/cf/exhibit
Company Filing Exhibit
ticker (query)accession (query)offset (query)limit (query)q (query)
GET
/api/cf/summary
Company Filing Summary
url (query)ticker (query)form (query)max_sentences (query)
GET
/api/cf/transcript-search/{ticker}
Company Transcript Search
ticker (path)

/api/chart

1
GET
/api/chart/{ticker}
Phase5 Chart
ticker (path)range (query)interval (query)

/api/contact

3
POST
/api/contact
Contact Submit
GET
/api/contact/config
Contact Config
GET
/api/contact/messages
Contact Messages

/api/counterparties

1
GET
/api/counterparties/{ticker}
Disclosed Counterparties
ticker (path)

/api/des

1
GET
/api/des/{ticker}
Security Description
ticker (path)

/api/ds

1
GET
/api/ds/{ticker}
Document Search
ticker (path)q (query)limit (query)

/api/ecmi

1
GET
/api/ecmi
Ecmi
event (query)asset (query)

/api/eco

1
GET
/api/eco
Eco
region (query)

/api/ee

1
GET
/api/ee/{ticker}
Earnings Estimates
ticker (path)

/api/eqs

2
GET
/api/eqs
Eqs
market_cap_min (query)pe_max (query)price_min (query)volume_min (query)filters (query)
GET
/api/eqs/criteria
Eqs Criteria

/api/fa

1
GET
/api/fa/{ticker}
Financial Analysis
ticker (path)

/api/feature-readiness

1
GET
/api/feature-readiness/{feature_id}/{ticker}
Feature Readiness
feature_id (path)ticker (path)

/api/federal

1
GET
/api/federal/{ticker}
Federal Exposure
ticker (path)

/api/filings

7
GET
/api/filings/corpus-manifest
Filings Corpus Manifest
refresh (query)
GET
/api/filings/customers/{ticker}
Filings Customers
ticker (path)subsidiaries (query)
GET
/api/filings/diff/{ticker}
Filings Diff
ticker (path)form (query)
GET
/api/filings/earnings-document/{ticker}/{accession}
Filings Earnings Document
ticker (path)accession (path)q (query)
GET
/api/filings/earnings/{ticker}
Filings Earnings
ticker (path)limit (query)
GET
/api/filings/search
Filings Search
q (query)ticker (query)forms (query)limit (query)
GET
/api/filings/timeline/{ticker}
Filings Timeline
ticker (path)limit (query)

/api/folio

6
GET
/api/folio/{cik}
Folio Portfolio
cik (path)
GET
/api/folio/roster
Folio Roster
GET
/api/folio/watch
Folio Watch List
DELETE
/api/folio/watch/{cik}
Folio Watch Remove
cik (path)
POST
/api/folio/watch/{cik}
Folio Watch Add
cik (path)
POST
/api/folio/watch/check
Folio Watch Check
force (query)

/api/fxfc

1
GET
/api/fxfc
Fx Forecast
pairs (query)

/api/fxfm

1
GET
/api/fxfm/{ticker}
Fxfm
ticker (path)target1 (query)target2 (query)horizon (query)

/api/fxip

1
GET
/api/fxip
Fxip
region (query)

/api/geo

2
GET
/api/geo/borders/{kind}
Geo Borders
kind (path)
GET
/api/geo/events
Geo Events
hours (query)limit (query)layers (query)

/api/goo

1
POST
/api/goo/template
Goo Template

/api/health

1
GET
/api/health
Health

/api/hp

2
GET
/api/hp/{ticker}
Historical Prices
ticker (path)start (query)end (query)interval (query)indicators (query)
GET
/api/hp/{ticker}/export
Historical Prices Export
ticker (path)start (query)end (query)interval (query)format (query)indicators (query)

/api/intel

7
GET
/api/intel/anomalies/{ticker}
Intel Anomalies
ticker (path)threshold (query)
GET
/api/intel/dependencies
Scan Dependencies
GET
/api/intel/identifier/{kind}/{value}
Resolve Identifier
kind (path)value (path)
GET
/api/intel/sanctions
Screen Name
name (query)
GET
/api/intel/sanctions/status
Sanctions Status
GET
/api/intel/symbology
Resolve Symbols
symbols (query)
GET
/api/intel/symbology/{symbol}
Resolve Symbol
symbol (path)

/api/lab

3
GET
/api/lab/{ticker}
Custom Lab
ticker (path)metrics (query)peers (query)
GET
/api/lab/dcf/{ticker}
Lab Dcf
ticker (path)driver (query)benchmark (query)assume (query)
GET
/api/lab/fx/{currency}
Lab Fx
currency (path)basis (query)on (query)

/api/live

11
GET
/api/live/app-reviews/{ticker}
App Reviews
ticker (path)
GET
/api/live/crop/{ticker}
Crop Climate
ticker (path)
GET
/api/live/dark-pool/{ticker}
Dark Pool
ticker (path)
GET
/api/live/edgar-search
Edgar Full Text Search
q (query)ticker (query)forms (query)date_range (query)scope (query)
GET
/api/live/federal-awards/{ticker}
Federal Awards
ticker (path)
GET
/api/live/housing/{ticker}
Housing Market
ticker (path)
GET
/api/live/hq-airspace/{ticker}
Hq Airspace
ticker (path)
GET
/api/live/jobs/{ticker}
Job Postings
ticker (path)
GET
/api/live/retail-chatter/{ticker}
Retail Chatter
ticker (path)
GET
/api/live/token-supply/{ticker}
Token Supply
ticker (path)
GET
/api/live/trials/{ticker}
Clinical Trials
ticker (path)

/api/lookup

1
GET
/api/lookup
Symbol Lookup
q (query)limit (query)

/api/meta

7
GET
/api/meta/phase2
Phase2 Meta
GET
/api/meta/phase3
Phase3 Meta
GET
/api/meta/phase4
Phase4 Meta
GET
/api/meta/phase5
Phase5 Meta
GET
/api/meta/phase6
Phase6 Meta
GET
/api/meta/phase7
Phase7 Meta
GET
/api/meta/phase8
Phase8 Meta

/api/module1

1
GET
/api/module1/{ticker}/{metric_category}
Module1 Metric
ticker (path)metric_category (path)

/api/mrep

2
GET
/api/mrep
Market Report
tickers (query)
POST
/api/mrep/schedule
Market Report Schedule

/api/news

7
GET
/api/news/cn/{ticker}
Company News
ticker (path)
GET
/api/news/hub/{ticker}
News Hub
ticker (path)q (query)min_importance (query)
GET
/api/news/image/{article_id}
News Image
article_id (path)
GET
/api/news/read
News Reader
url (query)
GET
/api/news/search/{ticker}
News Search
ticker (path)q (query)min_importance (query)
GET
/api/news/social
News Social
ticker (query)q (query)
GET
/api/news/top
Top News

/api/nlrt

2
GET
/api/nlrt
News Alerts
tickers (query)keywords (query)operator (query)delivery (query)
POST
/api/nlrt/deliver
News Alerts Deliver

/api/offline

1
GET
/api/offline
Offline State

/api/ownership

4
GET
/api/ownership/government/{ticker}
Ownership Government
ticker (path)revenue (query)
GET
/api/ownership/insiders/{ticker}
Ownership Insiders
ticker (path)
GET
/api/ownership/institutional/{ticker}
Ownership Institutional
ticker (path)cusip (query)
GET
/api/ownership/short-interest/{ticker}
Ownership Short Interest
ticker (path)

/api/pages

2
GET
/api/pages/environment
Pages Environment
GET
/api/pages/team
Pages Team

/api/patterns

1
GET
/api/patterns/complexity/{ticker}
Pattern Complexity Route
ticker (path)range (query)

/api/phase8

1
GET
/api/phase8/pdf
Phase8 Pdf
url (query)

/api/plans

1
GET
/api/plans
Plans

/api/portfolio

3
GET
/api/portfolio
Portfolio Snapshot
POST
/api/portfolio/position
Portfolio Upsert
DELETE
/api/portfolio/position/{ticker}
Portfolio Delete
ticker (path)

/api/psychology

1
GET
/api/psychology/{mode}/{ticker}
Executive Psychology
mode (path)ticker (path)

/api/rg

1
GET
/api/rg
Relative Graph
tickers (query)range (query)

/api/runtime

1
GET
/api/runtime/diagnostics/{feature_id}
Runtime Diagnostics
feature_id (path)

/api/rv

1
GET
/api/rv/{ticker}
Relative Valuation
ticker (path)peers (query)

/api/sdrv

1
GET
/api/sdrv/{ticker}
Sdrv
ticker (path)

/api/search

1
GET
/api/search/benchmarks
Benchmark Search
q (query)

/api/secf

1
GET
/api/secf/search
Secf Search
query (query)maturity_start (query)maturity_end (query)

/api/security

1
GET
/api/security/events
Security Events
limit (query)min_severity (query)

/api/session

1
GET
/api/session
Session State

/api/share

2
GET
/api/share
Share Index
GET
/api/share/{token}
Share View
token (path)

/api/source-health

3
GET
/api/source-health
Source Health Registry
POST
/api/source-health/check
Check Source
POST
/api/source-health/test
Test Provider

/api/sovr

1
GET
/api/sovr
Sovr

/api/splc

1
GET
/api/splc/{ticker}
Supply Chain
ticker (path)

/api/status

1
GET
/api/status
Agent Status Json

/api/stock

3
GET
/api/stock/{ticker}
Stock Lab
ticker (path)
GET
/api/stock/center/{ticker}
Stock Lab Center
ticker (path)
GET
/api/stock/nodes/{node}/{ticker}
Stock Lab Node
node (path)ticker (path)

/api/subsidiaries

1
GET
/api/subsidiaries/{ticker}
Subsidiary Tree
ticker (path)

/api/symbol

1
GET
/api/symbol/{ticker}
Symbol Check
ticker (path)

/api/user

43
DELETE
/api/user/{namespace}
User Namespace Clear
namespace (path)
GET
/api/user/{namespace}
User Namespace Read
namespace (path)
PATCH
/api/user/{namespace}
User Namespace Patch
namespace (path)
PUT
/api/user/{namespace}
User Namespace Write
namespace (path)
GET
/api/user/account/data-held
User Data Held
GET
/api/user/backtest/catalog
Backtest Catalog
POST
/api/user/backtest/run
Backtest Run
GET
/api/user/namespaces
User Namespaces
POST
/api/user/notebook/export
Notebook Export
GET
/api/user/notebook/highlights
Notebook Highlights
document_url (query)tag (query)include_archived (query)
POST
/api/user/notebook/highlights
Notebook Add Highlight
DELETE
/api/user/notebook/highlights/{highlight_id}
Notebook Delete Highlight
highlight_id (path)
PATCH
/api/user/notebook/highlights/{highlight_id}
Notebook Update Highlight
highlight_id (path)
POST
/api/user/notebook/highlights/{highlight_id}/archive
Notebook Archive Highlight
highlight_id (path)
GET
/api/user/notebook/shares
Shares List
POST
/api/user/notebook/shares
Shares Create
DELETE
/api/user/notebook/shares/{share_id}
Shares Revoke
share_id (path)
POST
/api/user/notebook/verify
Notebook Verify
POST
/api/user/objects/alerts/evaluate
User Objects Alerts Evaluate
GET
/api/user/objects/fields
User Objects Fields
POST
/api/user/objects/portfolio/import
User Objects Portfolio Import
POST
/api/user/objects/portfolio/value
User Objects Portfolio Value
POST
/api/user/objects/screen
User Objects Screen
GET
/api/user/objects/universe
User Objects Universe
POST
/api/user/objects/watchlists/action
User Objects Watchlist Action
GET
/api/user/replay/at
Replay At
screen (query)at (query)
GET
/api/user/replay/coverage
Replay Coverage
screen (query)
GET
/api/user/replay/screens
Replay Screens
POST
/api/user/replay/snapshots
Replay Capture
GET
/api/user/reports/catalog
Reports Catalog
POST
/api/user/reports/export
Reports Export
GET
/api/user/v1/pub/data/{namespace}
Read one stored namespace
namespace (path)
GET
/api/user/v1/pub/openapi.json
This API's schema
GET
/api/user/v1/pub/sheets
List the available sheets
GET
/api/user/v1/pub/whoami
Identify the calling key
GET
/api/user/v1/sheet/{sheet}.csv
One sheet as CSV
sheet (path)
GET
/api/user/v1/sheet/{sheet}.tsv
One sheet as TSV
sheet (path)
POST
/api/user/workspace/import
Workspace Import
POST
/api/user/workspace/validate
Workspace Validate
GET
/api/user/workspace/views
Views List
POST
/api/user/workspace/views
Views Create
DELETE
/api/user/workspace/views/{view_id}
Views Delete
view_id (path)
GET
/api/user/workspace/views/{view_id}
Views Read
view_id (path)

/api/ussw

1
GET
/api/ussw
Ussw

/api/v1

39
POST
/api/v1/behavioral/dark-pool/{ticker}
Dark Pool Divergence
ticker (path)
POST
/api/v1/behavioral/iv-skew
Iv Skew
GET
/api/v1/behavioral/iv-skew/{ticker}
Live Iv Skew
ticker (path)
POST
/api/v1/behavioral/stat-arb
Stat Arb
GET
/api/v1/behavioral/stat-arb/{ticker}
Live Stat Arb
ticker (path)
POST
/api/v1/behavioral/weekend-gap
Weekend Gap
GET
/api/v1/behavioral/weekend-gap/{ticker}
Live Weekend Gap
ticker (path)
GET
/api/v1/consumer/app-store/{app_id}
App Store
app_id (path)
POST
/api/v1/consumer/clinical
Clinical Trial
POST
/api/v1/consumer/housing
Housing Velocity
GET
/api/v1/consumer/meme
Meme Acceleration
GET
/api/v1/consumer/virality/{hashtag}
Virality
hashtag (path)product_class (query)
POST
/api/v1/exploits/esg/greenium
Greenium
GET
/api/v1/exploits/liquidity
Liquidity Drain
POST
/api/v1/exploits/lobbyist
Lobbyist Front Runs
POST
/api/v1/exploits/mempool/decode
Mempool Decode
POST
/api/v1/exploits/patent-troll
Patent Troll
POST
/api/v1/exploits/satellite/radiance
Satellite Radiance
POST
/api/v1/macro/climate
Micro Climate
POST
/api/v1/macro/diplomatic
Diplomatic Tone
POST
/api/v1/macro/fed/audio
Fed Audio
POST
/api/v1/macro/panic
Panic Derivative
POST
/api/v1/macro/supply/dark-fleet
Dark Fleet
POST
/api/v1/macro/supply/tanks
Tank Volumes
GET
/api/v1/niche/token-unlocks/{crypto_ticker}
Token Unlocks
crypto_ticker (path)
GET
/api/v1/niche/yield-curve/{base_ticker}
Yield Curve
base_ticker (path)
GET
/api/v1/options-surface/{ticker}
Options Surface
ticker (path)expiry (query)
POST
/api/v1/order-flow/options/{ticker}
Options Flow
ticker (path)
GET
/api/v1/order-flow/stop-loss/{ticker}
Live Stop Loss Map
ticker (path)
POST
/api/v1/order-flow/stop-loss/{ticker}
Stop Loss Map
ticker (path)
GET
/api/v1/order-flow/vwap/{ticker}
Live Anchored Vwap
ticker (path)
POST
/api/v1/order-flow/vwap/{ticker}
Anchored Vwap
ticker (path)
POST
/api/v1/order-flow/whale-trap/update
Whale Trap Update
GET
/api/v1/peers/{ticker}
Get Peers
ticker (path)
POST
/api/v1/shadow/jets
Jet Alerts
POST
/api/v1/shadow/jobs/{company_id}
Job Pivot
company_id (path)
GET
/api/v1/shadow/patents/{ticker}
Patent Moat
ticker (path)assignee (query)
POST
/api/v1/shadow/ransomware
Ransomware Scan
GET
/api/v1/telemetry/{module_id}
Omni Telemetry
module_id (path)

/api/w

2
GET
/api/w
Workflow Watchlist
tickers (query)
GET
/api/w/signal/{ticker}
Workflow Watchlist Signal
ticker (path)

/api/wacc

1
GET
/api/wacc/{ticker}
Wacc
ticker (path)benchmark (query)

/api/warm

1
GET
/api/warm
Warm Cache
token (query)

/api/xltp

2
GET
/api/xltp/download
Xltp Download
template (query)ticker (query)
GET
/api/xltp/templates
Xltp Templates

/app

1
GET
/app
App Home

/checkout

1
GET
/checkout
Checkout Page

/classic

1
GET
/classic
Classic Landing

/demo

1
GET
/demo
Demo Entry

/dev

1
GET
/dev
Dev Console Page

/enter

2
GET
/enter
Enter Form
POST
/enter
Enter Submit

/help

1
GET
/help
Help Page

/pricing

1
GET
/pricing
Pricing Page

/settings

1
GET
/settings
Settings Page

/status

1
GET
/status
Agent Status Page