Skip to main content
POST
Get Balance

Overview

Allows the client to retrieve information about the current state of its wallet.

Authentication

Requires a valid JWT bearer token.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Referer
string<uri>
required

Your application's HTTPS URL, for example https://app.example.com/. Include this header on every Agent API request, including backend calls, login, and account creation. Browser clients must use a referrer policy that sends the application origin. See /neuron-api/api-basics#required-referer-header.

Body

application/json

The body is of type object.

Response

200 - application/json

Success

amount
number<double>
required
reserved
number<double>
required
currency
string
required
timestamp
string<date-time>
required