# Ripple Mint API

API operations for programmatic integration with Ripple Mint.
Covers transaction queries for issuance, redemption, and bridge activity,
as well as public market cap endpoints for RLUSD supply data.


Version: 1.0.0

## Servers

```
https://api.ripple.com
```

## Security

### oauth2

Type: oauth2

## Download OpenAPI description

[Ripple Mint API](https://docs.ripple.com/_bundle/products/stablecoin/api/reference/rlusd-openapi.yaml)

## Authentication

Use this API operation to manage your authentication tokens.

| Operation | Method | Description |
| --------- | ------ | ----------- |
| [Obtain an access token](#operation/getAccessToken) | POST | Request an access token for authentication with the API. |


### Obtain an access token

 - [POST /v2/oauth/token](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/authentication/getaccesstoken.md): OAuth 2.0 Client Credentials grant. Returns a Bearer token valid for 1 hour.
Credentials may be passed in the request body or via HTTP Basic Auth header.

## Transactions

Use these API operations to obtain details about transactions.

| Operation | Method | Description |
| --------- | ------ | ----------- |
| [List transactions](#operation/listTransactions) | GET | Get a paginated list of transactions, optionally filtered by type and status. |
| [Get a transaction](#operation/getTransaction) | GET | Get a specific transaction by ID. |


### List transactions

 - [GET /v1/stablecoin/transactions](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/transactions/listtransactions.md): Returns a paginated list of transactions, optionally filtered by type and status.

### Get a transaction

 - [GET /v1/stablecoin/transactions/{id}](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/transactions/gettransaction.md): Returns a single transaction by ID.

## Market Cap

Use these API operations to obtain details about market-capitalization supply for a stablecoin currency.

| Operation | Method | Description |
| --------- | ------ | ----------- |
| [Get total supply](#operation/getMarketCapTotal) | GET | Get the total amount of currency supply, with a per-chain breakdown. |
| [Get total supply amount](#operation/getMarketCapTotalAmount) | GET | Get the total supply as a plain decimal string. |
| [Get circulating supply](#operation/getMarketCapCirculating) | GET | Get the circulating amount of currency supply, with a per-chain breakdown. |
| [Get circulating supply amount](#operation/getMarketCapCirculatingAmount) | GET | Get the circulating supply as a plain decimal string. |

**Note:** These Market Cap operations do not require authentication.


### Get total supply

 - [GET /v1/stablecoin/market-cap/{currencyCode}/total](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcaptotal.md): Returns the total RLUSD supply (all issued tokens, regardless of circulating status)
with a per-chain breakdown. No authentication required.

### Get total supply amount

 - [GET /v1/stablecoin/market-cap/{currencyCode}/total/amount](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcaptotalamount.md): Returns the total RLUSD supply as a plain decimal string (e.g. "1000000000.00").
Useful for lightweight integrations that only need the aggregate figure.
No authentication required.

### Get circulating supply

 - [GET /v1/stablecoin/market-cap/{currencyCode}/circulating](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcapcirculating.md): Returns the circulating RLUSD supply with a per-chain breakdown.
Returns 404 if the circulating supply API is not enabled.
No authentication required.

### Get circulating supply amount

 - [GET /v1/stablecoin/market-cap/{currencyCode}/circulating/amount](https://docs.ripple.com/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcapcirculatingamount.md): Returns the circulating RLUSD supply as a plain decimal string.
Returns 404 if the circulating supply API is not enabled.
No authentication required.