---
title: "Get rates"
method: GET
path: "/config/rates"
tags: ["Rates"]
---

# Get rates

`GET /config/rates`

Gets a list of configured exchange rates.

## Query parameters

- `page` integer
- `size` integer

## Response `200`

Successfully returned list of rates.

- Rates — Provides a `content` array of rate objects and a set of pagination information fields.
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` RateResponse[], required — Provides an array of rate objects.
    - `rate_id` string, uuid, required — Unique identifier of the exchange rate.
    - `expiration_offset` integer, required — <b>(DEPRECATED)</b> This property is deprecated. Refer to `expires_at` to determine rate expiration. <p>Amount of time in milliseconds that the rate is valid for after the rate's `created_date` value. For example, if the `expiration_offset` value is `100000` milliseconds, the rate expires `100000` milliseconds after this `created_date` value. If set to `0`, the rate does not expire.</p>
    - `order_type` 'buy' | 'sell', required — Order type for the exchange rate.
    - `rate_scale` integer, required — Number of decimal places to which the exchange rate is calculated. For example, if the `rate_scale` value is set to `9` and the `rate` value is set to `1.25`, the scaled value of the rate is `1.250000000`.
    - `rate` number, required — Exchange rate for the specified base and counter currency.
    - `base_currency` string, required — Base currency of the exchange rate.
    - `counter_currency` string, required — Counter currency of the exchange rate.
    - `source_currency` string, required — If `order_type` is set to `buy`, this is set to the base currency. If `order_type` is set to `sell`, this is set to the counter currency.
    - `destination_currency` string, required — If `order_type` is set to `buy`, this is set to the counter currency. If `order_type` is set to `sell`, this is set to the base currency.
    - `source_ledger` string, required — Source ledger associated with the exchange rate.
    - `destination_ledger` string, required — Destination ledger associated with the exchange rate.
    - `source_ledger_account` string, required — Account on the source ledger associated with rate.
    - `destination_ledger_account` string, required — Account on the destination ledger associated with rate.
    - `created_date` string, date-time, required — Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and `expiration_offset` value. For example, if the `expiration_offset` value is `100000` milliseconds, the rate expires `100000` milliseconds after this `created_date` value.
    - `expires_at` string, date-time — The time in which this rate expires in system local timezone
    - `lower_limit` number, required — For a slab-based exchange rate, indicates the lower limit of the slab.
    - `upper_limit` number, required — For a slab-based exchange rate, indicates the upper limit of the slab.
    - `payout_method` string — The payout method for the rate.
    - `value_type` 'MARGIN' | 'RATE', required — Indicates whether the rate is a live exchange rate (`MARGIN`) or an exchange rate manually configured by Ripple (`RATE`). If this value is `MARGIN`, then `margin_type` will show a value.
    - `margin_type` 'BPS', required — Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if `value_type` = `MARGIN`. If `value_type` is `RATE`, this field is `null`.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)
