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

# Hierarchical Clustering

> Agglomerative hierarchical clustering that builds a tree of clusters. Supports multiple linkage methods (ward, single, complete, average). Useful for taxonomy creation and dendrogram visualization. [Tier: ENTERPRISE, Credits: 10]



## OpenAPI

````yaml api-specs/ml.json post /quantlib/ml/clustering/hierarchical
openapi: 3.1.0
info:
  title: FinceptQuantLib API - ML
  description: >-
    Machine Learning and Credit Risk module endpoints for FinceptQuantLib API.
    Pro Tier access required (5 credits per request). Covers credit scoring,
    model validation, regression models, clustering, anomaly detection, feature
    engineering, and preprocessing.
  version: 3.0.0
  contact:
    name: Fincept API Support
    url: https://fincept.in
servers:
  - url: https://api.fincept.in
    description: Fincept API Production Server
security:
  - APIKeyHeader: []
tags:
  - name: quantlib-ml
    description: Machine Learning and Credit Risk Analytics
    x-displayName: ML
paths:
  /quantlib/ml/clustering/hierarchical:
    post:
      tags:
        - quantlib-ml
      summary: Hierarchical Clustering
      description: >-
        Agglomerative hierarchical clustering that builds a tree of clusters.
        Supports multiple linkage methods (ward, single, complete, average).
        Useful for taxonomy creation and dendrogram visualization. [Tier:
        ENTERPRISE, Credits: 10]
      operationId: hierarchical_cluster
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - X
              properties:
                X:
                  type: array
                  description: Feature matrix
                  items:
                    type: array
                    items:
                      type: number
                  example:
                    - - 1.2
                      - 0.5
                    - - 1.3
                      - 0.6
                    - - 5.1
                      - 4.8
                    - - 5.3
                      - 4.9
                n_clusters:
                  type: integer
                  description: Number of clusters
                  default: 3
                  example: 2
                linkage:
                  type: string
                  description: Linkage criterion
                  enum:
                    - ward
                    - single
                    - complete
                    - average
                  default: ward
                  example: ward
      responses:
        '200':
          description: Hierarchical clustering results
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      labels:
                        type: array
                        items:
                          type: integer
                        description: Cluster assignment for each sample
                        example:
                          - 0
                          - 0
                          - 1
                          - 1
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/InsufficientCreditsError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  responses:
    UnauthorizedError:
      description: Authentication information is missing or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
                example: Invalid API key
    InsufficientCreditsError:
      description: Insufficient credits for this operation
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
                example: Insufficient credits. This endpoint requires 5 credits.
    ValidationError:
      description: Request validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: array
                items:
                  type: object
                  properties:
                    loc:
                      type: array
                      items:
                        type: string
                    msg:
                      type: string
                    type:
                      type: string
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get your key at
        https://api.fincept.in/auth/register

````