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 and statements API

Use these operations to view balances and statements for a ledger.| Operation | Method | Description || -- | -- | -- || [Get balances](/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getbalances) | GET | Get balances for local and remote accounts owned by a RippleNet address. || [Get ledger balances](/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgerbalances) | GET | Get balances for ledger owned by a RippleNet address. || [Get statement](/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatement) | GET | Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range. || [Get statement by external account ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatementbyexternalaccountid) | GET | Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range. || [Get ledger account statement](/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgeraccountstatement) | GET | Get statement for a specified Ledger Account |

Ripple Labs Balances and statements 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 and statements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths, and defines 9 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.

5 operations 5 paths 9 schemas 5 GET

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 and statements 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 5

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

Balances and statements 5

Use these operations to view balances and statements for a ledger. | Operation | Method | Description | | -- | -- | -- | | [Get balances](/products/payments-odl/api-docs/ripplenet…

GET
/monitor/balances
Get balances
getBalances → 200400
GET
/monitor/ledger/balances
Get ledger balances
getLedgerBalances → 200400
GET
/statement/{account_name_with_address}
Get statement
getStatement 5 params → 200400404
GET
/statement/external_account_id/{external_account_id}
Get statement by external account ID
getStatementByExternalAccountId 5 params → 200400404
GET
/statement/ledger/{account_name_with_address}deprecated
Get ledger account statement
getLedgerAccountStatement 5 params → 200400404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are StatementRecord (15 properties), AccountBalance (9 properties), Transactions (9 properties), StatementResponse (9 properties). Each schema is shown below with its type and property counts.

AccountBalance
object
Provides balance details for each account owned by a RippleNet address.
9 properties
Transactions
object
Provides a content array of statement record objects and a set of pagination information fields.
9 properties 9 required
Balances
object
Provides balances for all accounts owned by a RippleNet address.
3 properties 3 required
InstitutionBalance
object
Provides balance details for accounts owned by a RippleNet address.
4 properties 3 required
StatementResponse
object
Provides a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
9 properties 9 required
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
PoolAccountBalance
object
5 properties
StatementRecord
object
Provides details about a transaction included in an account statement.
15 properties 12 required
CurrencyBalance
object
Provides balance details for accounts owned by a RippleNet address.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-balances-and-statements-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 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