> ## 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.

# Fundamentals

> Basic concepts and structure of the CreatorDB API

CreatorDB Headless API Service provides access to collected creator data and functionality. It allows you to build custom features, such as retrieving important creator data and metrics, tracking creators' performance on different social media platforms, and discovering brands they work with. Supported social media platforms include YouTube, Instagram, TikTok, Facebook, and Threads.

To use the CreatorDB API, you need a CreatorDB account and API key. For details, see [Quickstart](https://docs.creatordb.app/api-v2/quickstart). Your data-gathering capabilities depend on the number of API credits you have.

<Warning>
  CreatorDB does not provide a mock server or sandbox environment for testing our API. All API calls are made to the production environment and use API credits. Please see [API Credit Usage](https://docs.creatordb.app/api-v2/authentication) for details about the number of API credits used per call.
</Warning>

## API versions

The CreatorDB API is currently on version 2.0.

The first version of the CreatorDB API is no longer available.

## API structure

<img src="https://mintlify.s3.us-west-1.amazonaws.com/creatordb-589c46f5/assets/images/Group%203.png" alt="Group 3.png" />

The API Uniform Resource Locator (URL) is a unique address directed towards the API resource. The URL is required for making HTTP requests and interacting with the API to obtain or send data. The API URL components and descriptions are as follows:

| Components | Description                                                                                                                     |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Protocol   | Indicates the required protocol the browser must follow to obtain the URL resource.                                             |
| Host       | Also known as the domain name, directs to the server being requested. Instead of a domain name, this can also be an IP address. |
| Version    | Indicates the current API version.                                                                                              |
| Resource   | The path to the API resource on the server.                                                                                     |
| Parameter  | The information the web server requires in an API request to access the resource.                                               |

The CreatorDB API follows REST API conventions.

* *Resources* are nouns like `apiStatus` or `youtubeBasic`.
* *Subresources* are a classification or item of another resource.
* *Actions* are represented by HTTP request methods.
* *Responses* follow the generic JSON content type.

CreatorDB follows industry best practices [OpenAPI Specification](https://swagger.io/specification/v2/) to describe each endpoint.

The root URL of the CreatorDB API is `https://dev.creatordb.app/v{version number}/`.