Entities List – AltIndex Developers

Authentication

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

Scope required: entities:list or entities:*.

Query Parameters

Parameter	Type	Default	Description
`search`	string	-	Filter entities by name or ticker (case-insensitive)
`limit`	integer	50	Maximum results to return (min: 1)
`offset`	integer	0	Number of results to skip for pagination

Response

Returns an EntityListResponse object.

EntitySummary

Basic entity information returned in list results.

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

EntityListResponse

Paginated list of entities.

Field	Type	Description
`items`	EntitySummary[]	Array of entity summaries
`limit`	integer	Limit used in the request
`offset`	integer	Offset used in the request
`total`	integer	Total number of matching entities

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:list` scope
429	`RATE_LIMIT_EXCEEDED`	Daily request limit exceeded

For the full error envelope format, see Error Handling.

GET/api/entities

cURL

curl -X GET "https://v2.api.altindex.com/api/entities?search=apple&limit=10" \
  -H "X-API-Key: your_api_key_here"

200Retrieved

{
  "items": [
    {
      "ticker": "AAPL",
      "name": "Apple",
      "industry": "Computer Hardware",
      "domain": "apple.com"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total": 1
}