API Quickstart
Start with the Alpha Analyst API — create a key, resolve a company, then pull filings, financials, and the rest of the catalog.
The API exposes the same data as the Alpha Analyst platform: resolve a company once, then read SEC and EDINET filings as markdown, standardized financials, XBRL facts, screeners, FX spots, and your own uploads. Every call is JSON with an API key.
If you landed here first, follow the steps below. If you use Claude, Cursor, or ChatGPT, see MCP instead—another surface, not a substitute for these REST endpoints.
Catalog at a glance
- Company identity — Turn a ticker, name, CIK, or LEI into one
idyou reuse on every other endpoint. - Filings & documents — Search and read exhibits across US EDGAR, Japan EDINET, and files you uploaded.
- Numbers — Standardized statements, fundamentals time series, XBRL tags, and a latest snapshot screener.
- Markets — Dated price and metric series, plus latest forex spots for currency conversion.
- Your workspace — Watchlists and private document libraries for your account.
Get started
Create an API key. Open the API portal, sign in if needed, and generate a key under API keys.
Create API keySend it on every request as Authorization: ApiKey YOUR_API_KEY. Authentication also covers Bearer tokens and query-string keys for clients that cannot set headers.
Resolve a company. You know the symbol or CIK → Entity Reference. You have a partial name or messy ticker → Entity Search. Read Entities once so ids, listings, and share classes make sense.
Call a dataset. Pick a group below, open its overview, then try the interactive request panel on any endpoint page. Check Coverage when you need counts, date ranges, or scope.
Limits and credentials. See Rate limits for quotas and 429 handling. Treat your API key as a secret—see Authentication—no matter how you call the API.
How platform-linked access works
Most endpoints serve shared catalog data. Watchlists and User Documents instead return your lists and files—the workspace tied to your website login.
One login carries two subscriptions: an API plan (permission to call the API) and a website plan (what the app allows—watchlists, Files, Japan, and the rest). Platform-linked routes check both; the website plan must include the feature you are calling.
An API key belongs to a user on that login. Each request resolves that user and applies the same entitlements as the website—via Authorization: ApiKey … only, not user_id. No user on the key → 401. No API plan or website feature → 403.
API groups
Entities
Global universe—equities, ETFs, funds, people, and private companies.
SEC Filings
Full SEC history. Keyword search and LLM-ready markdown text.
EDINET Translated Filings
Japan disclosures with English translations—search and read as markdown.
User DocumentsPlatform-linked
Search and read documents that belong to the signed-in account.
Fundamentals
250+ fundamental metrics per entity—see coverage for the catalog.
Financials
Income, balance sheet, and cash flow in one place.
XBRL
Search reported XBRL facts.
Screener
3,000+ screenable fields across equities, ETFs, funds, and more.
Time Series
1,500+ dated series—prices, financials, and other market history.
Forex
Currency quotes and conversion.
WatchlistsPlatform-linked
Group listings you follow and open them from one list.
Documents searches SEC, EDINET, and uploads in one list when you want a single search box.
Base URL
https://alpha-analyst.com/apicontents plus the path on each endpoint page (for example /v2/entities).