Data Dictionary
A data dictionary explains what every variable name and value in a dataset actually means. This section provides formal definitions, allowed value ranges, and descriptions for every field returned by the AltIndex API V2 -- so you can integrate with confidence and interpret results correctly.
How to Read the Dictionary Tables
Each dataset page contains tables with the following columns:
| Column | Purpose |
|---|---|
| Variable Name | The exact field name as it appears in the API JSON response |
| Type | Data type (string, integer, float, date, object, array) |
| Allowed Values | Range, enumeration, or format constraint for valid values |
| Definition | A concise, formal definition of the variable |
| Description | Extended explanation with platform-specific notes, edge cases, and context |
Null handling: Social metric fields are nullable. When a metric is not available for a given platform or date, the field is omitted from the response rather than returned as null. See the API V2 Social reference for the platform-metric availability matrix.
Datasets
Entities
Company and entity metadata returned by the GET /api/entities and GET /api/entities/{ticker} endpoints. Includes ticker symbols, company names, industry classifications, and the social handle mappings that power every social data endpoint.
Social Followers
Daily follower and subscriber counts across 8 social platforms -- Instagram, X (Twitter), Facebook, Threads, TikTok, Pinterest, YouTube, and Reddit. Returned by the GET /api/social/{platform}/{ticker} endpoints.
Mentions & Sentiment
Mention counts and sentiment scores derived from public discussion data on Reddit, Stocktwits, X (Twitter), and 4chan /biz/. Returned by the GET /api/social/{platform}/{ticker} endpoints.
Related Pages
- Data Coverage -- Full catalog of datasets and metrics available through the API
- Collection & Freshness -- Update frequency and historical depth per metric
- Knowledge Graph -- How tickers are mapped to social accounts and platform identifiers