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.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Liquidations 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 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Use these operations to retrieve liquidations from the Smart Liquidation service. | Operation | Method | Description | | -- | -- | -- | | [Get liquidations](operation/getLiquidati…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.