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

Use these operations to manage your rates.| Operation | Method | Description || -- | -- | -- || [Get rates](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getrates) | GET | Gets a list of configured exchange rates. || [Create rate](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/createrate) | POST | Creates an exchange rate for a specified currency pair. || [Get rate by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getratebyid) | GET | Gets a configured exchange rate by ID. || [Update rate](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/updaterate) | PUT | Updates an existing exchange rate. || [Delete rate](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/deleterate) | DELETE | Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed. |

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

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

5 operations 2 paths 8 schemas 1 DELETE2 GET1 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 Rates 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 5

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

Rates 5

Use these operations to manage your rates. | Operation | Method | Description | | -- | -- | -- | | [Get rates](/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/ge…

GET
/config/rates
Get rates
getRates 2 params → 200400
POST
/config/rates
Create rate
createRate body → 200400
GET
/config/rates/{rate_id}
Get rate by ID
getRateById 1 param → 200404
PUT
/config/rates/{rate_id}
Update rate
updateRate 1 param body → 200400
DELETE
/config/rates/{rate_id}
Delete rate
deleteRate 1 param → 200400

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are RateResponse (20 properties), RateRequest (12 properties), Page (8 properties), Sort (6 properties). Each schema is shown below with its type and property counts.

Sort
object
6 properties
RateRequest
object
Use this JSON request body to create an exchange rate for a base and counter currency.
12 properties 5 required
RateResponse
object
JSON response object that represents an exchange rate.
20 properties 18 required
RatePerLedgerRequest
object
Use the ledger request object to create an exchange rate that applies to exchanges between a specific source ledger and destination ledger.
2 properties 2 required
RatePerAccountRequest
object
Use the account request object to create an exchange rate that applies to exchanges between a specific source ledger account and destination ledger account.
4 properties 4 required
Page
object
Paginated response base object.
8 properties
Rates
object
Provides a content array of rate objects and a set of pagination information fields.
1 required
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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