Atmee.aiDocs
APIAPI referenceAccount

Get earnings

GET
/v1/account/earnings

Returns what the account's monetized avatars earned, what was paid out, and the wallet balance between them, in microcredits (100 microcredits = 1 credit). This is not the balance sessions spend (GET /v1/account/balance); one avatar's earnings are in GET /v1/avatars/{avatarId}/monetization.

Readable by an account-wide key with avatars:read or a signed-in user of the account; an avatar-scoped key gets 403 avatar_not_allowed.

Authorization

headerX-Api-Key<token>

Your secret API key (sk_atmee_...; older keys start sk_live_), sent as X-Api-Key. Keep it on your server and never send it to a browser.

Response Body

The wallet.

application/json
  1. response
walletBalanceMicrocredits*integer

Earned and not yet paid out.

Formatint64
totalEarningsMicrocredits*integer
Formatint64
totalPayoutsMicrocredits*integer
Formatint64
Example Request
curl -X GET 'https://api.atmanity.us/v1/account/earnings'
Example Response
{  "walletBalanceMicrocredits": 0,  "totalEarningsMicrocredits": 0,  "totalPayoutsMicrocredits": 0}