Credits

Credit management and retrieval

Get user credits

get
/users/{address}/credits

Returns all credits for a specific user with their current status. Returns 401 if the user is flagged for multi-accounting or captcha violations.

Path parameters
addressstringRequired

User's Ethereum address

Example: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbPattern: ^0x[a-fA-F0-9]{40}$
Query parameters
statusstring · enumOptional

Filter credits by status. If not provided, returns AVAILABLE and PARTIALLY_USED credits

Example: AVAILABLEPossible values:
Responses
chevron-right
200

User credits retrieved successfully

application/json
get
/users/{address}/credits

Get credits stream (SSE)

get
/users/{address}/credits/stream

Server-sent events endpoint for real-time credit balance updates. Provides a persistent connection that streams credit updates as they occur.

Path parameters
addressstringRequired

User's Ethereum address

Example: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbPattern: ^0x[a-fA-F0-9]{40}$
Responses
chevron-right
200

Server-sent events stream

text/event-stream
Responsestring

SSE stream with credit updates in event stream format

get
/users/{address}/credits/stream

Last updated