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

Used to manage counterparties

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

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

6 operations 3 paths 20 schemas 1 DELETE2 GET2 POST1 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 Counterparties 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 6

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

Counterparties 6

Used to manage counterparties

GET
/v2/counterparties
List counterparties
CounterpartyService_ListCounterparties 52 params → 200400401403404default
POST
/v2/counterparties
Create counterparties
CounterpartyService_CreateCounterparty body → 200400401403404default
GET
/v2/counterparties/{id}
Get counterparties
CounterpartyService_GetCounterparty 1 param → 200400401403404default
DELETE
/v2/counterparties/{id}
Delete counterparties
CounterpartyService_DeleteCounterparty 1 param → 200400401403404default
PUT
/v2/counterparties/{id}
Update counterparties
CounterpartyService_UpdateCounterparty 1 param body → 200400401403404default
POST
/v2/counterparties:list
List counterparties
CounterpartyService_ListCounterparties2 body → 200400401403404default

Schemas 20

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

v2DApp
object
protobufAny
object
1 property
v2CounterpartyType
string
TimestampFilterTimestampRange
object
2 properties
v2TimestampFilter
object
9 properties
v2FilterResponse
object
3 properties 1 required
commonv2Address
object
6 properties 5 required
v2ListCounterpartiesRequest
object
5 properties
v2Counterparty
object
9 properties 8 required
v2ListCounterpartiesResponse
object
2 properties
v2DeleteCounterpartyResponse
object
counterpartyv2Organization
object
2 properties 1 required
v2StringFilter
object
8 properties
v2SortOrder
string
v2Individual
object
3 properties 2 required
v2CounterpartyFilter
object
6 properties
v2CreateCounterpartyRequest
object
3 properties 2 required
v2CounterpartyDetails
object
4 properties 1 required
v2FilterRequest
object
4 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-counterparties-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 Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
Ripple Labs Market Cap API