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 Pool accounts API

Use these operations to configure your RippleNet pool accounts.| Operation | Method | Description || -- | -- | -- || [Get all pool accounts](/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getallpoolaccounts) | GET | Returns a list of all pool accounts on a RippleNet node. || [Get pool account by pool account ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getpoolaccountbypoolaccountid) | GET | Get a pool account by its pool account ID. |

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

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

2 operations 2 paths 2 schemas 2 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 Pool accounts 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 2

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

Pool accounts 2

Use these operations to configure your RippleNet pool accounts. | Operation | Method | Description | | -- | -- | -- | | [Get all pool accounts](/products/payments-odl/api-docs/rip…

GET
/config/pool_accounts
Get all pool accounts
getAllPoolAccounts → 200400
GET
/config/pool_accounts/{pool_account_id}
Get pool account by pool account ID
getPoolAccountByPoolAccountId 1 param → 200400

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PoolAccountResponse (6 properties), RippleNetProblem (6 properties). Each schema is shown below with its type and property counts.

RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
PoolAccountResponse
object
Pool Account object returned to the user.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-pool-accounts-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 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