companies_list

Retrieve a paginated list of companies.

Supports filtering via query parameters defined in the CompanyFilter,
searching via the 'search' parameter (searches name, ISINs, LEI, Ticker),
and ordering via the 'ordering' parameter (allowed fields: name, date_ipo, year_founded, country_iso__name).

Request

Query Params

countries

string

optional

Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values (e.g., US,GB,DE).

industry

string

optional

Filter by GICS Industry code.

industry_group

string

optional

Filter by GICS Industry Group code.

isin

string

optional

Find companies matching the provided ISIN.

lei

string

optional

Find a company by its LEI.

ordering

string

optional

Which field to use when ordering the results.

page

integer

optional

A page number within the paginated result set.

page_size

integer

optional

Number of results to return per page.

string

optional

A search term.

sector

string

optional

Filter by GICS Sector code.

sub_industry

string

optional

Filter by GICS Sub-Industry code.

ticker

string

optional

Find a company by its Ticker.

Header Params

x-api-key

string

required

Responses

🟢200OK

application/json

Body

count

integer

required

Example:

123

string <uri> | null

optional

Example:

http://api.example.org/accounts/?page=4

string <uri> | null

optional

Example:

http://api.example.org/accounts/?page=2

results

array[object (Company) {29}]

required

integer

read-onlyrequired

Unique identifier for the company.

name

string

read-onlyrequired

Company name.

lei

string

read-onlyrequired

Legal Entity Identifier (ISO 17442).

country_code

string

read-onlyrequired

ISO 3166-1 alpha-2 country code of the company's primary registration or headquarters.

sector

object

read-onlyrequired

Company's GICS Sector classification.

industry_group

object

read-onlyrequired

Company's GICS Industry Group classification.

industry

object

read-onlyrequired

Company's GICS Industry classification.

sub_industry

object

read-onlyrequired

Company's GICS Sub-Industry classification.

ir_link

string <uri>

read-onlyrequired

Link to the company's Investor Relations page.

homepage_link

string <uri>

read-onlyrequired

Link to the company's main homepage.

date_public

string <date>

read-onlyrequired

Date the company first became public.

date_ipo

string <date>

read-onlyrequired

Date of the company's Initial Public Offering.

main_stock_exchange

string

read-onlyrequired

Primary stock exchange where the company is listed.

social_facebook

string

read-onlyrequired

Facebook profile/page identifier.

social_instagram

string

read-onlyrequired

Instagram profile identifier.

social_twitter

string

read-onlyrequired

Twitter handle (without @).

social_linkedin

string

read-onlyrequired

LinkedIn company page identifier/URL path.

social_youtube

string

read-onlyrequired

YouTube channel identifier.

social_tiktok

string

read-onlyrequired

TikTok profile identifier.

social_pinterest

string

read-onlyrequired

Pinterest profile identifier.

social_xing

string

read-onlyrequired

Xing company profile identifier.

social_glassdoor

string

read-onlyrequired

Glassdoor company identifier.

year_founded

string <date> | null

read-onlyrequired

Date the company was founded.

corporate_video_id

string

read-onlyrequired

Identifier for a corporate video (e.g., YouTube ID).

served_area

string

read-onlyrequired

Geographical area served by the company.

headcount

integer

read-onlyrequired

Approximate number of employees.

contact_email

string <email>

read-onlyrequired

General contact email address.

ticker

string

read-onlyrequired

Primary stock ticker symbol.

is_listed

boolean

read-onlyrequired

Indicates if the company is currently publicly listed.

Example

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "name": "string",
      "lei": "string",
      "country_code": "string",
      "sector": {
        "code": "string",
        "name": "string"
      },
      "industry_group": {
        "code": "string",
        "name": "string",
        "sector": {
          "code": "string",
          "name": "string"
        }
      },
      "industry": {
        "code": "string",
        "name": "string",
        "industry_group": {
          "code": "string",
          "name": "string",
          "sector": {
            "code": "string",
            "name": "string"
          }
        }
      },
      "sub_industry": {
        "code": "string",
        "name": "string",
        "industry": {}
      },
      "ir_link": "http://example.com",
      "homepage_link": "http://example.com",
      "date_public": "2019-08-24",
      "date_ipo": "2019-08-24",
      "main_stock_exchange": "string",
      "social_facebook": "string",
      "social_instagram": "string",
      "social_twitter": "string",
      "social_linkedin": "string",
      "social_youtube": "string",
      "social_tiktok": "string",
      "social_pinterest": "string",
      "social_xing": "string",
      "social_glassdoor": "string",
      "year_founded": "2019-08-24",
      "corporate_video_id": "string",
      "served_area": "string",
      "headcount": 0,
      "contact_email": "user@example.com",
      "ticker": "string",
      "is_listed": true
    }
  ]
}

Request

Request samples

Responses