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

# Top streams

> Get top performing streams

**Required scope:** `analytics:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/analytics/streams/top
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/analytics/streams/top:
    get:
      tags:
        - Analytics
      summary: Top streams
      description: |-
        Get top performing streams

        **Required scope:** `analytics:read`
      operationId: access.analytics.streams.listTop
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
        - schema:
            type: string
            enum:
              - purchases
              - duration
              - tips
              - views
              - likes
              - comments
            description: Metric to rank by
          required: false
          description: Metric to rank by
          name: by
          in: query
        - schema:
            anyOf:
              - type: string
                nullable: true
              - type: string
                description: Date in ISO 8601 format
              - nullable: true
            description: >-
              Start date in ISO 8601 format. Keep this date when requesting
              older results.
          required: false
          description: >-
            Start date in ISO 8601 format. Keep this date when requesting older
            results.
          name: startDate
          in: query
        - schema:
            anyOf:
              - type: string
                nullable: true
              - type: string
                description: Date in ISO 8601 format
              - nullable: true
            description: >-
              End date in ISO 8601 format. Use an earlier date to request older
              results.
          required: false
          description: >-
            End date in ISO 8601 format. Use an earlier date to request older
            results.
          name: endDate
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        canDelete:
                          type: boolean
                        canEdit:
                          type: boolean
                        mediaCount:
                          type: number
                        media:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              type:
                                type: string
                                enum:
                                  - photo
                                  - video
                                  - gif
                                  - audio
                              convertedToVideo:
                                type: boolean
                              canView:
                                type: boolean
                              hasError:
                                type: boolean
                              createdAt:
                                type: string
                              isReady:
                                type: boolean
                              duration:
                                type: number
                              releaseForms:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                    partnerSource:
                                      type: string
                                    type:
                                      type: string
                                    user:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                        username:
                                          type: string
                                        displayName:
                                          type: string
                                          nullable: true
                                        isVerified:
                                          type: boolean
                                        avatar:
                                          type: string
                                          nullable: true
                                        avatarThumbs:
                                          type: object
                                          nullable: true
                                          additionalProperties:
                                            type: string
                                        ivStatus:
                                          type: string
                                        isFromGuest:
                                          type: boolean
                                      required:
                                        - id
                                        - name
                                        - username
                                  required:
                                    - id
                                    - name
                                    - partnerSource
                                    - type
                              hasCustomPreview:
                                type: boolean
                              videoSources:
                                type: object
                                properties:
                                  '240':
                                    type: string
                                    nullable: true
                                  '720':
                                    type: string
                                    nullable: true
                              files:
                                type: object
                                properties:
                                  full:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                      sources:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            url:
                                              type: string
                                            width:
                                              type: number
                                            height:
                                              type: number
                                            type:
                                              type: string
                                          required:
                                            - url
                                    required:
                                      - url
                                      - sources
                                  thumb:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                  preview:
                                    anyOf:
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                          options:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                url:
                                                  type: string
                                                width:
                                                  type: number
                                                height:
                                                  type: number
                                                type:
                                                  type: string
                                              required:
                                                - url
                                        required:
                                          - url
                                          - options
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                        required:
                                          - url
                                      - nullable: true
                                  squarePreview:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                required:
                                  - full
                            required:
                              - id
                              - type
                              - convertedToVideo
                              - canView
                              - hasError
                              - createdAt
                              - isReady
                        canViewMedia:
                          type: boolean
                        author:
                          type: object
                          properties:
                            id:
                              type: number
                            username:
                              type: string
                              nullable: true
                            name:
                              type: string
                              nullable: true
                            displayName:
                              type: string
                              nullable: true
                            isVerified:
                              type: boolean
                              nullable: true
                            avatar:
                              type: string
                              nullable: true
                            avatarThumbs:
                              type: object
                              nullable: true
                              additionalProperties:
                                type: string
                          required:
                            - id
                        responseType:
                          type: string
                        postedAt:
                          type: string
                        postedAtPrecise:
                          type: string
                        isMarkdownDisabled:
                          type: boolean
                        isOpened:
                          type: boolean
                        canToggleFavorite:
                          type: boolean
                        tipsAmount:
                          type: string
                        text:
                          type: string
                        isFavorite:
                          type: boolean
                        canComment:
                          type: boolean
                        favoritesCount:
                          type: number
                        isMediaReady:
                          type: boolean
                        rawText:
                          type: string
                        stats:
                          type: object
                          properties:
                            isAvailable:
                              type: boolean
                            hasStats:
                              type: boolean
                            hasVideo:
                              type: boolean
                            lookCount:
                              type: number
                            uniqueLookCount:
                              type: number
                            uniqueLookChart:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - date
                                  - count
                            lookChart:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - date
                                  - count
                            lookDuration:
                              type: number
                            lookDurationAverage:
                              type: number
                            likeCount:
                              type: number
                            likeChart:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - date
                                  - count
                            commentCount:
                              type: number
                            commentChart:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - date
                                  - count
                            tipCount:
                              type: number
                            tipChart:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - date
                                  - count
                            tipSum:
                              type: number
                            purchasedCount:
                              type: number
                            purchasedSumm:
                              type: number
                          required:
                            - isAvailable
                            - hasStats
                            - lookCount
                            - uniqueLookCount
                            - uniqueLookChart
                            - lookChart
                            - lookDuration
                            - lookDurationAverage
                            - likeCount
                            - likeChart
                            - commentCount
                            - commentChart
                            - tipCount
                            - tipChart
                            - tipSum
                            - purchasedCount
                            - purchasedSumm
                      required:
                        - id
                        - canDelete
                        - canEdit
                        - mediaCount
                        - media
                        - canViewMedia
                        - responseType
                        - postedAt
                        - postedAtPrecise
                        - isMarkdownDisabled
                        - isOpened
                        - canToggleFavorite
                        - tipsAmount
                        - text
                        - isFavorite
                        - canComment
                        - favoritesCount
                        - isMediaReady
                        - rawText
                required:
                  - items
                additionalProperties: false
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.