Sherlockeye API
  1. Balance
  • Welcome to Sherlockeye API
  • Authentication
  • Balance
    • Get token balance for the authenticated user
      GET
  • Searches
    • Create a new OSINT search
      POST
    • Get search details and results
      GET
    • Delete a search
      DELETE
  • Blockchain
    • Register a search on the blockchain
      POST
  • Summary
    • Get (or generate) an AI summary for a search
      GET
  • Schemas
    • ErrorResponse
    • BalanceResponse
    • CreateSearchRequest
    • CreateSearchResponse
    • GetSearchResponse
    • DeleteSearchResponse
    • BlockchainResponse
    • SummaryResponse
    • SearchResult
    • BlockchainData
  1. Balance

Get token balance for the authenticated user

GET
https://api.sherlockeye.io/v1/balance
Balance
Last modified:2026-01-28 20:51:30
Returns the current token balance associated with the authenticated user.
This endpoint is read‑only and does not consume tokens.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sherlockeye.io/v1/balance' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Balance successfully retrieved.
Body

Example
{
    "success": true,
    "data": {
        "tokens": 1200
    }
}
đźź 401
đź”´500
Modified at 2026-01-28 20:51:30
Previous
Authentication
Next
Create a new OSINT search
Built with