How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Liquidations API

Use these operations to retrieve liquidations from the Smart Liquidation service.| Operation | Method | Description || -- | -- | -- || [Get liquidations](#operation/getLiquidations) | GET | List all liquidations by date range. || [Get liquidation by Liquidation Id](#operation/getLiquidationById) | GET | Gets a liquidation by `Id`. || [Get liquidation by RippleNet Payment Id](#operation/getLiquidationsByRipplenetPaymentId) | GET | Gets a liquidation by `ripplenet_payment_id`. |**Note:** To configure liquidation, contact your RippleNet liaison.### Authentication with Smart Liquidation ServiceAll API operations require a bearer access token for your target environment.Learn how to [request the access token](/products/payments-odl/api-docs/ripplenet/best-practices/authentication/#request-the-access-token).### Domain prefixes with Smart Liquidation Service| **Environment** | **Domain Prefix** | **Request URL** || --- | --- | --- || **Test** | `liquidation-test.pub.prod` | `https://liquidation-test.pub.prod.ripplenet.com` || **Production** | `liquidation.pub.prod` | `https://liquidation.pub.prod.ripplenet.com` |

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

This API exposes 3 operations across 3 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://liquidation-test.pub.prod.ripplenet.com, https://liquidation.pub.prod.ripplenet.com.

3 operations 3 paths 18 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 3

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

Liquidations 3

Use these operations to retrieve liquidations from the Smart Liquidation service. | Operation | Method | Description | | -- | -- | -- | | [Get liquidations](operation/getLiquidati…

GET
/liquidations
Get liquidations
getLiquidations 7 params → 200400401403
GET
/liquidations/{id}
Get liquidation by Id
getLiquidationById 1 param → 200400401403404
GET
/liquidations/ripplenet-payment-id/{ripplenet_payment_id}
Get liquidations by payment Id
getLiquidationsByRipplenetPaymentId 1 param → 200400401403

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are LiquidationRequest (10 properties), ExecutionSummary (8 properties), Page (8 properties), ErrorResponse (7 properties). Each schema is shown below with its type and property counts.

ErrorCodeEnum
string
Type of problem.
LiquidationSourceEnum
string
Sort
object
4 properties
LiquidationRequest
object
10 properties 5 required
ErrorResponse
object
7 properties 2 required
EstimateTypeEnum
string
LiquidationTrade
Entity
object
4 properties 4 required
LiquidationTradeStatusEnum
string
TradingSummary
object
The trading summary
4 properties
TradeExecution
LiquidationListResponse
LiquidationStatusEnum
string
LiquidationSummary
Page
object
Paginated response base object
8 properties 8 required
ExecutionSummary
object
The trade execution summary
8 properties 6 required
Liquidation
ExecutionStrategy
object
The trade execution strategy
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-liquidations-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 Market Cap API
Where this information came from

This is an independent, third-party profile of Ripple Labs Liquidations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.