Get API Usage

GET

usage

cURL

curl -X GET "https://apiv3.creatordb.app/usage" \
  -H "api-key: <YOUR_API-KEY_HERE>"

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://apiv3.creatordb.app/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiv3.creatordb.app/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://apiv3.creatordb.app/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apiv3.creatordb.app/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "records": [
      {
        "date": "20260120",
        "requestCount": 47,
        "totalQuotaUsed": 47,
        "totalQuotaAdded": 12,
        "endpoints": {
          "searchInstagram": {
            "count": 12,
            "quotaUsed": 12,
            "quotaAdded": 0
          },
          "getInstagramProfile": {
            "count": 8,
            "quotaUsed": 8,
            "quotaAdded": 0
          },
          "getYoutubeProfile": {
            "count": 15,
            "quotaUsed": 22,
            "quotaAdded": 0,
            "fractional": {
              "count": 9,
              "quotaUsed": 4
            }
          },
          "custom": {
            "count": 3,
            "quotaUsed": 5,
            "quotaAdded": 12
          }
        },
        "platforms": {
          "instagram": 20,
          "tiktok": 10,
          "youtube": 17
        },
        "quotaByPlatform": {
          "instagram": 20,
          "tiktok": 10,
          "youtube": 17
        }
      }
    ],
    "count": 7,
    "key": {
      "creditLimit": 5000,
      "creditsRemaining": 4975,
      "active": true
    }
  },
  "creditsUsed": 1,
  "creditsAvailable": -1,
  "planCreditsAvailable": 900,
  "purchasedCreditsAvailable": 75,
  "traceId": "f8e4a3b2c1d0e9f8a7b6c5d4e3f2a1b0",
  "timestamp": 1750732453635,
  "errorCode": "",
  "errorDescription": "",
  "success": true,
  "keyCreditsAvailable": 4975
}

Authorizations

api-key

string

header

required

The valid CreatorDB API key for authentication.

Query Parameters

start

string

Start date, represented as a Unix timestamp in milliseconds. Defaults to 7 days ago.

Example:

"1737312000000"

end

string

End date, represented as a Unix timestamp in milliseconds. Defaults to current time.

Example:

"1737398400000"

Response

API credit usage results returned successfully.

data

object

required

API usage data containing records and count.

Show child attributes

creditsUsed

number

required

Total number of API credits consumed across all requests in this session.

Example:

1

creditsAvailable

number

required

Number of API credits remaining. Calculated as: planCreditsAvailable + purchasedCreditsAvailable.

Example:

-1

planCreditsAvailable

number

required

Remaining plan credits after this request, in credits.

Example:

900

purchasedCreditsAvailable

number

required

Remaining purchased credits after this request, in credits.

Example:

75

traceId

string

required

Unique trace ID for each request.

Example:

"f8e4a3b2c1d0e9f8a7b6c5d4e3f2a1b0"

timestamp

integer

required

Time the response was generated, represented as a Unix timestamp in milliseconds.

Example:

1750732453635

errorCode

string

required

Error code returned if the request fails. Empty if the request is successful.

Example:

""

errorDescription

string

required

Description of the error. Empty if the request is successful.

Example:

""

success

boolean

required

true if the request is successful.

Example:

true

keyCreditsAvailable

number

Remaining credits this API key can spend after this request, before reaching its spend limit. Present only when the key has a spend limit.

Example:

4975

Last modified on August 18, 2026

⌘I

cURL

curl -X GET "https://apiv3.creatordb.app/usage" \
  -H "api-key: <YOUR_API-KEY_HERE>"

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://apiv3.creatordb.app/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiv3.creatordb.app/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://apiv3.creatordb.app/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apiv3.creatordb.app/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "records": [
      {
        "date": "20260120",
        "requestCount": 47,
        "totalQuotaUsed": 47,
        "totalQuotaAdded": 12,
        "endpoints": {
          "searchInstagram": {
            "count": 12,
            "quotaUsed": 12,
            "quotaAdded": 0
          },
          "getInstagramProfile": {
            "count": 8,
            "quotaUsed": 8,
            "quotaAdded": 0
          },
          "getYoutubeProfile": {
            "count": 15,
            "quotaUsed": 22,
            "quotaAdded": 0,
            "fractional": {
              "count": 9,
              "quotaUsed": 4
            }
          },
          "custom": {
            "count": 3,
            "quotaUsed": 5,
            "quotaAdded": 12
          }
        },
        "platforms": {
          "instagram": 20,
          "tiktok": 10,
          "youtube": 17
        },
        "quotaByPlatform": {
          "instagram": 20,
          "tiktok": 10,
          "youtube": 17
        }
      }
    ],
    "count": 7,
    "key": {
      "creditLimit": 5000,
      "creditsRemaining": 4975,
      "active": true
    }
  },
  "creditsUsed": 1,
  "creditsAvailable": -1,
  "planCreditsAvailable": 900,
  "purchasedCreditsAvailable": 75,
  "traceId": "f8e4a3b2c1d0e9f8a7b6c5d4e3f2a1b0",
  "timestamp": 1750732453635,
  "errorCode": "",
  "errorDescription": "",
  "success": true,
  "keyCreditsAvailable": 4975
}

Getting Started

User Guides

API Endpoints

Filter Value References

Troubleshooting and FAQs

Authorizations

Query Parameters

Response