Get public aggregate creator reward and payout state. - Aura

Error

A valid request URL is required to generate request examples

{
  "grossAccruedBaseUnits": "<string>",
  "grossConfirmedBaseUnits": "<string>",
  "claimableBaseUnits": "<string>",
  "payoutPendingBaseUnits": "<string>",
  "claimedBaseUnits": "<string>",
  "abandonedBaseUnits": "<string>",
  "roundingResidueBaseUnits": "<string>",
  "creatorRecipientConfirmedBaseUnits": "<string>",
  "backerRecipientConfirmedBaseUnits": "<string>",
  "recipientCount": "<string>",
  "creatorRecipientCount": "<string>",
  "backerRecipientCount": "<string>",
  "invalidPayoutAmountCount": "<string>",
  "lastConfirmedAt": "2023-11-07T05:31:56Z",
  "lastPayoutUpdatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

GET

/

v1

/

creators

/

{address}

/

earnings

Error

A valid request URL is required to generate request examples

{
  "grossAccruedBaseUnits": "<string>",
  "grossConfirmedBaseUnits": "<string>",
  "claimableBaseUnits": "<string>",
  "payoutPendingBaseUnits": "<string>",
  "claimedBaseUnits": "<string>",
  "abandonedBaseUnits": "<string>",
  "roundingResidueBaseUnits": "<string>",
  "creatorRecipientConfirmedBaseUnits": "<string>",
  "backerRecipientConfirmedBaseUnits": "<string>",
  "recipientCount": "<string>",
  "creatorRecipientCount": "<string>",
  "backerRecipientCount": "<string>",
  "invalidPayoutAmountCount": "<string>",
  "lastConfirmedAt": "2023-11-07T05:31:56Z",
  "lastPayoutUpdatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

aura_session

string

cookie

required

HttpOnly session cookie set by POST /v1/auth/session. Mutating requests must also send the CSRF token (returned by that call) in the x-csrf-token header.

Path Parameters

address

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

Response

Default Response

grossAccruedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

grossConfirmedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

claimableBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

payoutPendingBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

claimedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

abandonedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

roundingResidueBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

creatorRecipientConfirmedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

backerRecipientConfirmedBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

recipientCount

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

creatorRecipientCount

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

backerRecipientCount

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

invalidPayoutAmountCount

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

lastConfirmedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

lastPayoutUpdatedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Last modified on August 22, 2026