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 Wallets API

Used to manage wallets

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

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

11 operations 8 paths 22 schemas 1 DELETE5 GET3 POST2 PUT

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 Wallets 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 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Wallets 11

Used to manage wallets

GET
/v2/vaults/{vaultId}/wallets
List vault wallets
VaultService_ListVaultWallets 90 params → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets
Create a wallet
VaultService_CreateWallet 1 param body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}
Get a wallet
VaultService_GetWallet 2 params → 200400401403404default
DELETE
/v2/vaults/{vaultId}/wallets/{walletId}
Delete a wallet
VaultService_DeleteWallet 2 params → 200400401403404default
PUT
/v2/vaults/{vaultId}/wallets/{walletId}
Update a wallet
VaultService_UpdateWallet 2 params body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/sequence
Get a wallet nonce/sequence
VaultService_GetWalletSequence 2 params → 200400401403404default
PUT
/v2/vaults/{vaultId}/wallets/{walletId}/settings
Update a wallet's settings
VaultService_UpdateWalletSettings 2 params body → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets:list
List vault wallets
VaultService_ListVaultWallets2 1 param body → 200400401403404default
GET
/v2/wallets
List organization wallets
VaultService_ListGlobalWallets 91 params → 200400401403404default
GET
/v2/wallets/{id}
Get a wallet by ID
VaultService_GetWalletByID 1 param → 200400401403404default
POST
/v2/wallets:list
List organization wallets
VaultService_ListGlobalWallets2 body → 200400401403404default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are vaultv2Wallet (20 properties), v2WalletFilter (11 properties), v2TimestampFilter (9 properties), v2StringFilter (8 properties). Each schema is shown below with its type and property counts.

vaultv2Wallet
object
20 properties 10 required
v2WalletType
string
v2KeyAlgorithm
string
v2Keystore
string
protobufAny
object
1 property
v2ListGlobalWalletsResponse
object
2 properties
TimestampFilterTimestampRange
object
2 properties
v2TimestampFilter
object
9 properties
v2DeleteWalletResponse
object
v2FilterResponse
object
3 properties 1 required
vaultv2WalletStatus
string
v2ListGlobalWalletsRequest
object
8 properties
v2Blockchain
string
v2ListVaultWalletsResponse
object
2 properties
v2GetWalletSequenceResponse
object
1 property
v2WalletSettings
object
4 properties 4 required
v2StringFilter
object
8 properties
v2BlockchainFilter
object
4 properties
v2SortOrder
string
v2FilterRequest
object
4 properties
v2WalletFilter
object
11 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-wallets-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