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

# APIKey管理

> 无需登录官网，即可查询 API Key 的到期情况，便于定时检查和设置提醒。

## 套餐权限

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

使用自己的 API Key 查询账户名下各 Key 的到期时间和剩余秒数，无需登录官网。

## 请求参数

该接口不需要查询参数。

## 请求示例

```bash theme={null}
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.tickdb.ai/v1/apikeys/subscriptions"
```

## 返回字段说明

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

| 字段 | 说明 |
| - | - |
| server\_time | 本次查询的服务器时间，带时区的日期时间字符串。 |
| total | 返回的 API Key 数量。 |
| api\_keys | 账户名下的 API Key 列表。 |
| └─ key\_prefix | API Key 前缀，用于辨认 Key；不是完整密钥。 |
| └─ name | API Key 名称。 |
| └─ plan | 该 Key 对应的套餐标识。 |
| └─ status | Key 状态：`active`（有效）、`expired`（已过期）、`suspended`（已暂停）、`revoked`（已撤销）。 |
| └─ expires\_at | 到期时间；未设置到期时间时为 `null`。 |
| └─ remaining\_seconds | 距离到期的剩余秒数；已到期时为 `0`，未设置到期时间时为 `null`。 |
| └─ created\_at | API Key 创建时间。 |


## OpenAPI

````yaml openapi.yaml GET /v1/apikeys/subscriptions
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/apikeys/subscriptions:
    get:
      tags:
        - account
      summary: APIKey管理
      description: 无需登录官网，即可查询 API Key 的到期情况，便于定时检查和设置提醒。
      operationId: getAPIKeyStatus
      responses:
        '200':
          $ref: '#/components/responses/APIKeyStatusResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  responses:
    APIKeyStatusResponse:
      description: APIKey管理响应。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIKeyStatusEnvelope'
    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:
    APIKeyStatusEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          required:
            - data
          properties:
            message:
              type: string
              description: 请求结果说明。
            data:
              $ref: '#/components/schemas/APIKeyStatusData'
    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。
    APIKeyStatusData:
      type: object
      required:
        - server_time
        - total
        - api_keys
      properties:
        server_time:
          type: string
          format: date-time
          description: 本次查询的服务器时间。
        total:
          type: integer
          minimum: 0
          description: 返回的 API Key 数量。
        api_keys:
          type: array
          description: 当前账户名下的 API Key 列表。
          items:
            $ref: '#/components/schemas/APIKeyStatusItem'
      additionalProperties: false
    APIKeyStatusItem:
      type: object
      required:
        - key_prefix
        - name
        - plan
        - status
        - expires_at
        - remaining_seconds
        - created_at
      properties:
        key_prefix:
          type: string
          description: 用于辨认 Key 的前缀，不是完整密钥。
        name:
          type: string
          description: API Key 名称。
        plan:
          type: string
          description: 套餐标识。
        status:
          type: string
          enum:
            - active
            - expired
            - suspended
            - revoked
          description: API Key 状态。
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: 到期时间；未设置时为 null。
        remaining_seconds:
          type:
            - integer
            - 'null'
          minimum: 0
          description: 剩余秒数；已到期为 0，未设置到期时间时为 null。
        created_at:
          type: string
          format: date-time
          description: API Key 创建时间。
      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.