API Credentials
|
Usage API Playground
Test the Usage API with real requests and see complete HTTP request/response details for your monthly credits and breakdowns.
Try the API
Request Parameters
All parameters are optional. Defaults to the current month and year if omitted.
Quick Examples
Click any example to populate the form:
Response
Send a request to see the complete HTTP request/response details here...
Example Requests
Here are some example requests you can try:
Current Month Usage
Fetch usage without parameters
GET: /usage
Specific Month/Year
Fetch usage for December 2024
GET: /usage?month=12&year=2024
Response Format
The API returns a JSON response with the following structure:
{
"success": true,
"data": {
"month": 12,
"year": 2024,
"period": "2024-12",
"credits_used": {
"total": 68,
"search": 45,
"enrichment": 23
},
"requests_count": {
"total": 25,
"search": 15,
"enrichment": 10
},
"limits": {
"monthly_allocation": 10000,
"available_credits": 9932,
"is_unlimited": false
},
"breakdown": {
"search_results_returned": 45,
"enrichments_performed": 23,
"total_credits_consumed": 68
}
},
"timestamp": "2025-09-05T21:45:25Z"
}
Need Help?
Our support team is here to help you integrate and use our APIs effectively.
Email: support@nyne.com
Sales: sales@nyne.ai