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

# Get User Stats

> **/user/{userId}/stats**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**/user/{userId}/stats**

**Description:**\
The `/user/{userId}/stats` endpoint allows users to retrieve statistical information related to a specific user identified by their unique userId.

**Method:**\
GET

**Path Parameter:**

| Parameter | Type   | Description                        |
| --------- | ------ | ---------------------------------- |
| userId    | string | The unique identifier of the user. |

> See Sample Response below

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/user/example-id/stats', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
    'https://api.royalti.io/user/example-id/stats',
    headers={
      'Authorization': f'Bearer {token}'
    },
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X GET https://api.royalti.io/user/example-id/stats \
    -H "Authorization: Bearer YOUR_TOKEN" \

  ```
</CodeGroup>


## OpenAPI

````yaml get /user/{id}/stats
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /user/{id}/stats:
    get:
      tags:
        - User
      summary: Get User Stats
      description: >-
        **/user/{userId}/stats**


        **Description:**  

        The `/user/{userId}/stats` endpoint allows users to retrieve statistical
        information related to a specific user identified by their unique
        userId.


        **Method:**  

        GET


        **Path Parameter:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | userId | string | The unique identifier of the user. |


        > See Sample Response below
      parameters:
        - name: id
          in: path
          required: true
          description: User ID
          schema:
            type: string
      responses:
        '200':
          description: Success (NEW) - get user stats
          content:
            application/json:
              schema:
                type: object
                properties:
                  artists:
                    type: integer
                    description: Number of artists associated with the user
                  assets:
                    type: integer
                    description: Number of assets associated with the user
                  products:
                    type: integer
                    description: Number of products associated with the user
                  splits:
                    type: integer
                    description: Number of splits/shares assigned to the user
                  Royalty_Share:
                    type: number
                    description: Total royalty share amount
                  paid:
                    type: number
                    description: Amount already paid to the user
                  net:
                    type: number
                    description: Net earnings
                  gross:
                    type: number
                    description: Gross earnings
                  due:
                    type: number
                    description: Amount currently due to the user
              example:
                artists: 5
                assets: 17
                products: 7
                splits: 10
                Royalty_Share: 1135.2762243941013
                paid: 100
                net: 1135.2762243941013
                gross: 1135.2762243941013
                due: 1035.2762243941013
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````