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

# Profile links by username

> Returns the public links array for the profile identified by username. **Permission required:** `api.lookup`.

Returns the public **links** array for the profile identified by username (or alias). Requires permission **`api.lookup`**. Use URL-encoded `username` in the path.

Each link includes `id`, `name`, `link`, and optionally `title`, `image`, `clicksCount`, `linkMode`.


## OpenAPI

````yaml GET /lookup/username/{username}/links
openapi: 3.1.0
info:
  title: frozi.lol API
  description: >-
    REST API for frozi.lol. Access profile data, leaderboard, and
    profile-related content (e.g. links). All endpoints require a valid API key.
  version: 1.0.0
servers:
  - url: https://frozi.lol/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leaderboard
    description: Top profiles by view count
  - name: Lookup
    description: Profile and links lookup by username, UID, or auth ID
paths:
  /lookup/username/{username}/links:
    get:
      tags:
        - Lookup
      summary: Profile links by username
      description: >-
        Returns the public links array for the profile identified by username.
        **Permission required:** `api.lookup`.
      operationId: lookupLinksByUsername
      parameters:
        - name: username
          in: path
          description: Primary username or alias (URL-encoded)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Profile links
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileLinksResponse'
        default:
          description: >-
            Error response. See [Errors](/api-reference/errors) for status codes
            and format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ProfileLinksResponse:
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/ProfileLink'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message
    ProfileLink:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        link:
          type: string
        title:
          type: string
          nullable: true
        image:
          type: string
          nullable: true
        clicksCount:
          type: number
        linkMode:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key from Dashboard → Developer Platform → API Keys. Send as:
        Authorization: Bearer <API_KEY>

````