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 Transactions - Sweep API

The Transactions - Sweep API from Ripple Labs — 2 operation(s) for transactions - sweep.

Ripple Labs Transactions - Sweep 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 Transactions - Sweep. 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 26 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 26 schemas 1 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 Transactions - Sweep 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 — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Transactions - Sweep 2
GET
/v2/transactions/sweep/{sweepId}
List transactions for a sweep instance
TransactionsService_ListSweepInstanceTransactions 8 params → 200400401403404default
POST
/v2/transactions/sweep/{sweepId}:list
List transactions for a sweep instance
TransactionsService_ListSweepInstanceTransactions2 1 param body → 200400401403404default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are transactionsv2Transaction (37 properties), commonv2Asset (19 properties), v2FreezeHistoryEntry (8 properties), v2Problem (6 properties). Each schema is shown below with its type and property counts.

transactionsv2Transaction
object
37 properties 16 required
commonv2Asset
object
19 properties 5 required
transactionsv2Address
object
5 properties 2 required
v2XRPTransactionConfig
object
2 properties
v2Standard
string
transactionsv2AddressType
string
protobufAny
object
1 property
v2ListSweepInstanceTransactionsResponse
object
2 properties
v2FreezeType
string
v2FreezeHistoryEntry
object
8 properties
v2FreezeInfo
object
2 properties
v2SigningPayload
object
4 properties 2 required
v2AssetSource
string
v2AssetChangePurpose
string
v2FilterResponse
object
3 properties 1 required
v2Blockchain
string
v2Problem
object
6 properties
v2Retryability
string
v2AssetChange
object
5 properties 3 required
v2FreezeAction
string
transactionsv2TransactionAction
string
v2SortOrder
string
v2AssetChangeWallet
object
4 properties 1 required
v2FilterRequest
object
4 properties
transactionsv2TransactionStatus
string
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-transactions-sweep-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