Skip to main content
GET
/
api
/
v1
/
indices
/
{identifier}
/
companies
List index companies
curl --request GET \
  --url http://localhost:3000/api/v1/indices/{identifier}/companies \
  --header 'Authorization: Bearer <token>'
{
  "companies": [
    {
      "id": "comp_apple123",
      "name": "Apple Inc.",
      "slug": "apple-inc",
      "ticker_symbol": "VOLV-B.ST",
      "exchange": {
        "id": "<string>",
        "name": "<string>",
        "mic_code": "<string>"
      }
    }
  ],
  "pagination": {
    "count": 123,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Headers

Authorization
string
required

Bearer token for authentication

Path Parameters

identifier
string
required

Stock index ID or symbol (e.g. OMXS30)

Query Parameters

limit
integer

Number of companies to return per page (default 25, max 100).

cursor
string

Opaque pagination cursor from a previous response.

Response

Index companies retrieved successfully

companies
object[]
required
pagination
object