> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get top-spending fans > Returns a paginated list of the top-spending fans for the authenticated creator with their spending totals and message counts. **Required scopes** * `read:insights` — Access analytics, metrics, and insights data for performance tracking. * `read:fan` — Access fan-related data and information within the platform. ## OpenAPI ````yaml /openapi.json get /insights/top-spenders openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /insights/top-spenders: get: summary: Get top-spending fans description: >- Returns a paginated list of the top-spending fans for the authenticated creator with their spending totals and message counts. operationId: getTopSpenders parameters: - $ref: '#/components/parameters/ApiVersionHeader' - schema: type: string format: date-time description: >- Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z). required: false description: >- Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z). name: startDate in: query - schema: type: string format: date-time description: >- End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included. required: false description: >- End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included. name: endDate in: query - schema: type: number minimum: 1 default: 1 description: Page number to retrieve (starts from 1) required: false description: Page number to retrieve (starts from 1) name: page in: query - schema: type: number minimum: 1 maximum: 50 default: 15 description: 'Number of items to return per page (1-50, default: 15)' required: false description: 'Number of items to return per page (1-50, default: 15)' name: size in: query responses: '200': description: Top spending fans with pagination content: application/json: schema: type: object properties: data: type: array items: type: object properties: gross: type: number description: Total amount this fan paid, in USD cents net: type: number description: >- Creator's total cut from this fan after Fanvue fees, in USD cents messages: type: number description: Number of messages exchanged with this fan user: type: object properties: uuid: type: string format: uuid handle: type: string displayName: type: string nickname: type: - string - 'null' isTopSpender: type: boolean avatarUrl: type: - string - 'null' registeredAt: type: string format: date-time required: - uuid - handle - displayName - nickname - isTopSpender - avatarUrl - registeredAt description: Fan's user information required: - gross - net - messages - user description: >- Array of top spending fans with their spending totals and message counts pagination: type: object properties: page: type: number description: Current page number size: type: number description: Number of records returned in this response hasMore: type: boolean description: >- Whether there are more items available on subsequent pages required: - page - size - hasMore description: Pagination information required: - data - pagination example: data: - gross: 15000 net: 12750 messages: 342 user: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 handle: sarah-jones nickname: SarahK displayName: Sarah Jones isTopSpender: true avatarUrl: https://media.fanvue.com/avatars/example-avatar.jpg registeredAt: '2024-01-10T12:00:00.000Z' - gross: 8500 net: 7225 messages: 189 user: uuid: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 handle: mike-smith nickname: null displayName: Mike Smithly isTopSpender: false avatarUrl: https://media.fanvue.com/avatars/example-avatar.jpg registeredAt: '2024-01-10T12:00:00.000Z' pagination: page: 1 size: 2 hasMore: true '400': description: >- Bad Request - API version not supported OR validation failed (dates, sources, cursor, pagination) content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - read:insights - read:fan components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ValidationError: type: object properties: errors: type: array items: type: string required: - errors description: Request validation failed responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- OAuth 2.0 access token, presented as a JWT bearer token in the `Authorization` header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````