AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

List virtual balances

GET

https://api.eu-west-1.aworld.cloud/app/v1/virtualBalances

VirtualBalances

Retrieves a paginated list of virtual currency balances for the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.eu-west-1.aworld.cloud/app/v1/virtualBalances'

Response Example

{
    "items": [
        {
            "virtualCurrencyId": "string",
            "userId": "string",
            "amount": 0,
            "availableAmount": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ],
    "nextToken": "string"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

nextToken

string

optional

Pagination cursor for fetching the next set of results.

limit

integer

optional

Maximum number of virtual balances to return per page.

Default:

Responses

🟢200OK

application/json

List of Virtual Balances retrieved successfully

Body

items

array[object (VirtualBalance) {6}]

optional

A list of virtual currency balances.

virtualCurrencyId

string

required

The ID of the Virtual Currency to which this balance pertains.

userId

string

required

The ID of the User to whom this balance belongs.

amount

number

required

The total current amount of the virtual currency owned by the user.

availableAmount

number

required

The amount of virtual currency that the user can currently spend. This amount considers any pending debit operations.

createdAt

string <date-time>

required

Timestamp when this virtual balance record was created.

updatedAt

string <date-time>

required

Timestamp when this virtual balance record was last updated.

nextToken

string

optional

Pagination cursor for fetching the next set of results. Null if no more items are available.

🟠401Unauthorized

Modified at 2025-06-25 15:15:28

Get quiz translation

Get virtual balance