Entities Detail – AltIndex Developers

Authentication

All endpoints require X-API-Key header authentication. See Getting Started for details.

Scope required: entities:detail or entities:*.

Path Parameters

Parameter	Type	Description
`ticker`	string	Stock ticker symbol (e.g., `AAPL`, `TSLA`)

Response

Returns an EntityDetail object.

EntityDetail

Extended entity information with social handles.

Field	Type	Description
`ticker`	string \| null	Stock ticker symbol
`name`	string \| null	Company display name
`industry`	string \| null	Industry classification
`domain`	string \| null	Company website domain
`description`	string \| null	Company description
`social_handles`	SocialHandles	Social media handles object

SocialHandles

Social media handles for an entity. A null value indicates the company doesn't have a presence on that platform or we haven't tracked it yet.

Field	Type	Description
`x`	string \| null	X (Twitter) handle
`instagram`	string \| null	Instagram username
`threads`	string \| null	Threads username
`tiktok`	string \| null	TikTok username
`pinterest`	string \| null	Pinterest username
`reddit`	string \| null	Subreddit name (without r/)
`youtube`	string \| null	YouTube channel name
`facebook`	string \| null	Facebook page ID (stringified)

For extended descriptions of each handle field, platform-specific behavior, and coverage details, see Entities in the Data Dictionary.

Error Responses

Status	Code	Description
401	`MISSING_API_KEY`	No API key provided in the `X-API-Key` header
403	`INVALID_API_KEY`	API key is invalid or has been revoked
403	`INSUFFICIENT_SCOPE`	API key does not have the required `entities:detail` scope
404	`ENTITY_NOT_FOUND`	The requested ticker does not exist
429	`RATE_LIMIT_EXCEEDED`	Daily request limit exceeded

For the full error envelope format, see Error Handling.

GET/api/entities/{ticker}

cURL

curl -X GET "https://v2.api.altindex.com/api/entities/AAPL" \
  -H "X-API-Key: your_api_key_here"

200Retrieved

{
  "ticker": "AAPL",
  "name": "Apple",
  "industry": "Computer Hardware",
  "domain": "apple.com",
  "description": "Apple Inc is designs, manufactures and markets mobile communication and media devices and personal computers, and sells a variety of related software, services, accessories, networking solutions and third-party digital content and applications.",
  "social_handles": {
    "x": "apple",
    "instagram": "apple",
    "threads": null,
    "tiktok": "apple",
    "pinterest": "apple",
    "reddit": "apple",
    "youtube": "apple",
    "facebook": "apple"
  }
}