Balance API

Balance lookup and management

GET /v1/balance

Queries your current balance (TRY for personal and project keys).

Balance Lookup

                cURL
            
curl https://api.onysoft.com/v1/balance \
  -H "Authorization: Bearer sk-ony-your-api-key"

Response Format

                JSON
            

{
  "success": true,
  "data": {
    "balance": 150.750000,
    "currency": "TRY",
    "project": {
      "id": 1,
      "name": "My Project"
    },
    "limits": {
      "rate_limit_per_minute": 60,
      "rate_limit_per_day": 10000
    }
  }
}
            

Balance Summary

GET /v1/balance/summary

Returns a detailed balance summary and spending information.

Daily Usage

GET /v1/balance/daily

Returns the daily spending report.

Currency: for personal and project keys the balance is in TRY. For Partner Project keys the balance value is in USD; for these keys the currency field of the response still says "TRY" for now, so read the amount as USD.

Balance Transactions

GET /v1/balance/transactions

Lists balance transactions (top-ups, spending, refunds) with pagination.

GET /v1/balance/transactions/{id}

Returns the details of a single balance transaction.