Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Balances API

Used to view balances

Ripple Labs Balances API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.

4 operations 4 paths 13 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Balances API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Balances 4

Used to view balances

GET
/v2/balances
Get Organization Balances
BalanceService_GetOrgBalances 1 param → 200400401403404default
GET
/v2/vaults/{vaultId}/balances
Get Vault Balances
BalanceService_GetVaultBalances 2 params → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/balances
Get Wallet Balances
BalanceService_GetWalletBalances 7 params → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/balances/sync
Sync Wallet Balances
BalanceService_SyncWalletBalances 2 params → 200400401403404default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are commonv2Asset (19 properties), v2Balance (7 properties), v2GetVaultBalancesResponse (3 properties), v2GetOrgBalancesResponse (3 properties). Each schema is shown below with its type and property counts.

v2AssetSource
string
protobufAny
object
1 property
v2SyncWalletBalancesResponse
object
v2GetWalletBalancesResponse
object
3 properties 1 required
v2GetVaultBalancesResponse
object
3 properties 1 required
v2Standard
string
v2Blockchain
string
v2GetOrgBalancesResponse
object
3 properties 1 required
v2WalletBalance
object
2 properties
v2Balance
object
7 properties
commonv2Asset
object
19 properties 5 required
rpcStatus
object
3 properties
v2VaultBalance
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-balances-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
Ripple Labs Market Cap API