Skip to main content
The Try It feature lets you interact with our APIs directly from the documentation. It gives you an embedded playground where you can test real requests and responses in a safe and controlled environment. Every request sent through Try It runs against our sandbox. If you want to understand how the sandbox works under the hood, check the page Using our Sandbox.

​
What you can do

With Try It, you can:
  • Send live requests to our sandbox environment
  • Inspect full HTTP request and response details
  • Adjust headers, parameters, and body payloads
  • Test different authentication tokens or organization IDs
  • Explore error handling and validation scenarios with mock data

​
Before you start

You will need the required headers for each API. Examples include Authorization, X-Lerian-Id, or X-Organization-Id. Each endpoint specifies exactly which headers you must use.
The sandbox resets automatically every day.Any entity you create, such as Organizations, Ledgers, or Portfolios, will be deleted within 24 hours.When testing dependent endpoints, create the required entities again before sending new requests.For example, you must create an Organization before creating a Ledger. Use the returned organization_id in the path.

​
How to use it

The Try It feature is available only in the latest version of our documentation.If the Try It button is missing, switch to the newest version using the selector at the top of the page.
1
Open any endpoint in the API Reference.
2
Click the Try It button next to the endpoint path.
3
Fill in the input fields such as query parameters, body content, or headers.
4
Click Send Request to run the call.
5
Review the response body, status code, and headers shown below the request.
You can copy your request as curl or fetch using the code tabs. It is a simple way to move from testing in the docs to running calls in your local environment.