API Reference

Liminal Express APIs

Overview

Liminal Express APIs are RESTful APIs that allow you to perform operations on your hot MPC wallets, like retrieving address balances, consolidating wallet assets, updating transaction statuses, etc. These APIs are designed to offer secure and flexible integration with your infrastructure, enabling smooth and efficient digital asset management.

API references provide information about the endpoints, descriptions, use cases, request bodies, and both successful as well as error response bodies. The API references section contains the following catalogues with a list of related APIs:

  • Key management
  • Addresses
  • Wallets
  • Transactions
  • Travel Rule transactions
  • Health

Liminal also offers webhooks for real-time notifications on incoming and outgoing transactions from wallets. To learn more, see Transaction webhooks.

Authentication

Authentication in API requests ensures that only authorised users or systems have access to the Liminal Express APIs. You can generate your unique credentials to test the APIs in the development environment while onboarding your organisation in the Liminal development environment. To onboard your organisation, see Onboard your organisation in Liminal Vaults.

API tryouts

In an API reference page, you can test out the API by performing the following steps.

Prerequisites

  • Ensure that you have your credentials (client key and secret) to authenticate yourself while running an API.
  • Ensure that you have correct values to provide in the request body. For example, wallet ID.
  1. Go to the API REFERENCES section. Expand the API catalog to view all related APIs.
  1. Select the API reference page where you want to test the API.
  2. Enter values in the path parameters (if applicable).
  3. Enter values in the required fields in the request body. An example is shown in the following screenshot.
  1. Check the example box on the right-side panel and ensure that you have added all the required fields in the request body.
  1. Enter your client ID and key for authorisation.
  1. Select the Try It! button to run the API.