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

# Industry Metric Rankings

> Retrieve industries ranked by a market-wide industry metric.

## Plan Access

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

## Notes

* This endpoint queries by `market`, not by stock symbol. The returned `industry_counter_id` can be used with the industry hierarchy endpoint.
* `market` is case-insensitive. This documentation uses uppercase market codes consistently.

## Supported Markets

| Market | Examples |
| - | - |
| US Stocks | US |
| HK Stocks | HK |
| A-Shares | CN |

## Request Parameters

| Parameter | Required | Description |
| - | :-: | - |
| `market` | Yes | Market code: `US` US stocks, `HK` Hong Kong stocks, or `CN` A-shares |
| `limit` | No | Number of records; default 50, range `1–200` |

## Request Example

```bash theme={null}
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.tickdb.ai/v1/fundamentals/industries/rank?market=US&limit=50"
```

## Response Fields

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

| Field | Description |
| - | - |
| market | Queried market. |
| indicator | Ranking metric. |
| sort\_type | Sort order. |
| items | Ranked industry metrics. |
| └─ industry\_counter\_id | Industry node ID. |
| └─ industry\_name | Industry name. |
| └─ rank | Rank. |
| └─ value | Total industry market capitalization. |
| └─ change\_percent | Percentage change. |

Returns industry IDs, names, ranks, total market capitalizations, and percentage changes. Use an industry ID to query the industry hierarchy.


## OpenAPI

````yaml openapi.en.yaml GET /v1/fundamentals/industries/rank
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/industries/rank:
    get:
      tags:
        - fundamentals-valuation-industry
      summary: Industry Metric Rankings
      description: Retrieve industries ranked by a market-wide industry metric.
      operationId: getFundamentalsIndustriesRank
      parameters:
        - $ref: '#/components/parameters/RequiredMarketQuery'
        - $ref: '#/components/parameters/IndustryRankLimitQuery'
      responses:
        '200':
          $ref: '#/components/responses/IndustriesRankResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    RequiredMarketQuery:
      name: market
      in: query
      required: true
      schema:
        type: string
        enum:
          - US
          - HK
          - CN
      description: 'Market code: `US` US stocks, `HK` Hong Kong stocks, or `CN` A-shares'
    IndustryRankLimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: Number of records; default 50, range `1–200`
  responses:
    IndustriesRankResponse:
      description: Industry Metric Rankings response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IndustriesRankEnvelope'
    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:
    IndustriesRankEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/IndustriesRankData'
    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.
    IndustriesRankData:
      type: object
      required:
        - market
        - indicator
        - sort_type
        - items
      properties:
        market:
          type: string
          description: Queried market.
        indicator:
          type: string
          description: Ranking metric.
        sort_type:
          type: string
          description: Sort order.
        items:
          type: array
          description: Ranked industry metrics.
          items:
            $ref: '#/components/schemas/IndustryRankItem'
      additionalProperties: true
    IndustryRankItem:
      type: object
      required:
        - industry_counter_id
        - industry_name
        - rank
        - value
        - change_percent
      properties:
        industry_counter_id:
          type: string
          description: Industry node ID.
        industry_name:
          type: string
          description: Industry name.
        rank:
          type: integer
          description: Rank.
        value:
          type:
            - string
            - number
          description: Total industry market capitalization.
        change_percent:
          type:
            - string
            - number
            - 'null'
          description: Percentage change.
      additionalProperties: true
  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.