# Ivory Finance

## Docs

- [Invalidate Cache](https://docs.ivory.finance/api-reference/admin/cache-invalidate.md): Force-expire the TenantMiddleware Valkey cache entry for a tenant
- [Deactivate Tenant](https://docs.ivory.finance/api-reference/admin/deactivate.md): Soft-deactivate a tenant — stops routing immediately, preserves all data
- [Get Tenant](https://docs.ivory.finance/api-reference/admin/get.md): Fetch the full record for a single tenant by slug
- [List Tenants](https://docs.ivory.finance/api-reference/admin/list.md): Return all tenants ordered by provisioning date, newest first
- [Provision Tenant](https://docs.ivory.finance/api-reference/admin/provision.md): Provision a new client tenant — creates the tenant environment, runs migrations, seeds IAM data, and activates the tenant
- [Provisioning Status](https://docs.ivory.finance/api-reference/admin/status.md): Poll the step-by-step provisioning progress for a tenant
- [Update Tenant](https://docs.ivory.finance/api-reference/admin/update.md): Update tenant metadata — display name, tier, or custom domain
- [Supply Chain Map](https://docs.ivory.finance/api-reference/alternative/supply-chain.md): Customers, suppliers, and price correlations for any public company — sourced from SEC 10-K filings and ocean freight manifests
- [API Keys](https://docs.ivory.finance/api-reference/auth/api-keys.md): List, create, and revoke Kong API keys for your account
- [Login](https://docs.ivory.finance/api-reference/auth/login.md): Authenticate with email and password to receive JWT tokens
- [Current User](https://docs.ivory.finance/api-reference/auth/me.md): Retrieve your profile, tier limits, and API usage statistics
- [Refresh Token](https://docs.ivory.finance/api-reference/auth/refresh.md): Exchange a valid refresh token for a new access token
- [Register](https://docs.ivory.finance/api-reference/auth/register.md): Create a new user account and receive JWT tokens immediately
- [Bulk Facts by CIK](https://docs.ivory.finance/api-reference/companies/facts-by-ciks.md): Returns enriched company facts for a list of US CIKs. Accepts repeated params: ?ciks=320193&ciks=789019
- [Bulk Facts by Ticker](https://docs.ivory.finance/api-reference/companies/facts-by-tickers.md): Returns enriched company facts for a list of tickers (case-insensitive). Accepts repeated params: ?tickers=AAPL&tickers=MSFT
- [List Company Filings](https://docs.ivory.finance/api-reference/companies/filings.md): Returns filings for a company ordered by most recent first. Works for all jurisdictions — uses company UUID to join filings.
- [Get Company](https://docs.ivory.finance/api-reference/companies/get-by-cik.md): Fetch a single company record.
- [Get Peer Companies](https://docs.ivory.finance/api-reference/companies/peers.md): Returns sector-peer companies ranked by cosine similarity of DCSC sector score vectors. Currently limited to US companies (sector scores computed via 10-K + LLM pipeline).
- [Get Company Presentations](https://docs.ivory.finance/api-reference/companies/presentations.md): Returns all investor presentations filed by the company identified by CIK.
- [Get Company Press Releases](https://docs.ivory.finance/api-reference/companies/press-releases.md): Returns all press releases filed by the company identified by CIK.
- [Search Companies](https://docs.ivory.finance/api-reference/companies/search.md): Case-insensitive search across company name, ticker, and external_id. Exact ticker matches are ranked first. Optionally filter by country_code.
- [Get Company Sector Scores](https://docs.ivory.finance/api-reference/companies/sectors.md): Returns DCSC sector relevance scores (0–100) for a company, ordered by score descending. Accepts any company_id format: UUID, CIK, or CC:external_id.
- [Get Company Transcripts](https://docs.ivory.finance/api-reference/companies/transcripts.md): Returns all indexed earnings call transcripts for a company identified by CIK. Resolves the CIK to a ticker symbol via the companies table, then queries the transcript index. Results are sorted by call date descending.
- [Deals & Pipeline](https://docs.ivory.finance/api-reference/deals/deals.md): Create deals, advance stages, add parties, trigger scoring, and view the full deal pipeline
- [Deal Management](https://docs.ivory.finance/api-reference/deals/overview.md): Create deals, track pipeline stages, trigger AI scoring, and generate AI-powered pitch summaries
- [Delete Document](https://docs.ivory.finance/api-reference/documents/delete.md): Permanently remove a document and all its indexed chunks from your tenant's document store
- [Search Documents](https://docs.ivory.finance/api-reference/documents/search.md): Hybrid BM25 + vector search over your tenant's private document store, with IAM pre-filtering enforced on every query
- [Upload Document](https://docs.ivory.finance/api-reference/documents/upload.md): Upload a file to your tenant's private document store — extracted, chunked, embedded, and indexed for semantic and keyword search
- [Query Earnings Calendar](https://docs.ivory.finance/api-reference/earnings/query.md): Flexible query over the earnings calendar. All filters are optional and combinable. Results are ordered by most recent earnings date first.
- [Upcoming Earnings](https://docs.ivory.finance/api-reference/earnings/upcoming.md): Returns earnings announcements expected within the next N days, ordered by earnings date ascending (earliest first).
- [Real-Time Collaboration](https://docs.ivory.finance/api-reference/editor/collab.md): Hocuspocus WebSocket server, Yjs CRDT persistence, and the auth webhook
- [Workspaces & Documents](https://docs.ivory.finance/api-reference/editor/documents.md): CRUD for workspaces, documents, members, and version snapshots
- [Frontend Implementation](https://docs.ivory.finance/api-reference/editor/frontend.md): Next.js (or React) + Tiptap + Hocuspocus + custom smart block renderers. Everything you need to ship the Ivory Intelligence Editor V1.
- [Intelligence Editor — Overview](https://docs.ivory.finance/api-reference/editor/overview.md): Block-based collaborative document editor with AI-powered smart blocks, visibility-aware search, and real-time collaboration via Yjs + Hocuspocus
- [Smart Blocks](https://docs.ivory.finance/api-reference/editor/smart-blocks.md): Resolver endpoints that return fully-formed Tiptap block nodes populated with live financial data, plus a persistence layer for saving, copying, and pinning blocks to the dashboard
- [ESG & Sustainability](https://docs.ivory.finance/api-reference/esg/esg.md): Company ESG scores, portfolio ESG aggregation, SFDR classification, climate scenario analysis, and M&A ESG due diligence
- [ETL Connectors](https://docs.ivory.finance/api-reference/etl/connectors.md): Register, schedule, and manage Meltano/Singer connectors. Supports all 600+ Singer taps with per-tenant IOMETE Iceberg routing.
- [Field Mappings & Webhook](https://docs.ivory.finance/api-reference/etl/field-mappings.md): LLM-assisted source→target field mapping, Python transform expressions, and the HMAC-signed runner webhook
- [Lakehouse Catalogs](https://docs.ivory.finance/api-reference/etl/lakehouse.md): Provision and manage IOMETE Iceberg catalogs for tenant data routing. Required before registering ETL connectors.
- [ETL Connectors — Overview](https://docs.ivory.finance/api-reference/etl/overview.md): Production-grade data ingestion for 600+ Meltano/Singer taps with IOMETE Iceberg routing, Singer STATE management, and multi-tenant isolation
- [Comps Table (Excel)](https://docs.ivory.finance/api-reference/export/comps.md): Generate an institutional-grade comparable company analysis Excel workbook.
- [DCF Model Inputs (Excel)](https://docs.ivory.finance/api-reference/export/dcf-inputs.md): Export a pre-populated DCF model inputs workbook with: - **Historical** tab: 5 years of revenue, EBITDA, FCF, CapEx - **Assumptions** tab: growth rates, margins, WACC placeholder (blue = input cells) - **DCF** tab: 5-year projection + terminal value formula shell
- [Financial Statements (Excel)](https://docs.ivory.finance/api-reference/export/financials.md): Export 3-tab Excel workbook: Income Statement, Balance Sheet, Cash Flow. Each tab shows up to `limit` periods (default 8, most recent first).
- [Presentation (PowerPoint)](https://docs.ivory.finance/api-reference/export/presentation.md): Generate a PowerPoint presentation. Types: - **comps_tearsheet**: Title + Company overview + Comps table + Valuation summary - **earnings_summary**: Title + Key metrics QoQ/YoY + Financial highlights - **risk_brief**: Title + Risk score + Category breakdown (requires prior `analyze_filing_risks` cal…
- [Revenue Segments (Excel)](https://docs.ivory.finance/api-reference/export/revenue-segments.md): Export revenue segment breakdowns (products, geographies, business units) extracted from 10-K / 10-Q filings.
- [Get Filing by Accession Number](https://docs.ivory.finance/api-reference/filings/by-accession.md): Fetch a single filing by its accession number (e.g. 0001234567-24-000123).
- [Get Company Filings](https://docs.ivory.finance/api-reference/filings/by-cik.md): Get all filings for a company. Accepts any company identifier: UUID, scoped `CC:external_id` (e.g. `GB:00445790`, `US:0001234567`), bare CIK (US), or bare external_id. Response includes presigned S3 URLs for the original HTML filing and the Docling-converted markdown (URLs are valid for 1 hour).
- [Company Filing Sentiment List](https://docs.ivory.finance/api-reference/filings/company-sentiment.md): Paginated list of all sentiment-scored filings for a company, newest first. Filter by form type, date range, or dominant sentiment label.
- [Company Sentiment Trend](https://docs.ivory.finance/api-reference/filings/company-sentiment-trend.md): Aggregate filing sentiment time series for a company, bucketed by day, week, month, quarter, or year.
- [Recent Filings](https://docs.ivory.finance/api-reference/filings/recent.md): Returns the most recently published filings across all companies, ordered by publication timestamp descending.
- [Search Filings](https://docs.ivory.finance/api-reference/filings/search.md): Search filings across all companies. Optionally filter by form type. Results are ordered by filing date descending.
- [Filing Sentiment](https://docs.ivory.finance/api-reference/filings/sentiment.md): 5-band sentiment analysis (v_negative, negative, neutral, positive, v_positive) for a single SEC filing.
- [Filing Trends](https://docs.ivory.finance/api-reference/filings/trends.md): Returns a time-series of filing counts bucketed by granularity. Optionally filter to a specific company (cik) and/or form type. Granularity controls bucket size: week, month, quarter, year. Use `year` to scope the series to a single calendar year (e.g. year=2020). Use `from_date` to set an arbitrary…
- [Balance Sheets](https://docs.ivory.finance/api-reference/financials/balance.md): Returns balance sheets for a company, most recent first.
- [Cash Flow Statements](https://docs.ivory.finance/api-reference/financials/cashflow.md): Returns cash flow statements for a company, most recent first.
- [Income Statements](https://docs.ivory.finance/api-reference/financials/income.md): Returns income statements for a company, most recent first. Filter by fiscal year and/or period code (FY = annual, Q1–Q4 = quarterly).
- [Financial Ratios](https://docs.ivory.finance/api-reference/financials/ratios.md): Returns pre-computed financial ratios from the `financial_ratios` materialized view, most recent period first.
- [Revenue Segments](https://docs.ivory.finance/api-reference/financials/revenue-segments.md): Returns revenue segment breakdowns for a company — products, geographic regions, and business units — extracted from 10-K / 10-Q / 20-F / 40-F filings.
- [Agents](https://docs.ivory.finance/api-reference/foundry/agents.md): Wrap deployed models as named Agents — predict, score, alert, or batch
- [Dataset Builder](https://docs.ivory.finance/api-reference/foundry/datasets.md): Visually define a dataset from multiple sources — Foundry generates Spark SQL and materialises it as an Iceberg table on IOMETE
- [AutoML Training](https://docs.ivory.finance/api-reference/foundry/models.md): 23-algorithm competition, SHAP explainability, drift monitoring, and threshold calibration — from dataset to deployed model in one call
- [Notebook Servers](https://docs.ivory.finance/api-reference/foundry/notebooks.md): Provision per-tenant JupyterLab environments backed by Kubeflow Notebooks — explore data, prototype models, and iterate without leaving the platform
- [AI Foundry](https://docs.ivory.finance/api-reference/foundry/overview.md): No-code self-service intelligence platform — from question to production-grade deployed model in four steps
- [Natural Language Query](https://docs.ivory.finance/api-reference/foundry/query.md): Ask any question in plain English — Foundry routes it to the right data source and synthesises a narrative answer
- [Insider Holdings](https://docs.ivory.finance/api-reference/insider-trades/holders.md): Current ownership positions reported by directors, officers, and 10% owners via Form 3/4/5 filings
- [Insider Trades](https://docs.ivory.finance/api-reference/insider-trades/trades.md): Form 3/4/5 insider transactions — purchases, sales, and awards by directors, officers, and 10% owners
- [KYC / AML / Suitability](https://docs.ivory.finance/api-reference/kyc/kyc.md): KYC case management, sanctions screening, adverse media, MiFID II suitability assessments, and SAR filing
- [Lakehouse Admin](https://docs.ivory.finance/api-reference/lakehouse/lakehouse.md): Provision and manage IOMETE Iceberg catalogs and Postgres → Iceberg sync targets for each tenant
- [MCP Server](https://docs.ivory.finance/api-reference/mcp.md): Connect Claude AI directly to Ivory Finance data via the Model Context Protocol
- [Get Article](https://docs.ivory.finance/api-reference/news/get.md): Retrieve a single enriched news article by its UUID.
- [Query News](https://docs.ivory.finance/api-reference/news/query.md): Search and filter enriched financial news from global sources.
- [Sentiment Trends](https://docs.ivory.finance/api-reference/news/sentiment-trends.md): Time-series of 5-band sentiment distribution and mention volume for a company or ticker.
- [News Sources](https://docs.ivory.finance/api-reference/news/sources.md): List all active news sources and their last poll timestamps.
- [Live News Stream](https://docs.ivory.finance/api-reference/news/stream.md): Real-time WebSocket stream of enriched financial news as it is published.
- [Trending News](https://docs.ivory.finance/api-reference/news/trending.md): Top-impact financial news in the last N hours, sorted by impact score.
- [Portfolio Management](https://docs.ivory.finance/api-reference/portfolios/portfolios.md): Create and manage investment portfolios, import positions, retrieve risk metrics, performance attribution, and factor exposures
- [Get Investor Presentation](https://docs.ivory.finance/api-reference/presentations/get.md): Returns the full investor presentation for the given accession number, including the complete Markdown content, a presigned S3 URL to the archived file, and the original SEC EDGAR link.
- [List Investor Presentations](https://docs.ivory.finance/api-reference/presentations/list.md): Returns a paginated list of investor presentations extracted from 8-K and 6-K filings. Each result includes a presigned S3 URL to the archived file (`s3_url`) valid for 1 hour, plus the original `sec_url` on SEC EDGAR.
- [Get Press Release](https://docs.ivory.finance/api-reference/press-releases/get.md): Returns the full press release for the given accession number, including the complete Markdown content, a presigned S3 URL to the archived file, and the original SEC EDGAR link.
- [List Press Releases](https://docs.ivory.finance/api-reference/press-releases/list.md): Returns a paginated list of press releases extracted from 8-K and 6-K filings. Each result includes a presigned S3 URL to the archived HTML/PDF (`s3_url`) valid for 1 hour, plus the original `sec_url` on SEC EDGAR.
- [Agent Configuration](https://docs.ivory.finance/api-reference/rag/agent-configuration.md): Configure AI models and database connections for the agentic RAG endpoint
- [Agentic Answer](https://docs.ivory.finance/api-reference/rag/answer.md): Embeds the query using sentence-transformers, retrieves semantically similar chunks via KNN vector search, then generates a cited Markdown answer using GPT-4o.
- [Agentic Answer (Streaming)](https://docs.ivory.finance/api-reference/rag/answer-stream.md): Same retrieval pipeline as POST /answer, but streams the GPT-4o response token-by-token via Server-Sent Events.
- [Company Retrieval](https://docs.ivory.finance/api-reference/rag/companies.md): Search for companies that have SEC filings indexed in the RAG corpus. Performs full-text search across company_name, ticker, and cik fields in OpenSearch, returning one deduplicated result per unique CIK.
- [Orchestrator Agent](https://docs.ivory.finance/api-reference/rag/orchestrator.md): Master orchestrator that plans, delegates to specialist tools, and generates cited answers with interactive charts — streaming via SSE
- [Visualization & Risk Analysis](https://docs.ivory.finance/api-reference/rag/visualization.md): Interactive Plotly charts and Loughran-McDonald financial risk keyword extraction — available in both the agent and orchestrator endpoints
- [Get Instance](https://docs.ivory.finance/api-reference/rtdb/instance.md): Return connection details for your managed QuestDB instance
- [Real-Time Database](https://docs.ivory.finance/api-reference/rtdb/overview.md): Every Ivory tenant gets a dedicated QuestDB instance — the hot tier of your data platform
- [Execute SQL](https://docs.ivory.finance/api-reference/rtdb/query.md): Run SQL queries against your QuestDB real-time instance
- [Tables](https://docs.ivory.finance/api-reference/rtdb/tables.md): List tables, inspect schemas, check storage, and create new tables
- [Full-Text Search](https://docs.ivory.finance/api-reference/search/full-text.md): Full-text search over SEC filing chunk text indexed in OpenSearch. Searches across chunk_text, chunk_heading, and company_name. Use company or cik to drill down to a specific company. Returns matching chunks with query-match highlights (<mark> tags) and a plain-text excerpt fallback. Set `index=tran…
- [Share via Email](https://docs.ivory.finance/api-reference/share/email.md): Send a formatted analysis brief to a list of email recipients.
- [Notification Channels](https://docs.ivory.finance/api-reference/stream/channels.md): Manage your personal notification destinations — Slack, Teams, Email, FCM, and SNS.
- [Delivery Log](https://docs.ivory.finance/api-reference/stream/deliveries.md): Audit log of every notification dispatch attempt.
- [Live Filings Stream](https://docs.ivory.finance/api-reference/stream/live-filings.md): Real-time WebSocket stream of corporate disclosures as they are published.
- [Notification Subscriptions](https://docs.ivory.finance/api-reference/stream/subscriptions.md): Filter which corporate disclosures or keywords trigger each notification channel.
- [Extract Table](https://docs.ivory.finance/api-reference/tools/extract.md): Extract tables from corporate disclosures and export as CSV, XLSX, or JSON
- [Discover Tables](https://docs.ivory.finance/api-reference/tools/extract-discover.md): Discover all tables on a corporate disclosure before extracting
- [Companies by Topic](https://docs.ivory.finance/api-reference/topics/companies.md): Returns companies ranked by average relevance score for the given topic over the past 12 months (or since date_from).
- [Company Topics](https://docs.ivory.finance/api-reference/topics/company-topics.md): Returns the top topics for a company with all 7 metrics: **mentions**, **relevance**, **momentum**, **trend**, **positive**, **negative**, **affinity**.
- [Document Topics](https://docs.ivory.finance/api-reference/topics/document.md): Returns the 5–10 free-form topics extracted from a specific filing (by accession number) or transcript (by doc_id), ranked by importance.
- [Emerging Topics](https://docs.ivory.finance/api-reference/topics/emerging.md): Returns emerging topic candidates discovered by clustering free-form document_topics across all companies.
- [Companies by Emerging Topic](https://docs.ivory.finance/api-reference/topics/emerging-companies.md): Returns the companies most associated with a specific emerging topic, ranked by how many of their documents mention it.  Use this to identify early adopters or most-exposed companies for a new cross-market theme.
- [Extracted Topics](https://docs.ivory.finance/api-reference/topics/extracted.md): Returns free-form topics extracted from each document (filing, transcript, exhibit) for this company, aggregated over the requested date window.
- [Topic Taxonomy](https://docs.ivory.finance/api-reference/topics/list.md): Return the full 100-topic taxonomy, grouped by category.
- [Topic Timeline](https://docs.ivory.finance/api-reference/topics/timeline.md): Returns a quarterly time series for one topic at one company, showing how **mentions**, **relevance**, and **sentiment** have evolved over time.
- [Trending Topics](https://docs.ivory.finance/api-reference/topics/trending.md): Returns topics that are accelerating — **momentum > 0.5** — sorted by momentum descending. Use this to identify emerging themes the company is increasingly discussing across its filings, calls, and press releases.
- [Get Transcript](https://docs.ivory.finance/api-reference/transcripts/get.md): Returns the full transcript document including all content sections: `markdown_summary`, `markdown_key_metrics`, `markdown_risks`, and `markdown_transcript` (the full speaker-turn transcript).
- [List Transcripts](https://docs.ivory.finance/api-reference/transcripts/list.md): Returns a paginated list of earnings call transcript metadata. Filter by ticker, fiscal year/quarter, or date range. Markdown content is excluded — use `GET /v1/transcripts/{doc_id}` for full content.
- [Authentication](https://docs.ivory.finance/authentication.md): Get your API key and start querying in seconds
- [Introduction](https://docs.ivory.finance/introduction.md): Corporate Disclosure Intelligence — real-time data as a developer-friendly REST API
- [Quickstart](https://docs.ivory.finance/quickstart.md): Make your first API call in under 2 minutes

## OpenAPI Specs

- [openapi](https://docs.ivory.finance/openapi.json)

## Optional

- [Documentation](https://docs.ivory.finance)
- [Dashboard](https://ivory.finance/login)
- [Questions?](https://ivory.finance/slack)