API Reference

Stocks API

Real-time stock prices, historical charts, company fundamentals, short interest data, and AI-powered stock analysis.

Base: /api/v1/stocksFree (AI summaries require PRO)25 endpoints

Overview

The Stocks API provides comprehensive stock data including real-time prices, historical charts, company fundamentals, short interest metrics, and AI-powered analysis reports. Most endpoints are publicly accessible without authentication.


Stock Lists & Metadata

GET /

Returns all available stock ticker symbols tracked by SentiSense.

Authentication: None required | Parameters: None

curl "https://app.sentisense.ai/api/v1/stocks"

Response: string[] (e.g., ["AAPL", "MSFT", "GOOGL", ...])


GET /detailed

Returns all stocks with company name, KB entity ID, and URL slug.

Authentication: None required | Parameters: None

curl "https://app.sentisense.ai/api/v1/stocks/detailed"

Response object:

Field Type Description
ticker string Ticker symbol
name string Company name
kbEntityId string Knowledge base entity ID
urlSlug string URL-friendly slug

GET /popular

Returns popular stock tickers. Parameters: None

curl "https://app.sentisense.ai/api/v1/stocks/popular"

Response: string[]


GET /popular/detailed

Returns popular stocks with company details. Same schema as /detailed.


GET /images

Returns company logo/icon URLs for a batch of tickers.

Parameters:

Parameter Type Required Default Description
tickers string Yes - Comma-separated tickers (max 600)
forced boolean No false Bypass cache
curl "https://app.sentisense.ai/api/v1/stocks/images?tickers=AAPL,TSLA,NVDA"

Response: Map<ticker, { iconUrl, logoUrl }> — URLs for company icons and logos.


GET /descriptions

Returns company profiles with branding, market cap, and sector information.

Parameters:

Parameter Type Required Default Description
tickers string Yes - Comma-separated tickers
forced boolean No false Bypass cache
curl "https://app.sentisense.ai/api/v1/stocks/descriptions?tickers=AAPL,MSFT"

Per-Stock Data

GET /{ticker}/similar

Returns peer and similar stocks based on sector, industry, and knowledge graph relationships.

Parameters:

Parameter Type Required Default Description
ticker path Yes - Stock ticker symbol
limit integer No 5 Max results
curl "https://app.sentisense.ai/api/v1/stocks/AAPL/similar?limit=10"

GET /{ticker}/profile

Returns a company profile including CEO, sector, industry, and market data.

Parameters:

Parameter Type Required Default Description
ticker path Yes - Stock ticker symbol
forced boolean No false Bypass cache
curl "https://app.sentisense.ai/api/v1/stocks/AAPL/profile"

GET /{ticker}/entities

Returns knowledge base entities related to a stock (e.g., CEO, key products, partner companies).

curl "https://app.sentisense.ai/api/v1/stocks/AAPL/entities"

GET /{ticker}/ai-summary

Returns an AI-generated stock analysis report. Requires PRO tier.

Authentication: PRO required

Parameters:

Parameter Type Required Default Description
ticker path Yes - Stock ticker symbol
depth string No basic Analysis depth: basic or deep
forceRefresh boolean No false Generate fresh report
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \
  "https://app.sentisense.ai/api/v1/stocks/AAPL/ai-summary?depth=deep"

GET /{ticker}/metrics/{metricType}/breakdown

Returns sentiment or mention metrics broken down by entity for a stock over a time range.

Parameters:

Parameter Type Required Default Description
ticker path Yes - Stock ticker
metricType path Yes - Metric type (e.g., sentiment, mentions)
startTime long No - Start time (epoch ms)
endTime long No - End time (epoch ms)
curl "https://app.sentisense.ai/api/v1/stocks/AAPL/metrics/sentiment/breakdown"

Market Data & Prices

GET /price

Returns the real-time price for a single stock ticker.

Parameters:

Parameter Type Required Default Description
ticker string Yes - Stock ticker symbol
curl "https://app.sentisense.ai/api/v1/stocks/price?ticker=AAPL"

Response:

Field Type Description
ticker string Ticker symbol
price double Current/last price
change double Price change (absolute)
changePercent double Price change (percentage)
previousClose double Previous closing price
timestamp long Price timestamp

GET /prices

Returns real-time prices for multiple tickers in a single request.

Parameters:

Parameter Type Required Default Description
tickers string Yes - Comma-separated tickers
curl "https://app.sentisense.ai/api/v1/stocks/prices?tickers=AAPL,TSLA,NVDA"

Response: Map<ticker, StockPrice> — Same price object as /price for each ticker.


GET /chart

Returns historical OHLCV (Open, High, Low, Close, Volume) chart data for a stock.

Parameters:

Parameter Type Required Default Description
ticker string Yes - Stock ticker symbol
timeframe string No 1M Chart timeframe: 1M, 3M, 6M, 1Y
curl "https://app.sentisense.ai/api/v1/stocks/chart?ticker=AAPL&timeframe=6M"

GET /market-status

Returns the current market status (open, closed, pre-market, after-hours).

Parameters: None

curl "https://app.sentisense.ai/api/v1/stocks/market-status"

Fundamentals

GET /fundamentals

Returns financial statement data for a stock (income statement, balance sheet, cash flow).

Parameters:

Parameter Type Required Default Description
ticker string Yes - Stock ticker
timeframe string No quarterly quarterly or annual
fiscalPeriod string No - Specific period (e.g., Q4)
fiscalYear integer No - Specific year (e.g., 2024)
curl "https://app.sentisense.ai/api/v1/stocks/fundamentals?ticker=AAPL&timeframe=quarterly"

GET /fundamentals/periods

Returns available fiscal periods for a stock.

curl "https://app.sentisense.ai/api/v1/stocks/fundamentals/periods?ticker=AAPL"

GET /fundamentals/current

Returns the most recent fundamental data snapshot.

curl "https://app.sentisense.ai/api/v1/stocks/fundamentals/current?ticker=AAPL"

GET /fundamentals/historical/ratios

Returns historical financial ratios (P/E, P/B, P/S, etc.) over time.

curl "https://app.sentisense.ai/api/v1/stocks/fundamentals/historical/ratios?ticker=AAPL"

GET /fundamentals/historical/revenue

Returns historical quarterly/annual revenue data.

curl "https://app.sentisense.ai/api/v1/stocks/fundamentals/historical/revenue?ticker=AAPL"

Short Interest & Float

GET /short-interest

Returns short interest data from FINRA for a stock.

curl "https://app.sentisense.ai/api/v1/stocks/short-interest?ticker=AAPL"

GET /float

Returns float information (shares outstanding, public float).

curl "https://app.sentisense.ai/api/v1/stocks/float?ticker=AAPL"

GET /short-volume

Returns short volume trading data.

curl "https://app.sentisense.ai/api/v1/stocks/short-volume?ticker=AAPL"

Try It

Test endpoints directly from your browser. Paste your API key once — it's saved locally and shared across all widgets. Get a free key

GET/api/v1/stocks/

List all available stock tickers

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/"
Enter your API key to send requests

GET/api/v1/stocks/detailed

All stocks with company details

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/detailed"
Enter your API key to send requests

GET/api/v1/stocks/popular

Popular stock tickers

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/popular"
Enter your API key to send requests

GET/api/v1/stocks/popular/detailed

Popular stocks with details

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/popular/detailed"
Enter your API key to send requests

GET/api/v1/stocks/images

Batch company logo URLs

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/images?tickers=AAPL%2CTSLA"
Enter your API key to send requests

GET/api/v1/stocks/descriptions

Company profiles with branding

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/descriptions?tickers=AAPL%2CTSLA"
Enter your API key to send requests

GET/api/v1/stocks/{ticker}/similar

Peer/similar stocks

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/AAPL/similar"
Enter your API key to send requests

GET/api/v1/stocks/{ticker}/profile

Company profile (CEO, sector, etc.)

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/AAPL/profile"
Enter your API key to send requests

GET/api/v1/stocks/{ticker}/entities

Related knowledge base entities

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/AAPL/entities"
Enter your API key to send requests

GET/api/v1/stocks/{ticker}/ai-summary

AI-generated stock analysis report

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/AAPL/ai-summary"
Enter your API key to send requests

GET/api/v1/stocks/{ticker}/metrics/{metricType}/breakdown

Sentiment/mention metrics breakdown

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/AAPL/metrics/{metricType}/breakdown"
Enter your API key to send requests

GET/api/v1/stocks/price

Real-time price for a single stock

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/price?ticker=AAPL"
Enter your API key to send requests

GET/api/v1/stocks/prices

Real-time prices for multiple stocks

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/prices?tickers=AAPL%2CTSLA%2CNVDA"
Enter your API key to send requests

GET/api/v1/stocks/chart

Historical OHLCV chart data

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/chart?ticker=AAPL&timeframe=1M"
Enter your API key to send requests

GET/api/v1/stocks/market-status

Current market open/closed status

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/market-status"
Enter your API key to send requests

GET/api/v1/stocks/fundamentals

Financial statement data

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/fundamentals?ticker=AAPL"
Enter your API key to send requests

GET/api/v1/stocks/fundamentals/periods

Available fiscal periods

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/fundamentals/periods"
Enter your API key to send requests

GET/api/v1/stocks/fundamentals/current

Most recent fundamentals

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/fundamentals/current"
Enter your API key to send requests

GET/api/v1/stocks/fundamentals/historical/ratios

Historical P/E and financial ratios

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/fundamentals/historical/ratios"
Enter your API key to send requests

GET/api/v1/stocks/fundamentals/historical/revenue

Historical revenue data

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/fundamentals/historical/revenue"
Enter your API key to send requests

GET/api/v1/stocks/short-interest

Short interest metrics

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/short-interest"
Enter your API key to send requests

GET/api/v1/stocks/float

Float information

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/float"
Enter your API key to send requests

GET/api/v1/stocks/short-volume

Short volume data

Try It
curl -H "X-SentiSense-API-Key: ssk_YOUR_KEY" \ "https://app.sentisense.ai/api/v1/stocks/short-volume"
Enter your API key to send requests