For AI agents: complete Markdown index · compact index. Follow the explicit .md links for the Markdown version of each page.

Equities

Company Profile

GET/v2/equities/profile

Returns company identity, classification, and market data.

This endpoint is equity-specific. For ETF or fund profiles, use the ETF or Fund domain.

Included in: Startup, Pro, Growth.

Authentication

Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key (free trial) · Authentication guide.

Parameters

Required: one of symbol, isin, for example symbol=AAPL.

  • stringquery · one of symbol, isin

    Stock ticker symbol (e.g., AAPL, MSFT, GOOGL). Provide exactly one of symbol or isin.

    Example AAPL

  • stringquery · one of symbol, isin

    ISIN code (e.g., US0378331005). Provide exactly one of symbol or isin. Clear the symbol example before using an ISIN.

Response 200

Successful response · application/json

  • data
    CompanyProfile

    Company identity and classification. For equities; ETF and fund flags are not included.

    23 fields in data
    • symbol
      string
      required

      Ticker symbol

      Example: AAPL

    • companyName
      string
      required

      Legal company name

      Example: Apple Inc.

    • description
      string

      Business summary of the company

    • ceo
      string

      Chief Executive Officer name

      Example: Timothy D. Cook

    • sector
      string

      GICS sector

      Example: Technology

    • industry
      string

      GICS industry

      Example: Consumer Electronics

    • country
      string

      ISO 3166-1 alpha-2

      Example: US

    • state
      string

      State or province of headquarters

      Example: CA

    • city
      string

      City of headquarters

      Example: Cupertino

    • address
      string

      Street address of headquarters

      Example: One Apple Park Way

    • zip
      string

      Postal or ZIP code

      Example: 95014

    • phone
      string

      Primary contact phone number

      Example: (408) 996-1010

    • website
      string (uri)

      Company website URL

      Example: https://www.apple.com

    • exchange
      string

      Full name of the listing exchange

      Example: NASDAQ Global Select

    • exchangeShortName
      string

      Abbreviated exchange name

      Example: NASDAQ

    • isin
      string

      International Securities Identification Number

      Example: US0378331005

    • cik
      string | null

      SEC Central Index Key

      Example: 320193

    • ipo
      string (date) | null

      Initial public offering date

      Example: 1980-12-12

    • currency
      string

      Primary trading currency (ISO 4217)

      Example: USD

    • employeeTotal
      integer | null

      Total number of employees

      Example: 164000

    • isActivelyTrading
      boolean

      Whether the security is currently actively traded

      Example: true

    • isAdr
      boolean

      Whether the security is an American Depositary Receipt

      Example: false

    • isReit
      boolean | null

      Whether the company is a REIT (real estate investment trust): its industry starts with "REIT", e.g. Realty Income "REIT - Retail". Never true for ETFs or funds. null when no industry is known.

      Example: true

  • meta
    ResponseMeta

    Response metadata, including server-side processing time and resolved request parameters. Successful and error responses use the same metadata shape.

    2 fields in meta
    • time
      integer

      Server-side processing time in milliseconds

      Example: 17

    • parameters
      object

      Echo of the request parameters the endpoint resolved

Errors

  • 400 Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
  • 401 Missing or invalid API key.
  • 404 Resource not found.
  • 429 Rate limit exceeded. Retry after the `Retry-After` header interval.
  • 500 An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 502 Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
  • 504 The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
  • default An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 403 from the gateway: the API key is invalid or switched off.

  • 429 with message Limit Exceeded: the monthly quota of the key is used up. With Too Many Requests: the key is throttled, or this route is not in the key's plan. Wait for Retry-After when it is sent.

For AI agents: this page as Markdown at /docs/v2_equities_profile.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.