5-Minute Quickstart

Get up and running with the Kaleidoscope API in under 5 minutes. We'll take you from signup to your first successful API call.

1 Get Your API Key

  1. Sign up at api.kscope.io/signup
  2. Log in to your dashboard
  3. Find your API key in the dashboard

API Access Tiers:

  • Free: 300 calls/month
  • Starter: 100,000 calls/month
  • Business: 300,000 calls/month
  • Custom: Unlimited calls + enterprise features

Keep your API key secure: Never commit it to GitHub, use environment variables in production

2 Test Your Authentication

cURL
# Replace YOUR_API_KEY with your actual key
curl 'https://api.kscope.io/auth-test?key=YOUR_API_KEY'

✅ Success Response:

{"status": "success", "message": "Authenticated"}

3 Your First Real API Call - Search SEC Filings

Search for Apple's SEC filings
curl 'https://api.kscope.io/v3/sec/search/AAPL?key=YOUR_API_KEY&content=sec&limit=3'
View example response
{
  "data": [
    {
      "cik": 320193,
      "company_name": "Apple Inc.",
      "date": 1730419200,
      "filer": "Apple Inc.",
      "form": "10-Q",
      "form_desc": "Quarterly report [Sections 13 or 15(d)]",
      "form_group": "Quarterly Reports",
      "acc": "0000320193-24-000123",
      "html": "https://cdn.kscope.io/abc123def456.html",
      "pdf": "https://cdn.kscope.io/abc123def456.pdf",
      "ticker": "AAPL"
    }
  ],
  "total": 2004,
  "status": "success"
}

4 Understanding the Response

Key Fields
  • ticker - Stock symbol
  • form - Filing type (10-K, 10-Q, 8-K)
  • date - Unix timestamp
  • pdf - Direct link to PDF
  • html - Direct link to HTML
Response Structure
  • data - Array of filings
  • total - Total results available
  • status - Request status

5 Try Different Searches

Search only 10-K annual reports

curl 'https://api.kscope.io/v3/sec/search/AAPL?key=YOUR_API_KEY&content=sec&form=10-K&limit=5'

Search with keyword

curl 'https://api.kscope.io/v3/sec/search/AAPL?key=YOUR_API_KEY&content=sec&exp=revenue&limit=5'

Search exhibits instead of main filings

curl 'https://api.kscope.io/v3/sec/search/AAPL?key=YOUR_API_KEY&content=exhibits&limit=5'

Quick Reference

Rate Limit: 3,600 requests/hour

Base URL: https://api.kscope.io

Support: support@kscope.io

Dashboard: api.kscope.io/dashboard

Authentication

Use your key for all requests. Get your key now.

Authentication

All requests require an API key. API keys never expire automatically - they remain valid until manually deleted in your dashboard.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status when limit exceeded

Inputs

Parameter Type Description
key String Your API key (Required)

SEC Filings

Access a comprehensive dataset of SEC filings from the 1990s to present. Filings are processed within seconds of publication by the SEC.

SEC Filing Search

Search over 18M SEC filings with keywords, Boolean expressions, and 20+ filters. All filing types supported. Data available from the 1990s to present. Enhanced v4 with standardized envelope pattern and improved pagination.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window

Inputs

Parameter Type Description
identifier String Restrict results to ticker, CIK (Required)
content String Content to search against. Available values: sec, exhibits, agreements
limit Int Maximum number of results to return (default: 20, max: 100)
offset Int Used as a way to page through data
start_date Int Start from a date with a timestamp (Unix Timestamp)
end_date Int End at a date with a timestamp (Unix Timestamp)
exp String Boolean expression
form_group String Filter by form group (e.g., 'annual_reports', 'quarterly_reports')
form String Restrict results to passed form(s). Use ; between forms to pass more than one form

SEC Filing Search

Search over 18M SEC filings with keywords and 20+ filters. All filing types supported. Data available from the 1990s to present. Uses snake_case response format. For standardized envelope pattern, use v4.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker, CIK, or semicolon-separated CIK list (Required)
content String Content to search against. Available values: sec, exhibits, agreements
limit Int Maximum number of results to return (default: 20, max: 100)
offset Int Pagination offset
start_date Int Start date (Unix Timestamp)
end_date Int End date (Unix Timestamp)
form-group String Filter by form group (e.g., 'annual-reports', 'quarterly-reports')
form String Restrict results to passed form(s). Use ; between forms
exp String Boolean expression

SEC Filing Search

Search over 18M SEC filings with keywords, Boolean expressions, and 20+ filters. All filing types supported. Data available from the 1990s to present. Legacy v2 endpoint - consider using v4 for standardized envelope format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker, CIK, or semicolon-separated CIK list (Required)
content String Content to search against. Available values: sec, exhibits, agreements
limit Int Maximum number of results to return (default: 20)
start Int Pagination offset
sd Int Start date (Unix Timestamp)
ed Int End date (Unix Timestamp)
form-group String Filter by form group (e.g., 'annual-reports', 'quarterly-reports')
form String Restrict results to passed form(s). Use ; between forms
exp String Boolean expression

SEC Filing Search Boolean Expression

Advanced SEC filing search with boolean expressions. Supports complex queries with AND, OR, NOT operators and field-specific searches. Search timeframe limited to 5 years. Returns standardized envelope with pagination metadata.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
exp String Boolean expression (Required). Example: 'ticker:AAPL AND form:10-K'
content String Content to search against. Available values: sec, exhibits, agreements (default: sec)
limit Int Maximum number of results to return (default: 20, max: 100)
offset Int Used as a way to page through data
start_date Int Start from a date with a timestamp (Unix Timestamp). Default: 5 years ago
end_date Int End at a date with a timestamp (Unix Timestamp). Default: today

SEC Filing Search Boolean Expression

Advanced SEC filing search with boolean expressions. Supports complex queries with AND, OR, NOT operators and field-specific searches. Search timeframe limited to 5 years. Legacy v2 endpoint with camelCase response format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
exp String Boolean expression (Required). Example: 'ticker:AAPL AND form:10-K'
content String Content to search against. Available values: sec, exhibits, agreements (default: sec)
limit Int Maximum number of results to return (default: 20)
start Int Pagination offset
sd Int Start date (Unix Timestamp). Default: 5 years ago
ed Int End date (Unix Timestamp). Default: today

SEC Filing Search Realtime

Get all SEC filings for the current UTC day. Auto-calculates start and end dates for today (UTC). Returns standardized envelope with pagination metadata.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
content String Content to search against. Available values: sec, exhibits, agreements
limit Int Maximum number of results to return (default: 20, max: 100)
offset Int Used as a way to page through data

SEC Filing Search Realtime

Get all SEC filings for the current UTC day. Auto-calculates start and end dates for today (UTC). Legacy v2 endpoint with camelCase response format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
content String Content to search against. Available values: sec, exhibits, agreements
limit Int Maximum number of results to return (default: 20)
start Int Pagination offset

13F Institutional Holdings

Get 13F institutional holdings data for a given ticker, CIK, CUSIP, accession number, or holder CIK. Returns detailed holdings information including position values, share counts, and institutional holder details. Returns standardized envelope.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol, CIK, CUSIP, accession number, or holder CIK (Required)
limit Int Maximum number of results to return (default: 100, max: 100)
type String Return format: json or xml (default: json)

13F Institutional Holdings

Get 13F institutional holdings data for a given ticker, CIK, CUSIP, accession number, or holder CIK. Returns detailed holdings information including position values, share counts, and institutional holder details. Legacy v2 endpoint with camelCase response format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol, CIK, CUSIP, accession number, or holder CIK (Required)
limit Int Maximum number of results to return (default: 100, max: 100)
type String Return format: json or xml (default: json)

Form D - Private Securities Offerings

Get Form D filings for private securities offerings under Regulation D. Form D is filed by companies to report offerings of securities without SEC registration. Returns standardized envelope with filing details.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or SEC accession number (Required)
limit Int Maximum number of results to return

Form D - Private Securities Offerings

Get Form D filings for private securities offerings under Regulation D. Form D is filed by companies to report offerings of securities without SEC registration. Legacy v2 endpoint with camelCase response format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or SEC accession number (Required)
limit Int Maximum number of results to return

Form C - Crowdfunding

Get Form C filings for crowdfunding offerings under Regulation Crowdfunding. Form C is filed by companies to report securities offerings through crowdfunding platforms. Returns standardized envelope with filing details.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or SEC accession number (Required)
limit Int Maximum number of results to return

Form C - Crowdfunding

Get Form C filings for crowdfunding offerings under Regulation Crowdfunding. Form C is filed by companies to report securities offerings through crowdfunding platforms. Legacy v2 endpoint with camelCase response format.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or SEC accession number (Required)
limit Int Maximum number of results to return

Insider Transactions

Get insider trading transactions for a company. Returns detailed Form 4 transaction data including purchases, sales, and other transaction types by company insiders (officers, directors, 10% owners). Supports pagination and date filtering.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol or CIK (Required)
limit Int Maximum number of results to return (max: 100, default: 100)
start Int Pagination offset
sd Int Start date (Unix Timestamp)
ed Int End date (Unix Timestamp)

Executive Compensation

Get executive compensation data for a company. Supports two search types: 'summary' for summary compensation tables (highest-paid executives) and 'director' for director compensation. Returns detailed compensation information including salary, bonus, stock awards, options, and total compensation.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
search_type String Type of compensation search: 'summary' or 'director' (Required)
identifier String Ticker symbol, CIK, or accession number (Required)
year String Filter by year (4-digit format, e.g., '2023')
sort String Sort order: 'ASC' or 'DESC'

Compensation Fees

Search and retrieve professional fees and compensation-related fees from SEC filings. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
key String API key (Required)

Corporate Actions

Get corporate actions for a company including mergers, acquisitions, spin-offs, stock splits, dividend declarations, and other significant corporate events. Returns comprehensive action details and filing information.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol or CIK (Required)
limit Int Maximum number of results to return

Corporate Audit Fees

Get audit and accounting fees paid by a company to their auditors. Returns detailed breakdown of audit fees, audit-related fees, tax fees, and other professional fees from DEF 14A proxy statements.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol or CIK (Required)

Stock Data

Real-time and historical stock price data for US-listed equities.

Stock Real-Time

Get real-time stock price data for US-listed equities. Returns current price, change, volume, and market data. The ticker symbol is determined by the API key configuration.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Stock Historical

Get historical OHLC (Open, High, Low, Close) stock price data for US-listed equities. Supports date range filtering and returns daily trading data including volume and adjusted close prices.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
ticker String Stock ticker symbol (Required)
start_date String Start date in YYYY-MM-DD format
end_date String End date in YYYY-MM-DD format
limit Int Maximum number of results to return

Stock Delayed

Get delayed stock price data (15-minute delay) for US-listed equities. Returns current delayed price, change, volume, and market data for any ticker symbol.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
ticker String Stock ticker symbol (Required)

Stock Dividends

Get dividend payment history for US-listed equities. Returns ex-dividend dates, payment dates, dividend amounts, and frequency information.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
ticker String Stock ticker symbol (Required)
limit Int Maximum number of results to return
start_date String Start date in YYYY-MM-DD format
end_date String End date in YYYY-MM-DD format

Wealth & Insider Focus

Executive wealth tracking, insider gifts, biographical data, and comprehensive analysis of corporate insider activities.

Insider Biographical Data

Get biographical information and corporate relationships for an insider by CIK or name. Returns detailed profile data including positions, relationships, and optionally recent transactions. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or person name (Required)
include_transactions Boolean Include recent transactions (default: false)
limit Int Number of transactions to include if include_transactions=true (default: 10)

Insider Gift Transactions

Find people who made charitable gift transactions to a specific company. Company-centric search that identifies insiders who gifted shares, useful for nonprofits and fundraising organizations to identify potential donors. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company name or company CIK (Required)
from_date String Start date for gift search (YYYY-MM-DD format)
to_date String End date for gift search (YYYY-MM-DD format)
limit Int Maximum number of people/gifts to return (default: 100)

Gift Transactions by Year

Get gift transaction counts grouped by year for an insider. Provides year-by-year breakdown of charitable gift transactions, useful for analyzing giving patterns over time. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or person name (Required)
from_year String Start year (YYYY format)
to_year String End year (YYYY format)

Transaction Code Analysis

Get transaction code counts over time ranges for an insider. Analyzes the distribution of different transaction types (purchases, sales, gifts, awards, etc.) across multiple time periods to identify patterns. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String CIK number or person name (Required)
codes String Comma-separated transaction codes to analyze (default: P,S,G,A,D,O). Valid codes: P=Purchase, S=Sale, G=Gift, A=Award, D=Disposition, O=Other
time_ranges String Comma-separated list of year ranges (default: 2,4,5). Example: '1,3,5' for 1yr, 3yrs, 5yrs

Insider Focus OpenAI Integration

Retrieve AI-enhanced insider trading insights and analysis powered by OpenAI. This development endpoint provides AI-generated insights and analysis of insider trading patterns using OpenAI's language models. It combines insider transaction data with natural language processing to generate summaries, identify trends, and provide contextual analysis. **Data source:** Kscope insider trading database + OpenAI API **Update frequency:** Real-time **Coverage:** SEC Form 4 insider transactions **Environment:** Development only **Use Cases:** - Generate natural language summaries of insider trading activity - Identify unusual trading patterns with AI analysis - Get contextual explanations of complex transactions - Automated insider trading research and reporting **Note:** This is a development endpoint available only in dev environment. Requires OpenAI API integration. See also: GET /v3/insider-focus/search for raw insider transaction data, GET /v3/insider-focus/gifts for gift transaction analysis

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status when limit exceeded

SEDAR

Canadian securities filings from the System for Electronic Document Analysis and Retrieval (SEDAR).

SEDAR Filings

Search Canadian securities filings from the System for Electronic Document Analysis and Retrieval (SEDAR). Returns filings for TSX-listed companies including annual reports, quarterly financials, press releases, and other regulatory documents.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String TSX ticker symbol or issuer number (Required)
limit Int Maximum number of results to return (default: 20)
page Int Page number for pagination

News & Transcripts

Press releases, earnings call transcripts, and analyst coverage data for public companies.

Press Releases

Get press releases for a given company. Returns press release metadata, content summaries, and links to full HTML content. Supports date filtering, pagination, and sorting.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company ticker or CIK (Required)
limit Int Maximum number of results to return
start Int Pagination offset
sd Int Start date (Unix Timestamp)
ed Int End date (Unix Timestamp)
year String Filter by year (4-digit) or JSON array of years (e.g., '[2022, 2023]')
sort String Sort order: 'ASC' or 'DESC'

Realtime Transcripts

Get earnings call transcripts from the current day (EST timezone). Returns the latest transcripts published today with full content and metadata.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Historical Transcripts

Get historical earnings call transcripts with date filtering, pagination, and ticker filtering. Returns full transcript content and metadata.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
ticker String Filter by ticker symbol
limit Int Maximum number of results (default: 20)
offset Int Pagination offset
start_date String Start date (ISO 8601 format: YYYY-MM-DD)
end_date String End date (ISO 8601 format: YYYY-MM-DD)

Transcripts

Get earnings call transcripts for a specific company by ticker or CIK. Returns full transcript content with speaker segments and metadata.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol or CIK (Required)
limit Int Maximum number of results
segment String Filter by segment type (e.g., 'executive', 'analyst')

Transcript Analysts

Get analyst information and questions from earnings call transcripts for a specific company. Returns analyst names, firms, and their questions from Q&A sessions.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Ticker symbol or CIK (Required)
limit Int Maximum number of results

Company Fundamentals

Company profiles, executive information, capitalization data, and leadership changes.

Company Profile (Planned)

⚠️ **Planned endpoint - not yet fully implemented** This endpoint is under development and currently returns a placeholder response. When completed, it will provide comprehensive company profile information including business description, sector, industry, contact information, and key corporate details. **Planned Features:** - Company name, ticker, and CIK - Sector and industry classification - Business description - Headquarters location and contact information - Website and employee count - Founded date Available in development environment only. Contact support for implementation timeline.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company ticker symbol or CIK (Required)

Company Executives (Planned)

⚠️ **Planned endpoint - not yet fully implemented** This endpoint is under development and currently returns a placeholder response. When completed, it will provide executive team information for a company including C-suite executives, their titles, and biographical information. **Planned Features:** - C-suite executive names and titles - Executive age and tenure - Biographical information - Board membership details - Compensation data (where available) Available in development environment only. Contact support for implementation timeline.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company ticker symbol or CIK (Required)

Company Capitalization (Planned)

⚠️ **Planned endpoint - not yet fully implemented** This endpoint is under development and currently returns a placeholder response. When completed, it will provide company market capitalization and capital structure information including market cap, shares outstanding, and equity details. **Planned Features:** - Real-time market capitalization - Shares outstanding (basic and diluted) - Current stock price - 52-week high and low prices - Capital structure details - Historical market cap trends Available in development environment only. Contact support for implementation timeline.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company ticker symbol or CIK (Required)

Leadership Changes (Planned)

⚠️ **Planned endpoint - not yet fully implemented** This endpoint is under development and currently returns a placeholder response. When completed, it will provide historical leadership changes and executive transitions for a company, tracking CEO changes, C-suite appointments, departures, and promotions. **Planned Features:** - CEO transitions and succession events - C-suite appointments and departures - Executive promotions and role changes - Board of directors changes - Historical timeline of leadership events - Predecessor and successor tracking Available in development environment only. Contact support for implementation timeline.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
identifier String Company ticker symbol or CIK (Required)

Topics

Search and discover topics and themes across financial documents and filings.

Investor Relations Widgets

Embeddable widgets and tools for investor relations websites.

IR Company Filings

Get SEC filings for investor relations purposes. Embeddable widget endpoint for displaying company filings on IR websites. Supports searching SEC documents, exhibits, and agreements. Development endpoint - available in dev environment only.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
key String API key (Required)
content String Content to search against (Required). Available values: 'sec', 'exhibits', 'agreements'

IR Alerts Management

Manage email alerts for SEC filings. Add, delete, or list email alert subscriptions for specific content types. Allows investor relations teams to configure automated email notifications for new filings.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
key String API key (Required)
action String Action to perform (Required). Available values: 'add', 'delete', 'list'
email_addr String Email address (Required for add/delete actions)
content String Content type to alert on (Required for add/delete actions)

IR Stock Calculator

Calculate stock investment returns over time accounting for stock splits. Embeddable widget for IR websites that shows how an investment at a specific date would have grown. Ticker is determined by API key configuration.

Rate Limit
Limit: 3,600 requests/hour
Reset: Rolling hourly window
Returns 429 status with reset_in field showing seconds until limit resets

Inputs

Parameter Type Description
key String API key (Required). The ticker symbol is automatically determined from your key configuration
amount Float Investment amount (Required)
units String Unit type (Required). Available values: 'shares' or 'usd'
timestamp Int Investment date as Unix timestamp (Required)

Rate Limits

Understand API rate limits and best practices for managing your request volume.

Error Codes

Comprehensive reference for API error responses and troubleshooting guidance.