Entities
Entity variables describe the companies and cryptocurrencies tracked by AltIndex. These fields are returned by the GET /api/entities and GET /api/entities/{ticker} endpoints and form the foundation for all other data in the API.
EntitySummary
Returned for each item in the items array of the GET /api/entities response.
| Variable Name | Type | Allowed Values | Definition | Description |
|---|---|---|---|---|
ticker | string | NYSE/NASDAQ symbols (e.g., AAPL, TSLA, BTC) | A unique exchange-listed stock symbol that identifies the entity | The primary lookup key used across all AltIndex API endpoints. Corresponds to the company's listing on NYSE or NASDAQ. Cryptocurrency entities use their standard trading symbol (e.g., BTC, ETH). |
name | string | Free text (e.g., Apple Inc., Tesla, Inc.) | The full legal or commonly used name of the entity | The official company name as listed on the exchange. Used for display and search purposes. May include suffixes like "Inc.", "Corp.", or "Ltd." |
domain | string | Valid domain (e.g., apple.com, tesla.com) | The primary web domain associated with the entity | The company's main website domain, without protocol prefix. Used internally for web traffic tracking and entity disambiguation. May be null if no domain is mapped. |
industry | string | Industry labels (e.g., Technology, Autos, Banks) | The industry sector the entity belongs to | AltIndex's internal industry classification used for peer grouping and industry benchmark comparisons. A company's industry determines which peers appear in the GET /industry_benchmark endpoint. |
EntityDetail
Returned by the GET /api/entities/{ticker} endpoint. Includes all EntitySummary fields plus the following additional variables.
| Variable Name | Type | Allowed Values | Definition | Description |
|---|---|---|---|---|
description | string | Free text (typically 1--3 sentences) | A brief summary of what the company does | A human-readable description of the entity's primary business activities. Sourced from public filings and company profiles. May be null for entities where a description has not been curated. |
social_handles | object | SocialHandles object | A mapping of platform names to the entity's verified social media identifiers | Contains the social media handles and platform identifiers used by AltIndex to collect social data for this entity. If a handle is present, social time-series data is available for that platform. See the Knowledge Graph for details on how mappings are curated. |
SocialHandles
Nested object within EntityDetail that maps each social platform to the entity's handle or identifier. Each field is a string or null (if the entity has no tracked account on that platform).
These handles are used by the social metrics endpoints to collect data. See the Social Reference for endpoint details.
| Variable Name | Type | Allowed Values | Definition | Description |
|---|---|---|---|---|
x | string | Twitter/X username (e.g., Apple, Tesla) | The entity's verified X (formerly Twitter) account handle | Used to collect follower counts, cashtag mention counts, and sentiment data. null if no X account is mapped. |
instagram | string | Instagram username (e.g., apple, tesla) | The entity's verified Instagram account handle | Used to collect follower counts. null if no Instagram account is mapped. |
tiktok | string | TikTok username (e.g., tesla) | The entity's verified TikTok account handle | Used to collect follower counts. null if no TikTok account is mapped. Currently mapped for ~273 companies. |
pinterest | string | Pinterest username (e.g., teslamotors) | The entity's verified Pinterest account handle | Used to collect follower counts. null if no Pinterest account is mapped. |
reddit | string | Subreddit name without r/ prefix (e.g., TeslaMotors) | The entity's official or primary subreddit | Used to collect subreddit subscriber counts, mention counts, and sentiment data. null if no subreddit is mapped. Currently mapped for ~139 companies. |
threads | string | Threads username (e.g., tesla) | The entity's verified Threads (by Meta) account handle | Used to collect follower counts. null if no Threads account is mapped. Threads data collection began July 2023. |
youtube | string | YouTube channel name or ID | The entity's YouTube channel identifier | Used to collect follower counts. Sourced from youtube_channel. null if no YouTube channel is mapped. |
facebook | string | Facebook page ID (string) | The entity's Facebook page identifier | Used to collect follower counts. Returned as a string (stringified from internal facebook_id). null if no Facebook page is mapped. |