> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tickdb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Company Profile

> Retrieve basic company information, market, industry, and listing details.

## Plan Access

| Plan | Available |
| - | :-: |
| Free | ❌ |
| Starter | ✅ |
| Professional | ✅ |
| Full-Market Plans (A-Shares, HK Stocks, US Stocks) | ✅ |
| Enterprise | ✅ |

## Notes

* Some profile fields may be an empty string or `null`; do not interpret a missing value as “none.”

## Supported Markets

| Market | Examples |
| - | - |
| US Stocks | AAPL.US |
| HK Stocks | 700.HK |
| A-Shares | 600519.SH |

## Request Parameters

| Parameter | Required | Description |
| - | :-: | - |
| `symbol` | Yes | Stock symbol |
| `type` | No | Product type; currently supports `stock` |

## Request Example

```bash theme={null}
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.tickdb.ai/v1/fundamentals/profile?symbol=AAPL&type=stock"
```

## Response Fields

The table below lists fields in `data`; an outer `code=0` indicates success.

| Field | Description |
| - | - |
| symbol | Normalized stock symbol. |
| market | Market. |
| region | Region. |
| company\_name | Full company name. |
| name | Display name. |
| profile | Business profile. |
| address | Address. |
| office\_address | Office address. |
| phone | Telephone number. |
| email | Email address. |
| website | Company website. |
| founded | Founding year or date; `null` when unavailable. |
| listing\_date | Listing date in `YYYY-MM-DD` format; may be `null`. |
| year\_end | Fiscal year-end information; may be `null`. |
| employees | Number of employees. |
| chairman | Chairperson. |
| manager | Principal manager. |
| secretary | Company secretary. |
| legal\_repr | Legal representative. |
| accounting\_firm | Accounting firm. |
| legal\_counsel | Legal counsel. |
| category | Company category. |

Field availability varies by market and company; use the actual response as the source of truth.


## OpenAPI

````yaml openapi.en.yaml GET /v1/fundamentals/profile
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB unified real-time market data API via REST and WebSocket.
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/fundamentals/profile:
    get:
      tags:
        - fundamentals-company
      summary: Company Profile
      description: >-
        Retrieve basic company information, market, industry, and listing
        details.
      operationId: getFundamentalsProfile
      parameters:
        - $ref: '#/components/parameters/SymbolQuery'
        - $ref: '#/components/parameters/TypeQuery'
      responses:
        '200':
          $ref: '#/components/responses/ProfileResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    SymbolQuery:
      name: symbol
      in: query
      required: true
      schema:
        type: string
        examples:
          - AAPL
          - '700'
          - '600519'
          - AAPL.US
          - 700.HK
          - 600519.SH
      description: Stock symbol
    TypeQuery:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - stock
      description: Product type; currently supports `stock`
  responses:
    ProfileResponse:
      description: Company Profile response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfileEnvelope'
    ErrorResponse:
      description: >-
        Error response. Common HTTP statuses include 400 (invalid parameters),
        401 (authentication failed), 403 (permission or quota restriction), 404
        (no matching data), 429 (rate limit), and 503 (service temporarily
        unavailable).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingAPIKey:
              summary: Missing API key
              value:
                code: '1002'
                message: API key is required. Provide via X-API-Key header
                error: '1002'
            missingKind:
              summary: Missing required parameter
              value:
                code: 40001
                message: kind is required
                data: null
            endpointForbidden:
              summary: API key cannot access this endpoint
              value:
                code: 3009
                message: This endpoint is not allowed for your API key
                data: null
            marketForbidden:
              summary: API key cannot access this market
              value:
                code: 3010
                message: Fundamentals market not allowed for your API key
                data:
                  market: US
            noAvailableSource:
              summary: Data temporarily unavailable
              value:
                code: 5003
                message: Data is temporarily unavailable
                data: null
            notFound:
              summary: No matching data
              value:
                code: 40404
                message: shareholder detail not found
                data: null
            businessNoData:
              summary: No business data matches the query
              value:
                code: 40405
                message: valuation time series not found
                data: null
  schemas:
    ProfileEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/ProfileData'
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
      properties:
        code:
          description: >-
            TickDB API business error code; may be an integer or string. Convert
            it to a string before comparing.
          oneOf:
            - type: integer
            - type: string
        message:
          type: string
          description: Error description.
        error:
          type: string
          description: >-
            Compatibility error identifier; present only in some error
            responses.
        data:
          description: Optional error context; may be null, an object, or an array.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
            - type: array
              items: {}
    SuccessEnvelope:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          const: 0
          description: Business status code; `0` means success.
    ProfileData:
      type: object
      description: Company profile data.
      required:
        - symbol
        - market
        - name
      properties:
        symbol:
          type: string
          description: Normalized stock symbol.
        name:
          type: string
          description: Display name.
        company_name:
          type: string
          description: Full company name.
        market:
          type: string
          description: Market.
        region:
          type: string
          description: Region.
        founded:
          type:
            - string
            - 'null'
          description: Founding year or date; `null` when unavailable.
        listing_date:
          type:
            - string
            - 'null'
          format: date
          description: Listing date in `YYYY-MM-DD` format; may be `null`.
        year_end:
          type:
            - string
            - 'null'
          description: Fiscal year-end information; may be `null`.
        address:
          type: string
          description: Address.
        office_address:
          type: string
          description: Office address.
        phone:
          type: string
          description: Telephone number.
        email:
          type: string
          description: Email address.
        website:
          type: string
          description: Company website.
        employees:
          type: integer
          description: Number of employees.
        chairman:
          type: string
          description: Chairperson.
        manager:
          type: string
          description: Principal manager.
        secretary:
          type: string
          description: Company secretary.
        legal_repr:
          type: string
          description: Legal representative.
        accounting_firm:
          type: string
          description: Accounting firm.
        legal_counsel:
          type: string
          description: Legal counsel.
        category:
          type: string
          description: Company category.
        profile:
          type: string
          description: Business profile.
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.