> ## Documentation Index > Fetch the complete documentation index at: https://docs.creatordb.app/llms.txt > Use this file to discover all available pages before exploring further. # Get API credit status > Get your API credit usage status. ## OpenAPI ````yaml /api-v2/api-v2.yaml get /apiStatus openapi: 3.1.0 info: version: '2' title: CreatorDB Headless APIService description: >- Generated from swaggerComponentIndex.json by core-types-json-schema (https://github.com/grantila/core-types-json-schema). Use OpenAPI 3.1.0 version with direct JSON Schema support termsOfService: https://www.creatordb.app contact: name: CreatorDB url: https://www.creatordb.app email: support@creatordb.app license: url: http://www.apache.org/licenses/LICENSE-2.0.html name: Apache 2.0 x-id: indexForSwagger.yaml servers: - url: https://dev.creatordb.app/v2 description: CreatorDB API Endpoint - prod version security: [] tags: - name: General Operations description: >- General-purpose endpoints such as API status, content retrieval, and cross-platform operations - name: YouTube description: >- YouTube creator data endpoints including basic metrics, historical data, and detailed analytics - name: Instagram description: >- Instagram creator data endpoints with metrics and advanced search capabilities - name: TikTok description: >- TikTok creator data endpoints with metrics and advanced search functionality - name: Threads description: Threads creator data endpoints with basic metrics and historical data - name: Facebook description: Facebook creator data endpoints with metrics and search capabilities - name: Topic description: Topic-based analysis and reporting endpoints for content categorization - name: Brand description: Brand analysis endpoints including sponsor search and brand reports - name: Niches description: Niche-related endpoints for content category analysis and related searches paths: /apiStatus: get: tags: - General Operations summary: Get API credit status description: Get your API credit usage status. operationId: getAPIStatus parameters: - name: apiId in: header description: '' required: true schema: type: string examples: - LE6DPZQkR3TQShxofXoD2j8qCBu1-f0jti665m1t50dwDD12W responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/APIStatus' quotaUsed: type: number description: API credits that were used to make this call. quotaUsedTotal: type: number description: Total API credits used since the last billing cycle. remainingPlanCredit: type: number description: >- The number of remaining free API credits that come with your subscription plan. These API credits are renewed every billing cycle. remainingPrepurchasedCredit: type: number description: >- The number of remaining extra purchased API credits. These API credits do not expire until used. timestamp: type: number description: >- Unix timestamp of the call request that the server received. error: type: string description: Errors that occurred during the API call. success: type: boolean description: It is TRUE when the call is successful. examples: default: value: data: apiId: YOUR_API_ID userId: YOUR_USER_ID apiKey: YOUR_API_KEY apiQuotaUsedHistory: 2020-12: 3142 2021-3: 19 2021-4: 13 apiQuotaUsedDetailHistory: 2022-10: basicThreads: 0 historyThreads: 0 searchThreads: 0 basicFacebook: 0 historyFacebook: 0 searchFacebook: 0 basicInstagram: 0 historyInstagram: 0 searchInstagram: 0 basicTikTok: 6 historyTikTok: 2 searchTikTok: 2 basicYoutube: 9 historyYoutube: 0 detailYoutube: 1 searchYoutube: 0 topicReport: 12 topicTable: 0 apiStatus: 18 brandReport: 0 brandTable: 0 brandSponsorSearch: 0 searchBrand: 0 submitCreators: 0 contactInformation: 0 getPostByIdOrUrl: 0 getRelatedNiches: 0 emailYoutube: 2 2022-11: basicThreads: 0 historyThreads: 0 searchThreads: 0 basicFacebook: 0 historyFacebook: 0 searchFacebook: 0 basicInstagram: 0 historyInstagram: 0 searchInstagram: 2 basicTikTok: 2 historyTikTok: 0 searchTikTok: 0 basicYoutube: 0 historyYoutube: 0 detailYoutube: 1 searchYoutube: 70 topicReport: 0 topicTable: 0 apiStatus: 0 brandReport: 0 brandTable: 0 brandSponsorSearch: 0 searchBrand: 0 submitCreators: 0 contactInformation: 0 getPostByIdOrUrl: 0 getRelatedNiches: 0 emailYoutube: 0 2022-12: basicThreads: 0 historyThreads: 0 searchThreads: 0 basicFacebook: 0 historyFacebook: 0 searchFacebook: 0 basicInstagram: 1 historyInstagram: 0 searchInstagram: 11 basicTikTok: 2 historyTikTok: 1 searchTikTok: 11 basicYoutube: 0 historyYoutube: 82 detailYoutube: 1 searchYoutube: 2 topicReport: 3 topicTable: 1 apiStatus: 2 brandReport: 10 brandTable: 12 brandSponsorSearch: 0 searchBrand: 0 submitCreators: 0 contactInformation: 0 getPostByIdOrUrl: 0 getRelatedNiches: 0 emailYoutube: 0 lastRefreshTime: 1754019249970 lastRequestTime: 1755503514051 enable: true testing: true quotaUsed: 1 quotaUsedTotal: 6025 remainingPlanCredit: 993975 remainingPrepurchasedCredit: 0 timestamp: 1755503514975 error: '' success: true '403': description: Forbidden content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/APIStatus' quotaUsed: type: number description: API credits that were used to make this call. quotaUsedTotal: type: number description: Total API credits used since the last billing cycle. remainingPlanCredit: type: number description: >- The number of remaining free API credits that come with your subscription plan. These API credits are renewed every billing cycle. remainingPrepurchasedCredit: type: number description: >- The number of remaining extra purchased API credits. These API credits do not expire until used. timestamp: type: number description: >- Unix timestamp of the call request that the server received. error: type: string description: Errors that occurred during the API call. success: type: boolean description: It is TRUE when the call is successful. examples: default: value: data: null quotaUsed: 0 quotaUsedTotal: 0 remainingPlanCredit: 0 remainingPrepurchasedCredit: 0 timestamp: 1755503514102 error: APIKeyNotMatch success: false servers: - url: https://dev.creatordb.app/v2 description: CreatorDB API Endpoint - prod version x-codeSamples: - lang: bash label: cURL source: | curl --request GET \ --url https://dev.creatordb.app/v2/apiStatus \ --header 'Accept: application/json' \ --header 'apiId: LE6DPZQkR3TQShxofXoD2j8qCBu1-f0jti665m1t50dwDD12W' components: schemas: APIStatus: type: object additionalProperties: false properties: apiId: type: string description: >- A unique ID comprised of your CreatorDB user ID and API key for identifying users in the heading of every API call. You can acquire the API key from your CreatorDB user account. Each API call made uses one API credit. userId: type: string description: Unique ID of your CreatorDB account. apiKey: type: string description: A part of the API ID. apiQuotaUsedHistory: type: object description: The monthly history of API credits usage. additionalProperties: type: number apiQuotaUsedDetailHistory: type: object description: >- Shows the number of times a specific API method was called and is calculated monthly. Allows you to calculate the total API credits you've used each month. additionalProperties: $ref: '#/components/schemas/APIQuota' lastRefreshTime: type: number description: >- Unix timestamp of the last date that your CreatorDB account's API credits were refreshed. API credits are refreshed at the start of the monthly billing cycle. lastRequestTime: type: number description: Unix timestamp of the last API call made using this apiId. enable: type: boolean description: Is TRUE when the API key has access permission. testing: type: boolean description: It is TRUE when the API key is in trial mode. required: - apiId - userId - apiKey - apiQuotaUsedHistory - apiQuotaUsedDetailHistory - lastRefreshTime - lastRequestTime - enable - testing APIQuota: type: object additionalProperties: false properties: basicThreads: type: number historyThreads: type: number searchThreads: type: number basicFacebook: type: number historyFacebook: type: number searchFacebook: type: number basicInstagram: type: number historyInstagram: type: number searchInstagram: type: number basicTikTok: type: number historyTikTok: type: number searchTikTok: type: number basicYoutube: type: number historyYoutube: type: number detailYoutube: type: number searchYoutube: type: number topicReport: type: number topicTable: type: number apiStatus: type: number brandReport: type: number brandTable: type: number brandSponsorSearch: type: number searchBrand: type: number submitCreators: type: number contactInformation: type: number getPostByIdOrUrl: type: number getRelatedNiches: type: number emailYoutube: type: number required: - basicThreads - historyThreads - searchThreads - basicFacebook - historyFacebook - searchFacebook - basicInstagram - historyInstagram - searchInstagram - basicTikTok - historyTikTok - searchTikTok - basicYoutube - historyYoutube - detailYoutube - searchYoutube - topicReport - topicTable - apiStatus - brandReport - brandTable - brandSponsorSearch - searchBrand - submitCreators - contactInformation - getPostByIdOrUrl - getRelatedNiches - emailYoutube ````