> ## 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.

# 公司资料

> 获取公司的基本资料、所属市场、行业和上市信息。

## 套餐权限

| 套餐 | 可用 |
| - | :-: |
| 免费版 | ❌ |
| 基础版 | ✅ |
| 专业版 | ✅ |
| 全量套餐（A 股、港股、美股） | ✅ |
| 企业版 | ✅ |

## 注意事项

* 部分资料字段可能为空字符串或 `null`；不要把缺失值当作“无”。

## 支持的市场

| 市场 | 示例 |
| - | - |
| 美股 | AAPL.US |
| 港股 | 700.HK |
| A股 | 600519.SH |

## 请求参数

| 参数 | 是否必须 | 说明 |
| - | :-: | - |
| `symbol` | 是 | 股票代码 |
| `type` | 否 | 产品类型，当前支持 `stock` |

## 请求示例

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

## 返回字段说明

以下列出 `data` 中的字段；外层 `code=0` 表示成功。

| 字段 | 说明 |
| - | - |
| symbol | 标准化股票代码。 |
| market | 所属市场。 |
| region | 所属地区。 |
| company\_name | 公司全称。 |
| name | 展示名称。 |
| profile | 公司业务简介。 |
| address | 地址。 |
| office\_address | 办公地址。 |
| phone | 联系电话。 |
| email | 电子邮箱。 |
| website | 公司网站。 |
| founded | 成立年份或日期；无数据时为 null。 |
| listing\_date | 上市日期，格式 `YYYY-MM-DD`；可能为 `null`。 |
| year\_end | 财年结束信息；可能为 null。 |
| employees | 员工人数。 |
| chairman | 董事长。 |
| manager | 主要管理人员。 |
| secretary | 公司秘书。 |
| legal\_repr | 法定代表人。 |
| accounting\_firm | 会计师事务所。 |
| legal\_counsel | 法律顾问。 |
| category | 公司类别。 |

部分字段会因市场及个股而异；以实际返回为准。


## OpenAPI

````yaml openapi.yaml GET /v1/fundamentals/profile
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB 统一实时行情数据 API，提供 REST 和 WebSocket 接入。
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: 生产环境
security:
  - ApiKeyAuth: []
paths:
  /v1/fundamentals/profile:
    get:
      tags:
        - fundamentals-company
      summary: 公司资料
      description: 获取公司的基本资料、所属市场、行业和上市信息。
      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: 股票代码
    TypeQuery:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - stock
      description: 产品类型，当前支持 `stock`
  responses:
    ProfileResponse:
      description: 公司资料响应。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfileEnvelope'
    ErrorResponse:
      description: >-
        错误响应。常见 HTTP 状态包括
        400（参数错误）、401（鉴权失败）、403（权限或配额限制）、404（无匹配数据）、429（请求频率限制）和 503（服务暂不可用）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingAPIKey:
              summary: 缺少 API Key
              value:
                code: '1002'
                message: API key is required. Provide via X-API-Key header
                error: '1002'
            missingKind:
              summary: 缺少必填参数
              value:
                code: 40001
                message: kind is required
                data: null
            endpointForbidden:
              summary: API Key 无权访问该接口
              value:
                code: 3009
                message: This endpoint is not allowed for your API key
                data: null
            marketForbidden:
              summary: API Key 未开放该市场
              value:
                code: 3010
                message: Fundamentals market not allowed for your API key
                data:
                  market: US
            noAvailableSource:
              summary: 数据暂不可用
              value:
                code: 5003
                message: Data is temporarily unavailable
                data: null
            notFound:
              summary: 无匹配数据
              value:
                code: 40404
                message: shareholder detail not found
                data: null
            businessNoData:
              summary: 查询条件无有效业务数据
              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 业务错误码；可能为整数或字符串，客户端应归一化为字符串后比较。
          oneOf:
            - type: integer
            - type: string
        message:
          type: string
          description: 错误说明。
        error:
          type: string
          description: 兼容错误标识；仅部分错误响应返回。
        data:
          description: 可选的错误上下文；可能为 null、对象或数组。
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
            - type: array
              items: {}
    SuccessEnvelope:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          const: 0
          description: 业务状态码，成功为 0。
    ProfileData:
      type: object
      description: 公司资料数据。
      required:
        - symbol
        - market
        - name
      properties:
        symbol:
          type: string
          description: 标准化股票代码，例如 AAPL.US、700.HK、600519.SH。
        name:
          type: string
          description: 公司名称。
        company_name:
          type: string
          description: 公司法定或英文名称。
        market:
          type: string
          description: 市场代码。
        region:
          type: string
          description: 国家或地区代码。
        founded:
          type:
            - string
            - 'null'
          description: 成立年份或日期；无数据时为 null。
        listing_date:
          type:
            - string
            - 'null'
          format: date
          description: 上市日期；无数据时为 null。
        year_end:
          type:
            - string
            - 'null'
          description: 财年结束信息。
        address:
          type: string
          description: 地址。
        office_address:
          type: string
          description: 办公地址。
        phone:
          type: string
          description: 联系电话。
        email:
          type: string
          description: 电子邮箱。
        website:
          type: string
          description: 公司网站；返回值可能不带 URL 协议前缀。
        employees:
          type: integer
          description: 员工数。
        chairman:
          type: string
          description: 董事长。
        manager:
          type: string
          description: 主要管理人员。
        secretary:
          type: string
          description: 公司秘书。
        legal_repr:
          type: string
          description: 法定代表人。
        accounting_firm:
          type: string
          description: 会计师事务所。
        legal_counsel:
          type: string
          description: 法律顾问。
        category:
          type: string
          description: 公司类别。
        profile:
          type: string
          description: 公司业务简介。
      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.