Skip to content

Introduction


Authentication

API Key

The Cookie API uses API keys to authenticate requests. You can get your API key from Dashboard. Ensure you keep your API key secure.

How to Use Your API Key

Include your API key in the URL Params or Request Headers of every request:

Authorizations
Authorization String Required <API_Key>

curl --location 'https://api.cookie-api.com/api/api-key' \
--header 'Authorization: API_Key'
{
"Hint": "You will get your API Key from our dashboard (https://dashboard.cookie-api.com/). For more Information please view: https://docs.cookie-api.com/faq/api-key",
"message": "Missing API key",
"success": false
}

Rate Limits

To ensure fair usage, the Cookie API imposes rate limits. Each account is allowed 80 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests response.

{
"message": "Requests limit reached. Please try again later.",
"resets_in": "55",
"success": false
}


Error Handling

The Cookie API uses standard HTTP status codes to indicate the success or failure of an API request. Here are some common status codes:

HTTP Status Code Summary
200OKThe request was successful.
400Bad RequestThe request was invalid or cannot be otherwise served.
401UnauthorizeMissing or Invalid API Key.
404Not FoundThe requested resource could not be found.
500Internal Server ErrorSomething went really wrong. (Report it in the Discord Server)
502Bad GatewayUsually happens when the server restarted or is restarting.
402Payment RequiredPremium is required to able to use this feature

For all Possible errors along with a detailed description and a way on how to resolve it, you will find on our Status Codes FAQ Page below:



Badges

Badges Summary
WIP Work in Progress, Feature is currently in the works, no exact eta when it will come.
Depracted This feature will still be hosted but no longer updated.
Offline Feature was taken offline for update or maintanace, no exact eta when it would come back online
Planned Feature is on our plan, but no exact eta will be announced
Paid / Premium Feature requires payment to be able to be used


Support

If you need further assistance, join our Discord Server to get help from our community and the Cookie API team. Our support team is active and ready to assist you with any issues you may face.