Base URLs

Ripple makes RESTful APIs available to integrate, manage and interact with Ripple products and services. To use these APIs, you need to use the correct base URL. A base URL is part of a well-formed REST URL.

To form the final API request, append the necessary version, path, resource, and parameters to the base URL.

All environments use unique base URLs

For more information on the correct base URL for the API environment you interact with, see Base URL by API environment.

Components of a base URL

A base URL includes the HTTPS protocol, the [domainPrefix], and the domain. A [domainPrefix] refers to a segment of the base URL that's variable depending on the API and environment.

This example uses the test environment using the Ripple Payments API:

URL formatExample URL
Copy
Copied!
https://{domainPrefix}.{domain}/{apiVersion}/{path}?{parameters}
Copy
Copied!
https://api.test.ripple.com/v2/identities

The following table describes each component of a complete API request:

Field
Example value
 Description
Protocol https Ripple uses the HTTPS protocol for all APIs.
Domain Prefix api.test Each base URL is prefixed by api followed by an optional API environment.

Example: This example uses the api.test environment.
Domain ripple.com The Ripple Payments API uses ripple.com as the domain.
API Version /v2 The latest Ripple Payments API version is /v2.
Path /identities The path is appended to the base URL to reach the endpoint for the API operation.

This example targets the /v2/identities endpoint.

Base URL for Ripple Payments API

The Ripple Payments API includes a domain prefix that consists of api.{environment}.

Note

The production environment does not have an environment variable.

You can use Ripple Payments APIs in the following environments:

  • Test : Simulated partners and simulated currency.
  • Production : Production environment with actual partners and currency.

Base URL by API environment

Tokens are unique per environment

In addition to unique base URLs, access tokens are also unique per environment. Be sure to request the access token for the desired environment.

Environment
Domain Prefix
 Domain Base URL
Test api.test. ripple.com https://api.test.ripple.com/v2
Production api. ripple.com https://api.ripple.com.com/v2

Note: The following examples use test environment.

URL Format Example Base URL Example fully-qualified URL 
Copy
Copied!
https://{domainPrefix}.{domain}/{path}?{parameters}

# This is the URL format.
Copy
Copied!
https://api.test.ripple.com/

# This is the base URL for the test environment.
Copy
Copied!
https://api.test.ripple.com/v2/identities

# This connects to the test environment and requests a list of identities.