> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onlyfansapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Credit Usage (/api-reference/usage/get-credit-usage)
Break your team's credit spend down by day, account or endpoint.
Data is computed by OnlyFansAPI from your request logs and credit ledger, and is
rolled up once a night shortly after midnight UTC. Yesterday is therefore the most
recent complete day; pass `include_today=true` to additionally get today's spend
aggregated live, bearing in mind those figures are provisional until the rollup runs.
Totals reconcile with your credit ledger: spend that is not attributable to a single
API call (webhook deliveries, data exports, media processing) is reported with a
`null` endpoint and a `null` account.
If the API key is restricted to a subset of your accounts, only those accounts'
usage is included. Spend that carries no account attribution is still reported,
since it belongs to the team rather than to any one account.
This endpoint is **free** - calling it costs 0 credits. It is rate limited to 30
requests per minute, independently of your plan's usual rate limit.
## OpenAPI
````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/usage/credits
openapi: 3.0.3
info:
title: OnlyFans API
description: ""
version: 1.0.0
servers:
- url: https://app.onlyfansapi.com
security:
- default: []
tags:
- name: API Keys
description: ""
- name: Account
description: Endpoints for your linked accounts
- name: Analytics - Financial
description: APIs for retrieving financial analytics data
- name: Analytics - Summary
description: APIs for retrieving summary analytics data
- name: Banking
description: Operations related to user banking details, payout methods, legal
and tax information, and account country settings.
- name: Banned Words
description: Reference list of OnlyFans banned words used by the
`blockBannedWords` screening parameter
- name: Blocked / Restricted Users
description: APIs for listing the users an account has blocked or restricted
- name: Chargebacks
description: ""
- name: Chat Messages
description: ""
- name: Chats
description: ""
- name: Client Sessions
description: ""
- name: Connect OnlyFans Account
description: ""
- name: Data Exports
description: APIs for managing data exports
- name: Engagement / Messages
description: ""
- name: Fans
description: APIs for managing OnlyFans fans (subscribers)
- name: Fans - AI Summary
description: APIs for generating and retrieving AI-powered fan profile summaries
- name: Following
description: APIs for managing OnlyFans followings (people you're subscribed to)
- name: Free Trial Links
description: APIs for managing Free Trial Links
- name: Giphy
description: ""
- name: Link Tags
description: APIs for managing tags on free trial links, tracking links, and Smart Links
- name: Mass Messaging
description: ""
- name: Media
description: ""
- name: Media Vault
description: ""
- name: Media Vault Lists
description: ""
- name: Notifications
description: Endpoints for managingr account notifications
- name: Payouts
description: ""
- name: Post Comments
description: ""
- name: Post Labels
description: APIs for managing your post labels
- name: Posts
description: APIs for managing OnlyFans posts
- name: Promotions
description: ""
- name: Public Profiles
description: ""
- name: Queue
description: ""
- name: Release Forms
description: APIs for managing OnlyFans release forms
- name: Saved For Later (Messages)
description: ""
- name: Saved For Later (Posts)
description: ""
- name: Settings
description: ""
- name: Shared Free Trial Links
description: APIs for Free Trial Links that other OF creators have shared with
this account. Revenue, cost, and spender data are not available for shared
links.
- name: Shared Tracking Links
description: APIs for Tracking Links (campaigns) that other OF creators have
shared with this account. Revenue, cost, and spender data are not
available for shared campaigns.
- name: Smart Link Postbacks
description: APIs for managing Smart Link postback destinations
- name: Smart Links
description: APIs for managing Smart Links (Free Trial Links and Tracking Links
with pooled inventory)
- name: Statistics
description: ""
- name: Stored Free Trial Links
description: Instant APIs for retrieving stored free trial links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stored Shared Free Trial Links
description: Instant APIs for retrieving stored shared Free Trial Links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stored Shared Tracking Links
description: Instant APIs for retrieving stored shared Tracking Links
(campaigns) from the OnlyFansAPI Cache (free, no credits used)
- name: Stored Tracking Links
description: Instant APIs for retrieving stored tracking links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stories
description: APIs for managing OnlyFans stories
- name: Story Highlights
description: APIs for managing OnlyFans story highlights
- name: Subscription Bundles
description: ""
- name: Tracking Links
description: APIs for managing tracking links
- name: Transactions
description: APIs for managing OnlyFans transactions
- name: Usage
description: Credit usage reporting for your team
- name: User List Collections
description: ""
- name: Users
description: APIs for fetching OnlyFans users
- name: Webhooks
description: ""
paths:
/api/usage/credits:
get:
summary: Get Credit Usage
operationId: getCreditUsage
description: >-
Break your team's credit spend down by day, account or endpoint.
Data is computed by OnlyFansAPI from your request logs and credit
ledger, and is
rolled up once a night shortly after midnight UTC. Yesterday is
therefore the most
recent complete day; pass `include_today=true` to additionally get
today's spend
aggregated live, bearing in mind those figures are provisional until the
rollup runs.
Totals reconcile with your credit ledger: spend that is not attributable
to a single
API call (webhook deliveries, data exports, media processing) is
reported with a
`null` endpoint and a `null` account.
If the API key is restricted to a subset of your accounts, only those
accounts'
usage is included. Spend that carries no account attribution is still
reported,
since it belongs to the team rather than to any one account.
This endpoint is **free** - calling it costs 0 credits. It is rate
limited to 30
requests per minute, independently of your plan's usual rate limit.
parameters:
- in: query
name: from
description: First day to include (`Y-m-d`, inclusive). Defaults to 29 days
before `to`. Must be a valid date in the format Y-m-d.
example: 2026-07-09
required: false
schema:
type: string
description: First day to include (`Y-m-d`, inclusive). Defaults to 29 days
before `to`. Must be a valid date in the format
Y-m-d.
example: 2026-07-09
- in: query
name: to
description: Last day to include (`Y-m-d`, inclusive). Defaults to yesterday, or
today when `include_today` is set. May not be in the future, and the
range may not exceed 366 days. Must be a valid date in the format
Y-m-d. Must be a date before or equal to
today.
example: 2026-08-06
required: false
schema:
type: string
description: Last day to include (`Y-m-d`, inclusive). Defaults to yesterday, or
today when `include_today` is set. May not be in the future, and
the range may not exceed 366 days. Must be a valid date in the
format Y-m-d. Must be a date before or equal to
today.
example: 2026-08-06
- in: query
name: group_by
description: The dimension to group usage by. Default `day`.
example: endpoint
required: false
schema:
type: string
description: The dimension to group usage by. Default `day`.
example: endpoint
enum:
- day
- account
- endpoint
- in: query
name: account_id
description: Only include usage attributable to this account. Usage that is not
tied to a single account (webhooks, data exports, media processing)
is excluded when this filter is set. Must not be greater than 255
characters.
example: acct_abc123
required: false
schema:
type: string
description: Only include usage attributable to this account. Usage that is not
tied to a single account (webhooks, data exports, media
processing) is excluded when this filter is set. Must not be
greater than 255 characters.
example: acct_abc123
- in: query
name: include_today
description: Include today, aggregated live from request logs instead of from
the nightly rollup. Today's figures are provisional and may change
until the rollup runs. Default `false`.
example: true
required: false
schema:
type: boolean
description: Include today, aggregated live from request logs instead of from
the nightly rollup. Today's figures are provisional and may change
until the rollup runs. Default `false`.
example: true
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
example:
data:
from: 2026-07-09
to: 2026-08-06
group_by: endpoint
includes_today: false
totals:
credits: 18420
requests: 17650
results:
- endpoint: api/{account}/chats/{chat_id}/messages
credit_type: api_request
credits: 9200
requests: 9200
- endpoint: api/{account}/chats
credit_type: api_request
credits: 4100
requests: 4100
- endpoint: api/{account}/media/upload
credit_type: media_upload
credits: 2600
requests: 520
- endpoint: null
credit_type: webhook
credits: 1800
requests: 0
- endpoint: api/profiles/{username}
credit_type: profile_search
credits: 620
requests: 620
- endpoint: null
credit_type: data_export
credits: 100
requests: 0
- endpoint: api/{account}/me
credit_type: api_request
credits: 0
requests: 3210
_meta:
_credits:
used: 0
balance: 9500
note: Always
_cache:
is_cached: false
note: Cache disabled for this endpoint
_rate_limits:
limit_minute: 60
limit_day: null
remaining_minute: 56
remaining_day: null
notice: ""
properties:
data:
type: object
properties:
from:
type: string
example: 2026-07-09
to:
type: string
example: 2026-08-06
group_by:
type: string
example: endpoint
includes_today:
type: boolean
example: false
totals:
type: object
properties:
credits:
type: integer
example: 18420
requests:
type: integer
example: 17650
results:
type: array
example:
- endpoint: api/{account}/chats/{chat_id}/messages
credit_type: api_request
credits: 9200
requests: 9200
- endpoint: api/{account}/chats
credit_type: api_request
credits: 4100
requests: 4100
- endpoint: api/{account}/media/upload
credit_type: media_upload
credits: 2600
requests: 520
- endpoint: null
credit_type: webhook
credits: 1800
requests: 0
- endpoint: api/profiles/{username}
credit_type: profile_search
credits: 620
requests: 620
- endpoint: null
credit_type: data_export
credits: 100
requests: 0
- endpoint: api/{account}/me
credit_type: api_request
credits: 0
requests: 3210
items:
type: object
properties:
endpoint:
type: string
example: api/{account}/chats/{chat_id}/messages
credit_type:
type: string
example: api_request
credits:
type: integer
example: 9200
requests:
type: integer
example: 9200
_meta:
type: object
properties:
_credits:
type: object
properties:
used:
type: integer
example: 0
balance:
type: integer
example: 9500
note:
type: string
example: Always
_cache:
type: object
properties:
is_cached:
type: boolean
example: false
note:
type: string
example: Cache disabled for this endpoint
_rate_limits:
type: object
properties:
limit_minute:
type: integer
example: 60
limit_day:
type: string
example: null
nullable: true
remaining_minute:
type: integer
example: 56
remaining_day:
type: string
example: null
nullable: true
notice:
type: string
example: ""
tags:
- Usage
components:
securitySchemes:
default:
type: http
scheme: bearer
description: Get your API Key from OnlyFansAPI Console -
https://app.onlyfansapi.com/api-keys
````