Skip to main content
GET
Read the platform or end-user balance

Authorizations

Authorization
string
header
required

Tenant secret key (lcr_…). Server-side only.

Headers

X-Locus-End-User
string

Stable external user ID. Omit to read the platform pool. Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$

Response

Current balance and tenant denomination

usd
string
required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
credits
string
required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
denomination
object
required