Skip to main content
GET
Get Profile Balance
OAuth Scope

Authorizations

Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Scopes

funding:read_profile

Retrieve Profile details and deposit funds in Sandbox

Path Parameters

profile_id
string
required
asset
string
required

Query Parameters

balance_types
string[]

Optional. Balance types to return in balances. Case-insensitive. Duplicates are collapsed to their first occurrence. Accepts the four balance types AVAILABLE, TRADING, PENDING_DEBIT and PENDING_CREDIT, and any new customer-visible balance type name from the registry. An unknown balance type returns an invalid-argument error.

Response

200 - application/json

A successful response.

A ProfileBalance represents the holdings of a particular asset within a profile.

asset
string
required

The asset held by the profile.

available
string<decimal>
required

The available asset balance for new debit requests.

trading
string<decimal>
required

The asset amount committed to pending orders.

balances
object[]

The balances of the types named in balance_types, in request order. Empty when balance_types is not set.