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

# Read Profile

> Profile and follower counts for ANY public account — no connected channel required. Metered per upstream call.

## No connected channel required

Every other endpoint in this API acts through a channel **you connected**. Reads do not: the
server queries its own data provider, so `/reads/*` works for **any public account** — a
competitor, a prospect, someone you have never touched.

That is also why a target is mandatory. There is no "me" here (nothing in the request
identifies an account of yours), so pass `username` or `user_id`:

```bash theme={null}
curl -H "Authorization: your-api-key" \
  "https://api.groniz.com/public/v1/reads/x/profile?username=elonmusk"
```

`user_id` is cheaper than `username` — a handle costs an extra lookup upstream, and reads are
metered per upstream call. Every profile response returns `id`; reuse it for follow-up reads.


## OpenAPI

````yaml GET /reads/{platform}/profile
openapi: 3.1.0
info:
  title: Groniz Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Groniz.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:


    ```

    Authorization: your-api-key

    ```


    Get your API key from Groniz Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27)


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook,
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.groniz.com/public/v1
    description: Groniz Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Groniz instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
  - name: Reads
    description: >-
      Read public data from a platform. Unlike Analytics, these require NO
      connected channel: the server reads with its own data-provider key, so
      they work for ANY public account. Metered per upstream call. Only `x` is
      supported today.
paths:
  /reads/{platform}/profile:
    get:
      tags:
        - Reads
      summary: Read an account profile
      description: >-
        Profile and follower counts for ANY public account — no connected
        channel required. Metered per upstream call.
      operationId: readProfile
      parameters:
        - name: platform
          in: path
          required: true
          description: Platform to read from. Only `x` is supported today.
          schema:
            type: string
            enum:
              - x
          example: x
        - name: username
          in: query
          required: false
          description: >-
            Account handle, without the @. Either `username` or `user_id` is
            required.
          schema:
            type: string
          example: elonmusk
        - name: user_id
          in: query
          required: false
          description: >-
            Platform user id. Cheaper than `username` (skips the handle lookup).
            Either `username` or `user_id` is required.
          schema:
            type: string
          example: '44196397'
      responses:
        '200':
          description: The normalized profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NormalizedProfile'
              example:
                id: '44196397'
                username: elonmusk
                name: Elon Musk
                verified: true
                metrics:
                  followers: 1250
                  following: 180
                  posts: 3400
                  listed: 12
        '400':
          description: >-
            Unsupported platform, missing target (`username`/`user_id`), or an
            unparseable `since`
        '404':
          description: Account or post not found
        '429':
          description: The read data provider rate-limited this server; retry later
        '503':
          description: Reads are not configured on this server (no read provider key)
components:
  schemas:
    NormalizedProfile:
      type: object
      properties:
        id:
          type: string
          description: Platform user id
          example: '44196397'
        username:
          type: string
          example: elonmusk
        name:
          type: string
          example: Elon Musk
        description:
          type: string
          description: Account bio
        created_at:
          type: string
          description: When the account was created
        verified:
          type: boolean
        protected:
          type: boolean
        location:
          type: string
        url:
          type: string
          description: Expanded profile URL (not the t.co shortlink)
        metrics:
          $ref: '#/components/schemas/ProfileMetrics'
    ProfileMetrics:
      type: object
      properties:
        followers:
          type: integer
          example: 1250
        following:
          type: integer
          example: 180
        posts:
          type: integer
          example: 3400
        listed:
          type: integer
          example: 12
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Groniz API key

````