Usage

Get your current credit balance and a breakdown of credits spent this month, grouped by operation.

GET/api/v1/usage
bash
curl https://neuroapi.me/api/v1/usage \
  -H "Authorization: Bearer $NEUROAPI_KEY"

Example response

json
{
  "success": true,
  "data": {
    "balance": 842,
    "period_start": "2026-05-01T00:00:00.000Z",
    "period_end": "2026-05-22T15:10:00.000Z",
    "total_credits_charged": 158,
    "by_operation": {
      "scrape": { "count": 120, "credits": 120 },
      "search": { "count": 14, "credits": 28 },
      "extract": { "count": 5, "credits": 10 }
    }
  },
  "creditsCharged": 0
}

This endpoint is free. Requires the read scope.