For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve Credits Status API

Retrieve the user's current balance of credits, including balance details, currency, expiration date, and account status.

Endpoint: GET https://irbis.espysys.com/api/request-monitor/credit-stat

Purpose: Retrieve the API usage details for all requests.

Parameters:

  • key (string, required, query): Your unique API key.

Usage Example:

curlCopy codecurl -X 'GET' \
  'https://irbis.espysys.com/api/request-monitor/credit-stat?key=YOUR_API_KEY' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json'

Expected Response

A successful response provides a JSON object with the following fields:

  • balance: Remaining balance in decimal format.

  • currency: Currency symbol for the balance.

  • credits: Available credit count.

  • expiratioDate: Expiration date of the credits (ISO 8601 format).

  • status: Current account status (e.g., "Active").

Example Response

jsonCopy code{
  "balance": 316.8,
  "currency": "",
  "credits": 3168,
  "expiratioDate": "2024-10-20T14:05:47.000Z",
  "status": "Active"
}

This endpoint provides an overview of the user’s credit status, supporting effective balance tracking and account management.

Last updated